Codemod to add <template> tags
npm install ember-codemod-add-template-tags
_Codemod to add tags_
Introducing tag to large projects can be tedious and error-prone. Run this codemod to get started.
The codemod:
- Statically analyzes code (no need to build projects)
- Supports v1 apps (classic, Webpack), v2 apps (Vite)
- Supports v1 addons, v2 addons
- Supports monorepos (convert all packages at once)
- Light and fast
Step 1. Quickly migrate.1,2
``sh`
cd
pnpx ember-codemod-add-template-tags
Step 2. Review the package.
- [x] Fix format and lint errors.3
- [x] Run tests.
You can check Troubleshoot if you encounter an issue.
1. The codemod assumes that your apps and addons follow the Octane layout (flat or nested). If not, you can run codemods to move away from classic and pod.
2. To analyze external dependencies, the codemod reads your node_modules. Install your project's dependencies before running the codemod.
3. If you need lint configs that support *.{gjs,gts}, you can install packages from @ijlee2-frontend-configs.
By default, the codemod considers components, routes, and tests. Pass --convert to consider a subset of these.
`shComponents and tests only
pnpx ember-codemod-add-template-tags --convert components tests
Optional: Limit folders to consider
By default, the codemod considers all files and folders for components, routes, and tests. Pass
to limit the search to 1 folder. (You may use glob patterns to specify multiple folders.)`sh
ui folder only
pnpx ember-codemod-add-template-tags --folder uiui/form folder only
pnpx ember-codemod-add-template-tags --folder ui/formroute1 and route2 folders only
pnpx ember-codemod-add-template-tags --convert routes --folder "{route1,route2}"
`
Optional: Specify the component structure
By default, an Octane project has the flat component structure. Pass
to indicate otherwise.`sh
pnpx ember-codemod-add-template-tags --component-structure nested
`
Optional: Specify the project root
Pass
to run the codemod somewhere else (i.e. not in the current directory).`sh
pnpx ember-codemod-add-template-tags --root
`
$3
The codemod is designed to cover typical cases. It is not designed to cover one-off cases.
To better meet your needs, consider cloning the repo and running the codemod locally.
sh
cd Compile TypeScript
pnpm buildRun codemod
./dist/bin/ember-codemod-add-template-tags.js --root
``- Node.js v20 or above
See the Contributing guide for details.
This project is licensed under the MIT License.