ember-codemod-template-tag

ember-codemod-template-tag

Codemod to convert Glimmer components to the <template> tag authoring format in .gjs and .gts.

NOTE This codemod is far from feature complete. Currently it only handles converting *-test.js files which use the hbs helper. PRs welcome!

Functionality

Features

• Rewrites the hbs template helper to the <template> tag
• Adds imports for components and removes hbs import
• Supports nested component paths (e.g. Cards::CardHeader will be used as CardHeader)
• Adds imports for built-in helpers (concat, array, fn, get, hash)
• Supports JavaScript and TypeScript

Example

Given a file foo-test.js:

npx ember-codemod-template-tag --app-name example-app

import { render } from '@ember/test-helpers';
import { hbs } from 'ember-cli-htmlbars';
import { module, test } from 'qunit';
import { setupRenderingTest } from 'example-app/tests/helpers/component-test';

module('Integration | Component | foo', function (hooks) {
  setupRenderingTest(hooks);

  test('bar', async function (assert) {
    await render(hbs`<Foo @x={{array 1 2 3}} />`);
  });
});

The codemod will rewrite this to:

import { array } from '@ember/helper';
import Foo from 'example-app/components/foo';
import { render } from '@ember/test-helpers';
import { module, test } from 'qunit';
import { setupRenderingTest } from 'example-app/tests/helpers/component-test';

module('Integration | Component | foo', function (hooks) {
  setupRenderingTest(hooks);

  test('bar', async function (assert) {
    await render(<template><Foo @x={{array 1 2 3}}/></template>);
  });
});

Usage

WARNING As with most codemods, changes are made in place, meaning it will overwrite existing files. Make sure to run this codemod on a codebase that has been checked into version control to avoid losing progress.

Arguments

You must pass the app name as an argument to the codemod. This value is used to provide import statements:

npx ember-codemod-template-tag --app-name <your-app-name>

Optional: Specify the project root

Pass --root to run the codemod somewhere else (i.e. not in the current directory).

npx ember-codemod-template-tag --root <path/to/your/project>

Limitations

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.

cd <path/to/cloned/repo>

# Compile TypeScript
pnpm build

# Run codemod
./dist/bin/ember-codemod-template-tag.js --root <path/to/your/project>

Compatibility

• Node.js v18 or above

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.

Changelog

0.1.1

Patch Changes

• 198321e Thanks @IgnaceMaes! - Fix dependencies