ember-codemod-add-component-signatures 5.1.0 → 5.2.1

package/README.md

@@ -15,8 +15,8 @@ You can run this codemod to get started.
 ## Features
 
 - Scaffolds signature for components
-- Adds template registry for components
-- Supports `<template>` tag components
+- Adds template registry for components (Glint v1)
+- Supports `<template>` tag (Glint v2)
 
 <div align="center">
   <figure>
@@ -90,6 +90,18 @@ pnpx ember-codemod-add-component-signatures --convert-javascript
 
 <details>
 
+<summary>Optional: Create registries</summary>
+
+By default, the codemod doesn't add registries to component classes, because these registries are unnecessary for Glint v2 (strict mode templates). Pass `--create-registries` if you use Glint v1 (loose mode templates).
+
+```sh
+pnpx ember-codemod-add-component-signatures --create-registries
+```
+
+</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).

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

@@ -17,6 +17,11 @@ const argv = yargs(hideBin(process.argv))
     default: false,
     describe: 'Convert *.{js,gjs} files?',
     type: 'boolean',
+})
+    .option('create-registries', {
+    default: false,
+    describe: 'Create registries for Glint v1?',
+    type: 'boolean',
 })
     .option('root', {
     describe: 'Location of your Ember project',
@@ -26,6 +31,7 @@ const argv = yargs(hideBin(process.argv))
 const codemodOptions = {
     componentStructure: argv['component-structure'],
     convertJavaScript: argv['convert-javascript'],
+    createRegistries: argv['create-registries'],
     projectRoot: argv['root'] ?? process.cwd(),
 };
 runCodemod(codemodOptions);

package/dist/src/index.js

@@ -1,14 +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);
+    if (options.convertJavaScript) {
+        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
+    if (options.createRegistries) {
+        createRegistries(context, options);
+    }
     updateSignatures(context, options);
 }

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

@@ -1,8 +1,8 @@
 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';
+import { findArguments, findBlocks, findElement, } from '../../utils/analyze-project/index.js';
+import { getClassPath, getTemplatePath } from '../../utils/components/index.js';
 function getFiles(componentName, extensions, options) {
     const { projectRoot } = options;
     if (extensions.has('.gts')) {

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

@@ -1,7 +1,7 @@
 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';
+import { getBaseComponent, getClassPath, } from '../../utils/components/index.js';
 function isSupported(file) {
     const { importPath } = getBaseComponent(file);
     const isComponent = importPath !== undefined;
@@ -10,20 +10,24 @@ function isSupported(file) {
 }
 export function filterComponents(extensionMap, options) {
     const { projectRoot } = options;
-    const filteredEntries = Array.from(extensionMap.entries()).filter(([componentName, extensions]) => {
+    const newExtensionMap = new Map();
+    for (const [componentName, extensions] of extensionMap) {
         const hasClassJavaScript = extensions.has('.gjs') || extensions.has('.js');
         if (hasClassJavaScript) {
-            return false;
+            continue;
         }
-        const hasClassTypeScript = extensions.has('.gts') || extensions.has('.ts');
+        const filteredExtensions = extensions;
+        const hasClassTypeScript = filteredExtensions.has('.gts') || filteredExtensions.has('.ts');
         // hbs file only
         if (!hasClassTypeScript) {
-            return true;
+            newExtensionMap.set(componentName, filteredExtensions);
+            continue;
         }
-        const filePath = getClassPath(componentName, extensions, options);
+        const filePath = getClassPath(componentName, filteredExtensions, options);
         const file = readFileSync(join(projectRoot, filePath), 'utf8');
-        const ecmaFile = toEcma(file);
-        return isSupported(ecmaFile);
-    });
-    return new Map(filteredEntries);
+        if (isSupported(toEcma(file))) {
+            newExtensionMap.set(componentName, filteredExtensions);
+        }
+    }
+    return newExtensionMap;
 }

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

@@ -1,5 +1,5 @@
 import { findFiles, renamePathByDirectory } from '@codemod-utils/files';
-import { getExtensionMap } from '../../utils/components.js';
+import { getExtensionMap } from '../../utils/components/index.js';
 function normalizeComponentNames(extensionMap) {
     return new Map(Array.from(extensionMap.entries()).map(([oldName, extensions]) => {
         const newName = oldName.replace(/\/index$/, '');

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

@@ -1,9 +1,6 @@
 import { findFiles, moveFiles } from '@codemod-utils/files';
 export function convertToTypeScript(options) {
-    const { convertJavaScript, projectRoot, src } = options;
-    if (!convertJavaScript) {
-        return;
-    }
+    const { projectRoot, src } = options;
     const filePaths = findFiles(`${src}/components/**/*.{gjs,js}`, {
         projectRoot,
     });

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

@@ -1,7 +1,7 @@
 import { getPackageType, readPackageJson } from '@codemod-utils/package-json';
 import { SOURCE_DIRECTORY } from '../utils/ember.js';
 export function createOptions(codemodOptions) {
-    const { componentStructure, convertJavaScript, projectRoot } = codemodOptions;
+    const { componentStructure, convertJavaScript, createRegistries, projectRoot, } = codemodOptions;
     const packageJson = readPackageJson({ projectRoot });
     const packageType = getPackageType(packageJson);
     if (packageType === 'node') {
@@ -11,6 +11,7 @@ export function createOptions(codemodOptions) {
     return {
         componentStructure,
         convertJavaScript,
+        createRegistries,
         projectRoot,
         src,
     };

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

@@ -3,8 +3,8 @@ import { join } from 'node:path';
 import { toEcma, updateJavaScript } from '@codemod-utils/ast-template-tag';
 import { doubleColonize, pascalize } from '@codemod-utils/ember';
 import { createFiles, } from '@codemod-utils/files';
-import { getClassPath } from '../utils/components.js';
-import { createRegistry, hasRegistry, renameComponent, } from './create-registries/index.js';
+import { getClassPath } from '../utils/components/index.js';
+import { createRegistry, hasRegistry, renameComponent, } from '../utils/create-registries/index.js';
 export function createRegistries(context, options) {
     const { extensionMap } = context;
     const { projectRoot } = options;

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

@@ -3,8 +3,8 @@ import { join } from 'node:path';
 import { updateJavaScript } from '@codemod-utils/ast-template-tag';
 import { pascalize } from '@codemod-utils/ember';
 import { createFiles, } from '@codemod-utils/files';
-import { getClassPath } from '../utils/components.js';
-import { createSignature } from './create-signatures/index.js';
+import { getClassPath } from '../utils/components/index.js';
+import { createSignature } from '../utils/create-signatures/index.js';
 export function createSignatures(context, options) {
     const { extensionMap } = context;
     const { projectRoot } = options;

package/dist/src/steps/create-template-only-components.js

@@ -4,7 +4,7 @@ import { processTemplate } from '@codemod-utils/blueprints';
 import { pascalize } from '@codemod-utils/ember';
 import { createFiles, } from '@codemod-utils/files';
 import { blueprintsRoot } from '../utils/blueprints.js';
-import { getClassPath } from '../utils/components.js';
+import { getClassPath } from '../utils/components/index.js';
 const blueprintFile = readFileSync(join(blueprintsRoot, 'ember-cli/template-only-component.ts'), 'utf8');
 export function createTemplateOnlyComponents(context, options) {
     const { extensionMap } = context;

package/dist/src/steps/update-signatures.js

@@ -3,8 +3,8 @@ import { join } from 'node:path';
 import { updateJavaScript } from '@codemod-utils/ast-template-tag';
 import { pascalize } from '@codemod-utils/ember';
 import { createFiles, } from '@codemod-utils/files';
-import { getClassPath } from '../utils/components.js';
-import { updateSignature } from './update-signatures/index.js';
+import { getClassPath } from '../utils/components/index.js';
+import { updateSignature } from '../utils/update-signatures/index.js';
 export function updateSignatures(context, options) {
     const { extensionMap, signatureMap } = context;
     const { projectRoot } = options;

package/dist/src/{steps/analyze-project/analyze-components → utils/analyze-project}/find-blocks.js

@@ -1,5 +1,5 @@
 import { AST } from '@codemod-utils/ast-template';
-import { getBlockParameterType, normalizeBlockName, } from '../../../utils/components.js';
+import { getBlockParameterType, normalizeBlockName, } from '../components/index.js';
 export function findBlocks(templateFile) {
     const traverse = AST.traverse();
     const blocksMap = new Map();

package/dist/src/{steps/analyze-project/analyze-components → utils/analyze-project}/find-element.js

@@ -1,5 +1,5 @@
 import { AST } from '@codemod-utils/ast-template';
-import { getHtmlInterface } from '../../../utils/components.js';
+import { getHtmlInterface } from '../components/index.js';
 export function findElement(templateFile) {
     const traverse = AST.traverse();
     const htmlInterfaces = new Set();

package/dist/src/utils/components/index.js

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

package/dist/src/{steps → utils}/create-registries/rename-component.js

@@ -1,4 +1,4 @@
-import { getBaseComponent } from '../../utils/components.js';
+import { getBaseComponent } from '../../utils/components/index.js';
 import { passComponentNameToBaseComponent, updateReferences, } from './rename-component/index.js';
 export function renameComponent(file, data) {
     const { baseComponentName } = getBaseComponent(file);

package/dist/src/{steps → utils}/create-signatures/create-signature.js

@@ -1,4 +1,4 @@
-import { getBaseComponent } from '../../utils/components.js';
+import { getBaseComponent } from '../../utils/components/index.js';
 import { passSignatureToBaseComponent, updateConstructor, updateReferences, } from './create-signature/index.js';
 export function createSignature(file, data) {
     const { baseComponentName } = getBaseComponent(file);

package/dist/src/{steps → utils}/update-signatures/update-signature.js

@@ -1,5 +1,5 @@
 import { AST } from '@codemod-utils/ast-javascript';
-import { builderCreateArgsNode, builderCreateBlocksNode, builderCreateElementNode, } from './builders.js';
+import { builderCreateArgsNode, builderCreateBlocksNode, builderCreateElementNode, } from './update-signature/builders.js';
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function getBodyNode(node, key) {
     // @ts-expect-error: Assume that types from external packages are correct

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-codemod-add-component-signatures",
-  "version": "5.1.0",
+  "version": "5.2.1",
   "description": "Codemod to add component signatures",
   "keywords": [
     "codemod",

package/dist/src/utils/components.js

@@ -1,7 +0,0 @@
-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';