Skip to content

Commit cbc4e22

Browse files
ijlee2ijlee2
authored
Downstreamed changes from @embroider/addon-blueprint#113. Added CONTRIBUTING.md. (#29)
* chore: Updated dependencies * chore: Added CONTRIBUTING.md * chore: Downstreamed changes from @embroider/addon-blueprint#113 * chore: Updated test fixtures * chore: Updated latestVersions * chore: Updated test fixtures --------- Co-authored-by: ijlee2 <[email protected]>
1 parent 4572613 commit cbc4e22

File tree

24 files changed

+296
-134
lines changed

24 files changed

+296
-134
lines changed

‎.eslintignore‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
# compiled output
22
/dist/
3+
/tmp/
34

45
# dependencies
56
/node_modules/
67

78
# misc
89
!.*
910
.*/
10-
.eslintcache
1111
/src/blueprints/
1212
/tests/fixtures/
13-
/tmp/

‎CONTRIBUTING.md‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
# Contributing to ember-codemod-v1-to-v2
2+
3+
Open source projects like `ember-codemod-v1-to-v2` live on your words of encouragement and contribution. Please give feedback, report issues, or submit pull requests!
4+
5+
Here are some guidelines to help you and everyone else.
6+
7+
8+
## Local development
9+
10+
<details>
11+
<summary>Install dependencies</summary>
12+
13+
1. Fork and clone this repo.
14+
15+
```sh
16+
git clone [email protected]:<your GitHub handle>/ember-codemod-v1-to-v2.git
17+
```
18+
19+
1. Change directory.
20+
21+
```sh
22+
cd ember-codemod-v1-to-v2
23+
```
24+
25+
1. Use `yarn` to install dependencies.
26+
27+
```sh
28+
yarn install
29+
```
30+
31+
</details>
32+
33+
34+
<details>
35+
<summary>Lint files</summary>
36+
37+
1. When you write code, please check that it meets the linting rules.
38+
39+
```sh
40+
yarn lint
41+
```
42+
43+
1. You can run `lint:fix` to automatically fix linting errors.
44+
45+
```sh
46+
yarn lint:fix
47+
```
48+
49+
</details>
50+
51+
52+
<details>
53+
<summary>Run tests</summary>
54+
55+
1. When you write code, please check that all tests continue to pass.
56+
57+
```sh
58+
yarn test
59+
```
60+
61+
</details>
62+
63+
64+
<details>
65+
66+
<summary>Publish packages (for admins)</summary>
67+
68+
1. Generate a [personal access token](https://github.com/settings/tokens/) in GitHub, with default values for scopes (none selected).
69+
70+
1. Create a pull request, in which you update the package version and `CHANGELOG`.
71+
72+
```sh
73+
GITHUB_AUTH=<YOUR_PERSONAL_ACCESS_TOKEN> yarn changelog
74+
```
75+
76+
1. Create a tag such as `1.0.0` (the name satisfies the regular expression `^\d+\.\d+\.\d+`).
77+
78+
</details>
79+
80+
81+
## How can I help?
82+
83+
If you haven't before, I encourage you to watch [Sean Massa's mini-talk](https://www.youtube.com/watch?v=CcSKlsc_AhQ) on what it means to be a contributor. To sum up the talk, you can be a contributor in many ways. I want you to discover a path that meets your goals well!
84+
85+
Here are some suggestions to help you start:
86+
87+
88+
<details>
89+
<summary>Give feedback 💞</summary>
90+
91+
1. An open source project's value comes from people using the code and extending it to make greater things. Let me know how the codemod worked on your Ember addon!
92+
93+
1. You can **create an issue** to:
94+
95+
- Share how you used `ember-codemod-v1-to-v2`
96+
- Share what you liked or didn't like about `ember-codemod-v1-to-v2`
97+
98+
</details>
99+
100+
101+
<details>
102+
<summary>Help with marketing 📢</summary>
103+
104+
1. Platforms include:
105+
106+
- Blog post
107+
- GitHub star
108+
- Meetup or conference talk
109+
- Social media
110+
- Word of mouth
111+
112+
</details>
113+
114+
115+
<details>
116+
<summary>Join this project 👩‍💻👨‍💻</summary>
117+
118+
1. Help me maintain the project! I have limited time and there is much that I don't know.
119+
120+
- Cut releases
121+
- Research new ways to implement v2 addons
122+
- Respond to issues
123+
- Review pull requests
124+
125+
</details>
126+
127+
128+
<details>
129+
<summary>Make issues 📝</summary>
130+
131+
1. In addition to sharing feedback (described in `Give feedback`), you can create an issue to:
132+
133+
- Ask for better documentation
134+
- Ask for new feature or refactor
135+
- Report bug
136+
- Report outdated dependency
137+
138+
1. When reporting a bug, please provide details to help me understand what's going on. If possible, please use the latest version of `ember-codemod-v1-to-v2` and set up a public demo that I and (other people) can check the code.
139+
140+
</details>
141+
142+
143+
💡 Have ideas for contribution? Reach out to `@ijlee2` on [Discord](https://discord.com/invite/emberjs)!

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,8 @@ You can also look at another codemod called [`ember-addon-migrator`](https://git
115115

116116
## Contributing
117117

118+
See the [Contributing](CONTRIBUTING.md) guide for details.
119+
118120
If you have an open-sourced addon (v1 or v2) that I can use as a reference, reach out to me on [Discord](https://discord.gg/emberjs) at `ijlee2`. Please star this project so that I can gauge its importance to you and the Ember community. ⭐
119121

120122

‎package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@
4747
"glob": "^10.2.2",
4848
"lodash.template": "^4.5.0",
4949
"strip-json-comments": "^5.0.0",
50-
"yargs": "^17.7.1"
50+
"yargs": "^17.7.2"
5151
},
5252
"devDependencies": {
53-
"@babel/core": "^7.21.4",
54-
"@babel/eslint-parser": "^7.21.3",
53+
"@babel/core": "^7.21.8",
54+
"@babel/eslint-parser": "^7.21.8",
5555
"@sondr3/minitest": "^0.1.1",
5656
"eslint": "^8.39.0",
5757
"eslint-config-prettier": "^8.8.0",

‎src/migration/ember-addon/steps/update-addon-package-json.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ function updateDevDependencies(packageJson, options) {
5050
'@babel/core',
5151
'@babel/plugin-proposal-class-properties',
5252
'@babel/plugin-proposal-decorators',
53+
'@babel/runtime',
5354
'@embroider/addon-dev',
5455
'@rollup/plugin-babel',
5556
'rollup',

‎src/utils/blueprints/decide-version.js‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
const latestVersions = new Map([
2-
['@babel/core', '7.21.4'],
2+
['@babel/core', '7.21.8'],
33
['@babel/plugin-proposal-class-properties', '7.18.6'],
44
['@babel/plugin-proposal-decorators', '7.21.0'],
5-
['@babel/preset-typescript', '7.21.4'],
5+
['@babel/preset-typescript', '7.21.5'],
6+
['@babel/runtime', '7.21.5'],
67
['@embroider/addon-dev', '3.0.0'],
78
['@embroider/addon-shim', '1.8.4'],
89
['@rollup/plugin-babel', '6.0.3'],
910
['concurrently', '8.0.1'],
1011
['ember-auto-import', '2.6.3'],
1112
['ember-cli-babel', '7.26.11'],
1213
['ember-cli-htmlbars', '6.2.0'],
13-
['rollup', '3.21.0'],
14+
['rollup', '3.21.3'],
1415
['rollup-plugin-copy', '3.4.0'],
1516
['rollup-plugin-ts', '3.2.0'],
1617
]);

‎tests/fixtures/ember-container-query-customizations/output/packages/ember-container-query/package.json‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,13 @@
6363
"ember-test-selectors": "^6.0.0"
6464
},
6565
"devDependencies": {
66-
"@babel/core": "^7.21.4",
66+
"@babel/core": "^7.21.8",
6767
"@babel/plugin-proposal-class-properties": "^7.18.6",
6868
"@babel/plugin-proposal-decorators": "^7.21.0",
69-
"@babel/preset-typescript": "^7.21.4",
69+
"@babel/preset-typescript": "^7.21.5",
70+
"@babel/runtime": "^7.21.5",
7071
"@embroider/addon-dev": "^3.0.0",
71-
"rollup": "^3.21.0",
72+
"rollup": "^3.21.3",
7273
"rollup-plugin-copy": "^3.4.0",
7374
"rollup-plugin-ts": "^3.2.0"
7475
},

‎tests/fixtures/ember-container-query-glint/output/ember-container-query/package.json‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,13 @@
6363
"ember-test-selectors": "^6.0.0"
6464
},
6565
"devDependencies": {
66-
"@babel/core": "^7.21.4",
66+
"@babel/core": "^7.21.8",
6767
"@babel/plugin-proposal-class-properties": "^7.18.6",
6868
"@babel/plugin-proposal-decorators": "^7.21.0",
69-
"@babel/preset-typescript": "^7.21.4",
69+
"@babel/preset-typescript": "^7.21.5",
70+
"@babel/runtime": "^7.21.5",
7071
"@embroider/addon-dev": "^3.0.0",
71-
"rollup": "^3.21.0",
72+
"rollup": "^3.21.3",
7273
"rollup-plugin-copy": "^3.4.0",
7374
"rollup-plugin-ts": "^3.2.0"
7475
},

‎tests/fixtures/ember-container-query-javascript/output/ember-container-query/package.json‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,13 @@
6060
"ember-test-selectors": "^6.0.0"
6161
},
6262
"devDependencies": {
63-
"@babel/core": "^7.21.4",
63+
"@babel/core": "^7.21.8",
6464
"@babel/plugin-proposal-class-properties": "^7.18.6",
6565
"@babel/plugin-proposal-decorators": "^7.20.7",
66+
"@babel/runtime": "^7.21.5",
6667
"@embroider/addon-dev": "^3.0.0",
6768
"@rollup/plugin-babel": "^6.0.3",
68-
"rollup": "^3.21.0",
69+
"rollup": "^3.21.3",
6970
"rollup-plugin-copy": "^3.4.0"
7071
},
7172
"engines": {

‎tests/fixtures/ember-container-query-scoped/output/ember-container-query/package.json‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,13 @@
6363
"ember-test-selectors": "^6.0.0"
6464
},
6565
"devDependencies": {
66-
"@babel/core": "^7.21.4",
66+
"@babel/core": "^7.21.8",
6767
"@babel/plugin-proposal-class-properties": "^7.18.6",
6868
"@babel/plugin-proposal-decorators": "^7.21.0",
69-
"@babel/preset-typescript": "^7.21.4",
69+
"@babel/preset-typescript": "^7.21.5",
70+
"@babel/runtime": "^7.21.5",
7071
"@embroider/addon-dev": "^3.0.0",
71-
"rollup": "^3.21.0",
72+
"rollup": "^3.21.3",
7273
"rollup-plugin-copy": "^3.4.0",
7374
"rollup-plugin-ts": "^3.2.0"
7475
},

0 commit comments

Comments
 (0)