Skip to content

Commit

Permalink
docs: clean up readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ignace committed Oct 30, 2023
1 parent 6a97bda commit 1df2993
Showing 1 changed file with 4 additions and 22 deletions.
26 changes: 4 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ module('Integration | Component | foo', function (hooks) {
setupRenderingTest(hooks);

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

The codemod will rewrite this to:
The codemod will rewrite this to `foo-test.gts`:

```js
import { array } from '@ember/helper';
import Foo from 'example-app/components/foo';
import Bar from 'example-app/components/foo/bar';
import { render } from '@ember/test-helpers';
import { module, test } from 'qunit';
import { setupRenderingTest } from 'example-app/tests/helpers/component-test';
Expand All @@ -53,7 +53,7 @@ module('Integration | Component | foo', function (hooks) {
setupRenderingTest(hooks);

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

Expand Down Expand Up @@ -85,24 +85,6 @@ npx ember-codemod-template-tag --root <path/to/your/project>

</details>


### 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.

```sh
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
Expand Down

0 comments on commit 1df2993

Please sign in to comment.