ember-codemod-add-component-signatures 4.0.0

package/dist/src/utils/blueprints.js

@@ -0,0 +1 @@
+export * from './blueprints/blueprints-root.js';

package/dist/src/utils/components/get-base-component.js

@@ -0,0 +1,41 @@
+import { AST } from '@codemod-utils/ast-javascript';
+export function getBaseComponent(file) {
+    const traverse = AST.traverse(true);
+    let baseComponentName;
+    let importPath;
+    traverse(file, {
+        visitImportDeclaration(path) {
+            switch (path.node.source.value) {
+                case '@ember/component':
+                case '@ember/component/template-only':
+                case '@glimmer/component': {
+                    const defaultImport = path.node.specifiers.find(({ type }) => {
+                        return type === 'ImportDefaultSpecifier';
+                    });
+                    if (!defaultImport) {
+                        return false;
+                    }
+                    baseComponentName = defaultImport.local.name;
+                    importPath = path.node.source.value;
+                    return false;
+                }
+                case '@ember/template-compiler': {
+                    const namedImport = path.node.specifiers.find(({ type }) => {
+                        return type === 'ImportSpecifier';
+                    });
+                    if (!namedImport) {
+                        return false;
+                    }
+                    baseComponentName = namedImport.local.name;
+                    importPath = path.node.source.value;
+                    return false;
+                }
+            }
+            return false;
+        },
+    });
+    return {
+        baseComponentName,
+        importPath,
+    };
+}

package/dist/src/utils/components/get-block-parameter.type.js

@@ -0,0 +1,14 @@
+const defaultTsType = 'unknown';
+const mapping = new Map([
+    ['BooleanLiteral', 'boolean'],
+    ['NullLiteral', 'null'],
+    ['NumberLiteral', 'number'],
+    ['PathExpression', 'unknown'],
+    ['StringLiteral', 'string'],
+    ['SubExpression', 'unknown'],
+    ['UndefinedLiteral', 'undefined'],
+]);
+export function getBlockParameterType(recastType) {
+    const tsType = mapping.get(recastType);
+    return tsType ?? defaultTsType;
+}

package/dist/src/utils/components/get-class-path.js

@@ -0,0 +1,15 @@
+import { join } from 'node:path';
+export function getClassPath(componentName, extensions, options) {
+    const { componentStructure, src } = options;
+    const filePath = componentStructure === 'nested'
+        ? join(src, componentName, 'index')
+        : join(src, componentName);
+    if (extensions.has('.gts')) {
+        return `${filePath}.gts`;
+    }
+    if (extensions.has('.ts')) {
+        return `${filePath}.ts`;
+    }
+    // hbs file only. The blueprint for template-only component is in `*.ts`.
+    return `${filePath}.ts`;
+}

package/dist/src/utils/components/get-extension-map.js

@@ -0,0 +1,15 @@
+import { join } from 'node:path';
+import { parseFilePath } from '@codemod-utils/files';
+export function getExtensionMap(filePaths) {
+    const extensionMap = new Map();
+    filePaths.forEach((filePath) => {
+        const { dir, ext, name } = parseFilePath(filePath);
+        const componentName = join(dir, name);
+        if (extensionMap.has(componentName)) {
+            extensionMap.get(componentName).add(ext);
+            return;
+        }
+        extensionMap.set(componentName, new Set([ext]));
+    });
+    return extensionMap;
+}

package/dist/src/utils/components/get-html-interface.js

@@ -0,0 +1,64 @@
+/* https://developer.mozilla.org/docs/Web/API/HTML_DOM_API#html_dom_api_interfaces */
+const defaultHtmlInterface = 'HTMLElement';
+const mapping = new Map([
+    ['a', 'HTMLAnchorElement'],
+    ['article', 'HTMLElement'],
+    ['aside', 'HTMLElement'],
+    ['audio', 'HTMLAudioElement'],
+    ['b', 'HTMLElement'],
+    ['blockquote', 'HTMLQuoteElement'],
+    ['button', 'HTMLButtonElement'],
+    ['canvas', 'HTMLCanvasElement'],
+    ['caption', 'HTMLElement'],
+    ['code', 'HTMLElement'],
+    ['dialog', 'HTMLDialogElement'],
+    ['div', 'HTMLDivElement'],
+    ['em', 'HTMLElement'],
+    ['fieldset', 'HTMLFieldSetElement'],
+    ['figcaption', 'HTMLElement'],
+    ['footer', 'HTMLElement'],
+    ['form', 'HTMLFormElement'],
+    ['h1', 'HTMLHeadingElement'],
+    ['h2', 'HTMLHeadingElement'],
+    ['h3', 'HTMLHeadingElement'],
+    ['h4', 'HTMLHeadingElement'],
+    ['h5', 'HTMLHeadingElement'],
+    ['h6', 'HTMLHeadingElement'],
+    ['header', 'HTMLElement'],
+    ['i', 'HTMLElement'],
+    ['iframe', 'HTMLIFrameElement'],
+    ['img', 'HTMLImageElement'],
+    ['input', 'HTMLInputElement'],
+    ['label', 'HTMLLabelElement'],
+    ['legend', 'HTMLLegendElement'],
+    ['li', 'HTMLLIElement'],
+    ['main', 'HTMLElement'],
+    ['nav', 'HTMLElement'],
+    ['ol', 'HTMLOListElement'],
+    ['optgroup', 'HTMLOptGroupElement'],
+    ['option', 'HTMLOptionElement'],
+    ['p', 'HTMLParagraphElement'],
+    ['picture', 'HTMLPictureElement'],
+    ['pre', 'HTMLElement'],
+    ['q', 'HTMLQuoteElement'],
+    ['section', 'HTMLElement'],
+    ['select', 'HTMLSelectElement'],
+    ['span', 'HTMLSpanElement'],
+    ['strong', 'HTMLElement'],
+    ['svg', 'SVGElement'],
+    ['table', 'HTMLTableElement'],
+    ['tbody', 'HTMLTableSectionElement'],
+    ['td', 'HTMLTableCellElement'],
+    ['textarea', 'HTMLTextAreaElement'],
+    ['tfoot', 'HTMLTableSectionElement'],
+    ['th', 'HTMLTableCellElement'],
+    ['thead', 'HTMLTableSectionElement'],
+    ['time', 'HTMLTimeElement'],
+    ['tr', 'HTMLTableRowElement'],
+    ['ul', 'HTMLUListElement'],
+    ['video', 'HTMLVideoElement'],
+]);
+export function getHtmlInterface(elementTag) {
+    const htmlInterface = mapping.get(elementTag);
+    return htmlInterface ?? defaultHtmlInterface;
+}

