ember-codemod-add-component-signatures 4.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Isaac J. Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,141 @@
+[![This project uses GitHub Actions for continuous integration.](https://github.com/ijlee2/ember-codemod-add-component-signatures/actions/workflows/ci.yml/badge.svg)](https://github.com/ijlee2/ember-codemod-add-component-signatures/actions/workflows/ci.yml)
+
+# ember-codemod-add-component-signatures
+
+_Codemod to add component signatures_
+
+
+## What is it?
+
+To introduce Glint, you will need to write the [signature](https://typed-ember.gitbook.io/glint/environments/ember/component-signatures) and [template registry](https://typed-ember.gitbook.io/glint/environments/ember/template-registry) for each component. This can be an error-prone, onerous task for large projects.
+
+You can run this codemod to get started.
+
+
+## Features
+
+- Scaffolds signature for components
+- Adds template registry for components
+- Supports `<template>` tag components
+
+<div align="center">
+  <figure>
+    <img alt="A code diff to show what template-only components can look like before and after running ember-codemod-add-component-signatures" src="https://github.com/ijlee2/ember-codemod-add-component-signatures/assets/16869656/55115b27-682e-4f5a-9a03-36d7aa1cc0c2" width="640">
+    <br>
+    <figcaption>Template-only components</figcaption>
+  </figure>
+  <br><br>
+  <figure>
+    <img alt="A code diff to show what Glimmer components can look like before and after running ember-codemod-add-component-signatures" src="https://github.com/ijlee2/ember-codemod-add-component-signatures/assets/16869656/4feb1fcd-5a31-419e-9feb-2af99073ae75" width="640">
+    <img alt="Another code diff for a Glimmer component" src="https://github.com/ijlee2/ember-codemod-add-component-signatures/assets/16869656/c8c1c9b0-28a1-4957-9c49-5cc853499a4f" width="640">
+    <br>
+    <figcaption>Glimmer components</figcaption>
+  </figure>
+</div>
+
+
+## Usage
+
+Step 1. Quickly migrate.
+
+```sh
+cd <path/to/your/project>
+npx ember-codemod-add-component-signatures <arguments>
+```
+
+Step 2. Review the package.
+
+- [x] Fill in missing type information.
+- [x] Confirm that you can run all scripts in `package.json`.
+
+For more information, please check the [FAQ](#frequently-asked-questions).
+
+
+### Prerequisites
+
+Must:
+
+- Migrate to the Octane layout (flat or nested). You can leverage the codemods for [classic](https://github.com/ember-codemods/ember-component-template-colocation-migrator) and [pod](https://github.com/ijlee2/ember-codemod-pod-to-octane) layouts.
+
+Nice to do:
+
+- Refactor code (e.g. Glimmerize components, meet the linting rule `no-implicit-this`) to help the codemod parse code.
+
+
+### Arguments
+
+You must pass `--type` to indicate what type of project you have.
+
+```sh
+npx ember-codemod-add-component-signatures --type app
+npx ember-codemod-add-component-signatures --type v1-addon
+npx ember-codemod-add-component-signatures --type v2-addon
+```
+
+<details>
+
+<summary>Optional: Specify the component structure</summary>
+
+By default, an Octane project has the flat component structure. Pass `--component-structure` to indicate otherwise.
+
+```sh
+npx ember-codemod-add-component-signatures --component-structure nested
+```
+
+</details>
+
+<details>
+
+<summary>Optional: Convert <code>*.{js,gjs}</code> files</summary>
+
+By default, the codemod ignores component classes written in `*.{js,gjs}`. Pass `--convert-javascript` to allow the codemod to change the file extension to `*.{ts,gts}` and add the component signature.
+
+```sh
+npx ember-codemod-add-component-signatures --convert-javascript
+```
+
+</details>
+
+<details>
+
+<summary>Optional: Specify the project root</summary>
+
+Pass `--root` to run the codemod on a project somewhere else (i.e. not in the current directory).
+
+```sh
+npx ember-codemod-add-component-signatures --root <path/to/your/project>
+```
+
+</details>
+
+
+### Limitations
+
+The codemod is designed to cover typical cases. It is not designed to cover one-off cases. (Classic components are not supported.)
+
+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-add-component-signatures.js --root <path/to/your/project>
+```
+
+
+## Compatibility
+
+- Node.js v20 or above
+
+
+## Contributing
+
+See the [Contributing](CONTRIBUTING.md) guide for details.
+
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.md).

package/dist/bin/ember-codemod-add-component-signatures.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+'use strict';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { runCodemod } from '../src/index.js';
+// Provide a title to the process in `ps`
+process.title = 'ember-codemod-add-component-signatures';
+// Set codemod options
+const argv = yargs(hideBin(process.argv))
+    .option('component-structure', {
+    choices: ['flat', 'nested'],
+    default: 'flat',
+    describe: 'Component structure (how your components are colocated)',
+    type: 'string',
+})
+    .option('convert-javascript', {
+    default: false,
+    describe: 'Convert *.{js,gjs} files?',
+    type: 'boolean',
+})
+    .option('root', {
+    describe: 'Location of your Ember project',
+    type: 'string',
+})
+    .option('type', {
+    choices: ['app', 'v1-addon', 'v2-addon'],
+    demandOption: true,
+    describe: 'Type of your Ember project',
+    type: 'string',
+})
+    .parseSync();
+const codemodOptions = {
+    componentStructure: argv['component-structure'],
+    convertJavaScript: argv['convert-javascript'],
+    projectRoot: argv['root'] ?? process.cwd(),
+    projectType: argv['type'],
+};
+runCodemod(codemodOptions);

package/dist/src/blueprints/ember-cli/template-only-component.ts

@@ -0,0 +1,8 @@
+import templateOnlyComponent from '@ember/component/template-only';
+
+interface <%= entity.pascalizedName %>Signature {}
+
+const <%= entity.pascalizedName %> =
+  templateOnlyComponent<<%= entity.pascalizedName %>Signature>();
+
+export default <%= entity.pascalizedName %>;

package/dist/src/index.js

@@ -0,0 +1,14 @@
+import { analyzeProject, convertToTypeScript, createOptions, createRegistries, createSignatures, createTemplateOnlyComponents, updateSignatures, } from './steps/index.js';
+export function runCodemod(codemodOptions) {
+    const options = createOptions(codemodOptions);
+    // Prepare for migration
+    convertToTypeScript(options);
+    const context = analyzeProject(options);
+    // Update components without backing class
+    createTemplateOnlyComponents(context, options);
+    // Update components with backing class
+    createSignatures(context, options);
+    createRegistries(context, options);
+    // Fill out signatures
+    updateSignatures(context, options);
+}

package/dist/src/steps/analyze-project/analyze-components/find-arguments.js

@@ -0,0 +1,98 @@
+import { AST as ASTJavaScript } from '@codemod-utils/ast-javascript';
+import { AST as ASTTemplate } from '@codemod-utils/ast-template';
+function analyzeClass(file) {
+    const args = new Set();
+    if (file === undefined) {
+        return args;
+    }
+    // We know that the file is in TypeScript
+    const traverse = ASTJavaScript.traverse(true);
+    traverse(file, {
+        visitMemberExpression(node) {
+            if (node.value.object.type !== 'MemberExpression' ||
+                node.value.object.property.name !== 'args') {
+                return false;
+            }
+            switch (node.value.property.type) {
+                // Matches the pattern `this.args.someArgument`
+                case 'Identifier': {
+                    args.add(node.value.property.name);
+                    break;
+                }
+                // Matches the pattern `this.args['someArgument']`
+                case 'StringLiteral': {
+                    args.add(node.value.property.value);
+                    break;
+                }
+            }
+            return false;
+        },
+        visitVariableDeclarator(node) {
+            const { id: leftHandSide, init: rightHandSide } = node.value;
+            let isValid = false;
+            switch (rightHandSide?.type) {
+                // Matches the pattern `const { someArgument } = this.args;`
+                case 'MemberExpression': {
+                    if (rightHandSide.object.type !== 'ThisExpression' ||
+                        rightHandSide.property.type !== 'Identifier' ||
+                        rightHandSide.property.name !== 'args') {
+                        break;
+                    }
+                    isValid = true;
+                    break;
+                }
+                // Matches the pattern `const { someArgument } = this.args as SomeType;`
+                case 'TSAsExpression': {
+                    if (rightHandSide.expression.type !== 'MemberExpression' ||
+                        rightHandSide.expression.object.type !== 'ThisExpression' ||
+                        rightHandSide.expression.property.type !== 'Identifier' ||
+                        rightHandSide.expression.property.name !== 'args') {
+                        break;
+                    }
+                    isValid = true;
+                    break;
+                }
+            }
+            if (!isValid) {
+                return false;
+            }
+            // @ts-expect-error: Assume that types from external packages are correct
+            leftHandSide.properties.forEach((property) => {
+                switch (property.key.type) {
+                    case 'Identifier': {
+                        args.add(property.key.name);
+                        break;
+                    }
+                    case 'StringLiteral': {
+                        args.add(property.key.value);
+                        break;
+                    }
+                }
+            });
+            return false;
+        },
+    });
+    return args;
+}
+function analyzeTemplate(file) {
+    const traverse = ASTTemplate.traverse();
+    const args = new Set();
+    traverse(file, {
+        PathExpression(node) {
+            if (node.head.type !== 'AtHead') {
+                return;
+            }
+            const value = node.original.replace(/^@/, '');
+            const arg = value.split('.')[0];
+            args.add(arg);
+        },
+    });
+    return args;
+}
+export function findArguments(templateFile, classFile) {
+    const args = new Set([
+        ...analyzeTemplate(templateFile),
+        ...analyzeClass(classFile),
+    ]);
+    return Array.from(args).sort();
+}

package/dist/src/steps/analyze-project/analyze-components/find-blocks.js

@@ -0,0 +1,27 @@
+import { AST } from '@codemod-utils/ast-template';
+import { getBlockParameterType, normalizeBlockName, } from '../../../utils/components.js';
+export function findBlocks(templateFile) {
+    const traverse = AST.traverse();
+    const blocksMap = new Map();
+    traverse(templateFile, {
+        MustacheStatement(node) {
+            if (node.path.type !== 'PathExpression' ||
+                node.path.original !== 'yield') {
+                return;
+            }
+            const toArgument = node.hash.pairs.find(({ key }) => {
+                return key === 'to';
+            });
+            // @ts-expect-error: Assume that types from external packages are correct
+            const blockName = normalizeBlockName(toArgument?.value.original);
+            const positionalArgumentTypes = node.params.map(({ type: recastType }) => {
+                return getBlockParameterType(recastType);
+            });
+            blocksMap.set(blockName, positionalArgumentTypes);
+        },
+    });
+    if (blocksMap.size === 0) {
+        return;
+    }
+    return new Map(Array.from(blocksMap).sort());
+}

package/dist/src/steps/analyze-project/analyze-components/find-element.js

@@ -0,0 +1,21 @@
+import { AST } from '@codemod-utils/ast-template';
+import { getHtmlInterface } from '../../../utils/components.js';
+export function findElement(templateFile) {
+    const traverse = AST.traverse();
+    const htmlInterfaces = new Set();
+    traverse(templateFile, {
+        ElementNode(node) {
+            const hasSplattributes = node.attributes.find(({ name }) => {
+                return name === '...attributes';
+            });
+            if (!hasSplattributes) {
+                return;
+            }
+            htmlInterfaces.add(getHtmlInterface(node.tag));
+        },
+    });
+    if (htmlInterfaces.size === 0) {
+        return;
+    }
+    return Array.from(htmlInterfaces).sort();
+}

package/dist/src/steps/analyze-project/analyze-components/index.js

@@ -0,0 +1,3 @@
+export * from './find-arguments.js';
+export * from './find-blocks.js';
+export * from './find-element.js';

package/dist/src/steps/analyze-project/analyze-components.js

@@ -0,0 +1,66 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { findTemplateTags, toEcma } from '@codemod-utils/ast-template-tag';
+import { getClassPath, getTemplatePath } from '../../utils/components.js';
+import { findArguments, findBlocks, findElement, } from './analyze-components/index.js';
+function getFiles(componentName, extensions, options) {
+    const { projectRoot } = options;
+    if (extensions.has('.gts')) {
+        const gtsFilePath = getClassPath(componentName, extensions, options);
+        const gtsFile = readFileSync(join(projectRoot, gtsFilePath), 'utf8');
+        const ecmaFile = toEcma(gtsFile);
+        const templateTags = findTemplateTags(gtsFile);
+        const templateFile = templateTags.reduce((accumulator, templateTag) => {
+            accumulator += templateTag.contents;
+            return accumulator;
+        }, '');
+        return {
+            classFile: ecmaFile,
+            templateFile,
+        };
+    }
+    let classFile;
+    if (extensions.has('.ts')) {
+        const classFilePath = getClassPath(componentName, extensions, options);
+        classFile = readFileSync(join(projectRoot, classFilePath), 'utf8');
+    }
+    const templateFilePath = getTemplatePath(componentName, extensions, options);
+    const templateFile = readFileSync(join(projectRoot, templateFilePath), 'utf8');
+    return {
+        classFile,
+        templateFile,
+    };
+}
+export function analyzeComponents(extensionMap, options) {
+    const signatureMap = new Map();
+    for (const [componentName, extensions] of extensionMap) {
+        const hasTemplate = extensions.has('.hbs') || extensions.has('.gts');
+        if (!hasTemplate) {
+            signatureMap.set(componentName, {
+                Args: undefined,
+                Blocks: undefined,
+                Element: undefined,
+            });
+            continue;
+        }
+        const { classFile, templateFile } = getFiles(componentName, extensions, options);
+        try {
+            const Args = findArguments(templateFile, classFile);
+            const Blocks = findBlocks(templateFile);
+            const Element = findElement(templateFile);
+            signatureMap.set(componentName, {
+                Args,
+                Blocks,
+                Element,
+            });
+        }
+        catch (error) {
+            let message = `WARNING: analyzeComponents could not parse \`${componentName}\`. Please update the file manually.`;
+            if (error instanceof Error) {
+                message += ` (${error.message})`;
+            }
+            console.warn(`${message}\n`);
+        }
+    }
+    return signatureMap;
+}

package/dist/src/steps/analyze-project/filter-components.js

@@ -0,0 +1,29 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { toEcma } from '@codemod-utils/ast-template-tag';
+import { getBaseComponent, getClassPath } from '../../utils/components.js';
+function isSupported(file) {
+    const { importPath } = getBaseComponent(file);
+    const isComponent = importPath !== undefined;
+    const isClassicComponent = importPath === '@ember/component';
+    return isComponent && !isClassicComponent;
+}
+export function filterComponents(extensionMap, options) {
+    const { projectRoot } = options;
+    const filteredEntries = Array.from(extensionMap.entries()).filter(([componentName, extensions]) => {
+        const hasClassJavaScript = extensions.has('.gjs') || extensions.has('.js');
+        if (hasClassJavaScript) {
+            return false;
+        }
+        const hasClassTypeScript = extensions.has('.gts') || extensions.has('.ts');
+        // hbs file only
+        if (!hasClassTypeScript) {
+            return true;
+        }
+        const filePath = getClassPath(componentName, extensions, options);
+        const file = readFileSync(join(projectRoot, filePath), 'utf8');
+        const ecmaFile = toEcma(file);
+        return isSupported(ecmaFile);
+    });
+    return new Map(filteredEntries);
+}

package/dist/src/steps/analyze-project/find-components.js

@@ -0,0 +1,25 @@
+import { findFiles, renamePathByDirectory } from '@codemod-utils/files';
+import { getExtensionMap } from '../../utils/components.js';
+function normalizeComponentNames(extensionMap) {
+    return new Map(Array.from(extensionMap.entries()).map(([oldName, extensions]) => {
+        const newName = oldName.replace(/\/index$/, '');
+        return [newName, extensions];
+    }));
+}
+export function findComponents(options) {
+    const { componentStructure, projectRoot, src } = options;
+    const filePaths = findFiles(`${src}/**/*.{gjs,gts,hbs,js,ts}`, {
+        ignoreList: ['**/*.d.ts'],
+        projectRoot,
+    }).map((filePath) => {
+        return renamePathByDirectory(filePath, {
+            from: src,
+            to: '',
+        });
+    });
+    const extensionMap = getExtensionMap(filePaths);
+    if (componentStructure === 'nested') {
+        return normalizeComponentNames(extensionMap);
+    }
+    return extensionMap;
+}

package/dist/src/steps/analyze-project/index.js

@@ -0,0 +1,3 @@
+export * from './analyze-components.js';
+export * from './filter-components.js';
+export * from './find-components.js';

package/dist/src/steps/analyze-project.js

@@ -0,0 +1,10 @@
+import { analyzeComponents, filterComponents, findComponents, } from './analyze-project/index.js';
+export function analyzeProject(options) {
+    const unfilteredExtensionMap = findComponents(options);
+    const extensionMap = filterComponents(unfilteredExtensionMap, options);
+    const signatureMap = analyzeComponents(extensionMap, options);
+    return {
+        extensionMap,
+        signatureMap,
+    };
+}

package/dist/src/steps/convert-to-typescript.js

@@ -0,0 +1,22 @@
+import { findFiles, moveFiles } from '@codemod-utils/files';
+export function convertToTypeScript(options) {
+    const { convertJavaScript, projectRoot, src } = options;
+    if (!convertJavaScript) {
+        return;
+    }
+    const filePaths = findFiles(`${src}/**/*.{gjs,js}`, {
+        projectRoot,
+    });
+    const filePathMap = filePaths.reduce((accumulator, filePath) => {
+        if (filePath.endsWith('.gjs')) {
+            accumulator.set(filePath, filePath.replace(/\.gjs$/, '.gts'));
+        }
+        else {
+            accumulator.set(filePath, filePath.replace(/\.js$/, '.ts'));
+        }
+        return accumulator;
+    }, new Map());
+    moveFiles(filePathMap, {
+        projectRoot,
+    });
+}

package/dist/src/steps/create-options.js

@@ -0,0 +1,22 @@
+function getSrc(projectType) {
+    switch (projectType) {
+        case 'app': {
+            return 'app/components';
+        }
+        case 'v1-addon': {
+            return 'addon/components';
+        }
+        case 'v2-addon': {
+            return 'src/components';
+        }
+    }
+}
+export function createOptions(codemodOptions) {
+    const { componentStructure, convertJavaScript, projectRoot, projectType } = codemodOptions;
+    return {
+        componentStructure,
+        convertJavaScript,
+        projectRoot,
+        src: getSrc(projectType),
+    };
+}

package/dist/src/steps/create-registries/create-registry.js

@@ -0,0 +1,17 @@
+import { AST } from '@codemod-utils/ast-javascript';
+export function createRegistry(file, data) {
+    const traverse = AST.traverse(true);
+    const ast = traverse(file);
+    // @ts-expect-error: Assume that types from external packages are correct
+    const nodes = ast.program.body;
+    const registryEntries = AST.builders.tsInterfaceBody([
+        AST.builders.tsPropertySignature(AST.builders.stringLiteral(data.entity.doubleColonizedName), AST.builders.tsTypeAnnotation(AST.builders.tsTypeQuery(AST.builders.identifier(data.entity.pascalizedName)))),
+        AST.builders.tsPropertySignature(AST.builders.stringLiteral(data.entity.name), AST.builders.tsTypeAnnotation(AST.builders.tsTypeQuery(AST.builders.identifier(data.entity.pascalizedName)))),
+    ]);
+    const registryNode = AST.builders.tsModuleDeclaration(AST.builders.stringLiteral('@glint/environment-ember-loose/registry'), AST.builders.tsModuleBlock([
+        AST.builders.exportDefaultDeclaration(AST.builders.tsInterfaceDeclaration(AST.builders.identifier('Registry'), registryEntries)),
+    ]));
+    registryNode.declare = true;
+    nodes.push(registryNode);
+    return AST.print(ast);
+}

package/dist/src/steps/create-registries/has-registry.js

@@ -0,0 +1,18 @@
+import { AST } from '@codemod-utils/ast-javascript';
+export function hasRegistry(file) {
+    const traverse = AST.traverse(true);
+    let hasRegistry = false;
+    traverse(file, {
+        visitTSModuleDeclaration(path) {
+            if (path.node.id.type !== 'StringLiteral') {
+                return false;
+            }
+            const moduleName = path.node.id.value;
+            if (moduleName === '@glint/environment-ember-loose/registry') {
+                hasRegistry = true;
+            }
+            return false;
+        },
+    });
+    return hasRegistry;
+}

package/dist/src/steps/create-registries/index.js

@@ -0,0 +1,3 @@
+export * from './create-registry.js';
+export * from './has-registry.js';
+export * from './rename-component.js';

package/dist/src/steps/create-registries/rename-component/index.js

@@ -0,0 +1,2 @@
+export * from './pass-component-name-to-base-component.js';
+export * from './update-references.js';

package/dist/src/steps/create-registries/rename-component/pass-component-name-to-base-component.js

@@ -0,0 +1,56 @@
+import { AST } from '@codemod-utils/ast-javascript';
+export function passComponentNameToBaseComponent(file, options) {
+    const traverse = AST.traverse(true);
+    const { baseComponentName, data } = options;
+    let componentName;
+    const ast = traverse(file, {
+        visitClassDeclaration(path) {
+            if (!path.node.superClass ||
+                path.node.superClass.type !== 'Identifier' ||
+                path.node.superClass.name !== baseComponentName) {
+                return false;
+            }
+            if (!path.node.id) {
+                path.node.id = AST.builders.identifier(data.entity.pascalizedName);
+                return false;
+            }
+            componentName = path.node.id.name;
+            path.node.id.name = data.entity.pascalizedName;
+            return false;
+        },
+        visitVariableDeclaration(path) {
+            const declaration = path.node.declarations[0];
+            if (declaration.type !== 'VariableDeclarator') {
+                return false;
+            }
+            switch (declaration.init?.type) {
+                case 'CallExpression': {
+                    if (declaration.init.callee.type !== 'Identifier' ||
+                        declaration.init.callee.name !== baseComponentName ||
+                        declaration.id.type !== 'Identifier') {
+                        return false;
+                    }
+                    componentName = declaration.id.name;
+                    declaration.id.name = data.entity.pascalizedName;
+                    return false;
+                }
+                case 'ClassExpression': {
+                    if (!declaration.init.superClass ||
+                        declaration.init.superClass.type !== 'Identifier' ||
+                        declaration.init.superClass.name !== baseComponentName ||
+                        declaration.id.type !== 'Identifier') {
+                        return false;
+                    }
+                    componentName = declaration.id.name;
+                    declaration.id.name = data.entity.pascalizedName;
+                    return false;
+                }
+            }
+            return false;
+        },
+    });
+    return {
+        componentName,
+        newFile: AST.print(ast),
+    };
+}