diff options
| author | 2023-04-28 01:36:44 +0800 | |
|---|---|---|
| committer | 2023-04-28 01:36:44 +0800 | |
| commit | dd84b9d64fb98746a230cd24233ff50a562c39c9 (patch) | |
| tree | b583261ef00b3afe72ec4d6dacb31e57779a6faf /packages/turbo-codemod/templates | |
| parent | 0b46fcd72ac34382387b2bcf9095233efbcc52f4 (diff) | |
| download | HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.tar.gz HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.zip | |
Diffstat (limited to 'packages/turbo-codemod/templates')
| -rw-r--r-- | packages/turbo-codemod/templates/transformer.hbs | 45 | ||||
| -rw-r--r-- | packages/turbo-codemod/templates/transformer.test.hbs | 25 |
2 files changed, 70 insertions, 0 deletions
diff --git a/packages/turbo-codemod/templates/transformer.hbs b/packages/turbo-codemod/templates/transformer.hbs new file mode 100644 index 0000000..593490a --- /dev/null +++ b/packages/turbo-codemod/templates/transformer.hbs @@ -0,0 +1,45 @@ +import { TransformerArgs } from "../types"; +import { TransformerResults } from "../runner"; +import getTransformerHelpers from "../utils/getTransformerHelpers"; + +// transformer details +const TRANSFORMER = "{{ name }}"; +const DESCRIPTION = "{{ description }}"; +const INTRODUCED_IN = "{{ introducedIn }}"; + +export function transformer({ + root, + options, +}: TransformerArgs): TransformerResults { + const { log, runner } = getTransformerHelpers({ + transformer: TRANSFORMER, + rootPath: root, + options, + }); + + log.info("Short description about {{ name }}") + + /* + Make changes to required files, and track each modified file with: + + runner.modifyFile({ + filePath: packageJsonPath, // absolute path to file + after: transformedFile, // file after modifications have been made + }); + + This automatically handles all cases of print / dry etc. + */ + + return runner.finish(); +} + +const transformerMeta = { + name: `${TRANSFORMER}: ${DESCRIPTION}`, + value: TRANSFORMER, + introducedIn: INTRODUCED_IN, + transformer, +}; + +export default transformerMeta; + + diff --git a/packages/turbo-codemod/templates/transformer.test.hbs b/packages/turbo-codemod/templates/transformer.test.hbs new file mode 100644 index 0000000..c63a9df --- /dev/null +++ b/packages/turbo-codemod/templates/transformer.test.hbs @@ -0,0 +1,25 @@ +import { transformer } from "../src/transforms/{{ name }}"; +import { setupTestFixtures } from "./test-utils"; + +describe("{{ name }}", () => { + + const { useFixture } = setupTestFixtures({ test: "{{ name }}" }); + + test("basic", () => { + // load the fixture for the test + const { root, read, readJson } = useFixture({ + fixture: "specific-fixture", + }); + + // run the transformer + const result = transformer({ + root, + options: { force: false, dry: false, print: false }, + }); + + // result should be correct + expect(result.fatalError).toBeUndefined(); + expect(result.changes).toMatchInlineSnapshot(); + }); +}); + |
