Skip to content

Commit 991f981

Browse files
authored
Added a tip for blueprints (#102)
* chore: Fixed formatting issues * chore: Updated documentations --------- Co-authored-by: ijlee2 <ijlee2@users.noreply.github.com>
1 parent 27ba75e commit 991f981

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Here are some guidelines to help you and everyone else.
88
## Local development
99

1010
<details>
11+
1112
<summary>Install dependencies</summary>
1213

1314
1. Fork and clone this repo.
@@ -32,6 +33,7 @@ Here are some guidelines to help you and everyone else.
3233

3334

3435
<details>
36+
3537
<summary>Lint files</summary>
3638

3739
1. When you write code, please check that it meets the linting rules.
@@ -52,6 +54,7 @@ Here are some guidelines to help you and everyone else.
5254

5355

5456
<details>
57+
5558
<summary>Run tests</summary>
5659

5760
1. When you write code, please check that all tests continue to pass.
@@ -124,6 +127,7 @@ Here are some suggestions to help you start:
124127
125128
126129
<details>
130+
127131
<summary>Give feedback 💞</summary>
128132
129133
1. An open source project's value comes from people using the code and extending it to make greater things. Let me know how you use `@codemod-utils` in your codemod!
@@ -137,6 +141,7 @@ Here are some suggestions to help you start:
137141
138142
139143
<details>
144+
140145
<summary>Help with marketing 📢</summary>
141146
142147
1. Platforms include:
@@ -151,6 +156,7 @@ Here are some suggestions to help you start:
151156
152157
153158
<details>
159+
154160
<summary>Join this project 👩‍💻👨‍💻</summary>
155161
156162
1. Help me maintain the project! I have limited time and there is much that I don't know.
@@ -164,6 +170,7 @@ Here are some suggestions to help you start:
164170

165171

166172
<details>
173+
167174
<summary>Make issues 📝</summary>
168175

169176
1. In addition to sharing feedback (described in `Give feedback`), you can create an issue to:

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ npx @codemod-utils/cli --name <your-codemod-name>
2929
## Tutorials
3030

3131
- [Main tutorial](./tutorials/ember-codemod-rename-test-modules/00-introduction.md)
32-
- [Tutorial for blueprints](./tutorials/blueprint-for-v2-addon/00-introduction.md)
33-
- [Tutorial for `<template>`-tag components](./tutorials/template-tag-components/00-introduction.md)
32+
- [Blueprints](./tutorials/blueprint-for-v2-addon/00-introduction.md)
33+
- [`<template>`-tag components](./tutorials/template-tag-components/00-introduction.md)
3434

3535

3636
## Codemods written with @codemod-utils

tutorials/blueprint-for-v2-addon/04-create-dynamic-files.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ workspace-root
270270
> [!IMPORTANT]
271271
> To create `.gitignore` and `.npmignore` via blueprints, the blueprint files must be named differently, e.g. `__gitignore__` and `__npmignore__`. Otherwise, these files will be missing in `src/blueprints` when the codemod is published.
272272
>
273-
> Afterwards, you can update `resolveBlueprintFilePath()` to handle `.gitignore` and `.npmignore`.
273+
> You might already see how to update `resolveBlueprintFilePath()` to handle `.gitignore` and `.npmignore`.
274274
>
275275
> ```diff
276276
> function resolveBlueprintFilePath(
@@ -286,6 +286,16 @@ workspace-root
286286
> .replace('__testAppLocation__', testApp.location);
287287
> }
288288
> ```
289+
>
290+
> To double-check, run `pnpm publish --dry-run` and review the files.
291+
>
292+
> ```sh
293+
> npm notice 911B dist/bin/blueprint-for-v2-addon.js
294+
> npm notice 145B dist/src/blueprints/__addonLocation__/__gitignore__
295+
> npm notice 109B dist/src/blueprints/__addonLocation__/.eslintignore
296+
> npm notice 340B dist/src/blueprints/__addonLocation__/.eslintrc.js
297+
> ...
298+
> ```
289299
290300
291301
<div align="center">

0 commit comments

Comments
 (0)