package/dist/src/utils/components/get-template-path.js

@@ -0,0 +1,11 @@
+import { join } from 'node:path';
+export function getTemplatePath(componentName, extensions, options) {
+    const { componentStructure, src } = options;
+    const filePath = componentStructure === 'nested'
+        ? join(src, componentName, 'index')
+        : join(src, componentName);
+    if (!extensions.has('.hbs')) {
+        throw new RangeError('extensions must include `.hbs`');
+    }
+    return `${filePath}.hbs`;
+}

package/dist/src/utils/components/normalize-block-name.js

@@ -0,0 +1,14 @@
+export function normalizeBlockName(blockName) {
+    switch (blockName) {
+        case undefined: {
+            return 'default';
+        }
+        case 'else':
+        case 'inverse': {
+            return 'else';
+        }
+        default: {
+            return blockName;
+        }
+    }
+}

package/dist/src/utils/components.js

@@ -0,0 +1,7 @@
+export * from './components/get-base-component.js';
+export * from './components/get-block-parameter.type.js';
+export * from './components/get-class-path.js';
+export * from './components/get-extension-map.js';
+export * from './components/get-html-interface.js';
+export * from './components/get-template-path.js';
+export * from './components/normalize-block-name.js';

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "ember-codemod-add-component-signatures",
+  "version": "4.0.0",
+  "description": "Codemod to add component signatures",
+  "keywords": [
+    "codemod",
+    "ember-codemod",
+    "ember-octane",
+    "ember-polaris",
+    "emberjs",
+    "embroider",
+    "glint"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ijlee2/ember-codemod-add-component-signatures.git"
+  },
+  "license": "MIT",
+  "author": "Isaac J. Lee",
+  "type": "module",
+  "main": "dist/src/index.js",
+  "bin": "dist/bin/ember-codemod-add-component-signatures.js",
+  "directories": {
+    "test": "tests"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@codemod-utils/ast-javascript": "^2.0.7",
+    "@codemod-utils/ast-template": "^2.0.3",
+    "@codemod-utils/ast-template-tag": "^0.6.0",
+    "@codemod-utils/blueprints": "^2.0.3",
+    "@codemod-utils/ember": "^3.0.3",
+    "@codemod-utils/files": "^3.0.5",
+    "yargs": "^18.0.0"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.7",
+    "@changesets/get-github-info": "^0.6.0",
+    "@codemod-utils/tests": "^2.0.4",
+    "@ijlee2-frontend-configs/eslint-config-node": "^2.1.2",
+    "@ijlee2-frontend-configs/prettier": "^2.1.1",
+    "@sondr3/minitest": "^0.1.2",
+    "@tsconfig/node20": "^20.1.6",
+    "@tsconfig/strictest": "^2.0.5",
+    "@types/node": "^20.19.13",
+    "@types/yargs": "^17.0.33",
+    "concurrently": "^9.2.1",
+    "eslint": "^9.35.0",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.2"
+  },
+  "engines": {
+    "node": "20.* || >= 22"
+  },
+  "scripts": {
+    "build": "./build.sh --production",
+    "format": "prettier . --cache --write",
+    "lint": "concurrently \"pnpm:lint:*(!fix)\" --names \"lint:\"",
+    "lint:fix": "concurrently \"pnpm:lint:*:fix\" --names \"fix:\" && pnpm format",
+    "lint:format": "prettier . --cache --check",
+    "lint:js": "eslint . --cache",
+    "lint:js:fix": "eslint . --fix",
+    "lint:types": "tsc --noEmit",
+    "release:prepare": "changeset version",
+    "release:publish": "pnpm build && changeset publish",
+    "test": "./build.sh --test && mt dist-for-testing --quiet"
+  }
+}