Merge pull request #16 from ember-codemods/cleanup

Author: Robert Jackson

.eslintignore

@@ -0,0 +1,5 @@
+# do not ignore dotfiles
+!.*
+.git/
+
+/node_modules

.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  root: true,
+  parserOptions: {
+    ecmaVersion: 2019,
+    sourceType: 'script',
+  },
+  extends: ['eslint:recommended', 'plugin:node/recommended', 'plugin:prettier/recommended'],
+  plugins: ['prettier', 'node'],
+  env: {
+    node: true,
+  },
+  rules: {},
+  overrides: [
+    {
+      files: ['test/**/*.js'],
+      env: {
+        mocha: true,
+      },
+    },
+  ],
+};

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 100
+}

lib/migrator.js

@@ -2,11 +2,14 @@
 
 const fs = require('fs');
 const path = require('path');
-const glob = require("glob");
-const { getLayoutNameTemplates, getPartialTemplates, getImportedTemplates } = require('./utils/templates')
-const { moveFile, removeDirs } = require('./utils/file')
+const glob = require('glob');
+const {
+  getLayoutNameTemplates,
+  getPartialTemplates,
+  getImportedTemplates,
+} = require('./utils/templates');
+const { moveFile, removeDirs } = require('./utils/file');
 const { transform: dropLayoutBinding } = require('./utils/rewrite-imports');
-const { template } = require('jscodeshift');
 
 /**
  * @typedef {object} Options
@@ -16,19 +19,16 @@ const { template } = require('jscodeshift');
 
 module.exports = class Migrator {
   /**
-   * @param {Options} options 
+   * @param {Options} options
    */
   constructor({ projectRoot, structure }) {
+    /** @type {string} */
     this.projectRoot = projectRoot;
+
+    /** @type {'flat' | 'nested'} */
     this.structure = structure;
   }
 
-  /** @type {string} */
-  projectRoot;
-
-  /** @type {'flat' | 'nested'} */
-  structure;
-
   get appRoot() {
     return path.join(this.projectRoot, 'app');
   }
@@ -62,30 +62,36 @@ module.exports = class Migrator {
   }
 
   findComponentTemplates() {
-    return glob.sync(`{${this.appComponentTemplatesDir},${this.addonComponentTemplatesDir}}/**/*.hbs`);
+    return glob.sync(
+      `{${this.appComponentTemplatesDir},${this.addonComponentTemplatesDir}}/**/*.hbs`
+    );
   }
 
   findComponentClasses() {
     return glob.sync(`{${this.appBackingClassesDir},${this.addonBackingClassesDir}}/**/*.{js,ts}`);
   }
 
   findAllTemplates() {
-    return glob.sync(`{${this.appBackingClassesDir},${this.appTemplatesDir},${this.addonBackingClassesDir},${this.addonTemplatesDir}}/**/*.hbs`);
+    return glob.sync(
+      `{${this.appBackingClassesDir},${this.appTemplatesDir},${this.addonBackingClassesDir},${this.addonTemplatesDir}}/**/*.hbs`
+    );
   }
 
   /**
    * @param {string[]} templateFilePaths
    * @param {string[]} componentsWithLayoutName
    */
   skipTemplatesUsedAsLayoutName(templateFilePaths, componentsWithLayoutName) {
-    console.info(`\nChecking if any component templates are used as templates of other components using \`layoutName\``);
+    console.info(
+      `\nChecking if any component templates are used as templates of other components using \`layoutName\``
+    );
 
     if (componentsWithLayoutName.length) {
-      componentsWithLayoutName.sort().forEach(component => {
+      componentsWithLayoutName.sort().forEach((component) => {
         console.info(`❌ Did not move '${component}' due to usage as "layoutName" in a component`);
       });
 
-      templateFilePaths = templateFilePaths.filter(templateFilePath => {
+      templateFilePaths = templateFilePaths.filter((templateFilePath) => {
         // Extract '/(app|addon)/templates/components/nested1/nested-component.hbs'
         const filePathFromApp = templateFilePath.slice(this.projectRoot.length);
 
@@ -105,19 +111,19 @@ module.exports = class Migrator {
   }
 
   /**
-   * @param {string[]} templateFilePaths 
+   * @param {string[]} templateFilePaths
    */
   skipTemplatesUsedAsPartial(templateFilePaths) {
     console.info(`\nChecking if any component templates are used as partials`);
 
     const componentsWithPartial = getPartialTemplates(this.findAllTemplates());
 
     if (componentsWithPartial.length) {
-      componentsWithPartial.sort().forEach(component => {
+      componentsWithPartial.sort().forEach((component) => {
         console.info(`❌ Did not move '${component}' due to usage as a "partial"`);
       });
 
-      templateFilePaths = templateFilePaths.filter(templateFilePath => {
+      templateFilePaths = templateFilePaths.filter((templateFilePath) => {
         // Extract '/(app|addon)/templates/components/nested1/nested-component.hbs'
         let filePathFromApp = templateFilePath.slice(this.projectRoot.length);
 
@@ -130,7 +136,7 @@ module.exports = class Migrator {
 
           If `filePathFromApp` matches the latter pattern, we remove the hyphen. 
         */
-        if (/\/\-[\w\-]+\.hbs/.test(filePathFromApp)) {
+        if (/\/-[\w-]+\.hbs/.test(filePathFromApp)) {
           filePathFromApp = filePathFromApp.replace('/-', '/');
         }
 
@@ -153,10 +159,8 @@ module.exports = class Migrator {
    * @param {string[]} templateFilePaths
    * @returns {string[]}
    */
-   skipTemplatesUsedInMultipleBackingClasses(templateFilePaths) {
-    console.info(
-      '\nChecking if any component templates are used in multiple backing classes'
-    );
+  skipTemplatesUsedInMultipleBackingClasses(templateFilePaths) {
+    console.info('\nChecking if any component templates are used in multiple backing classes');
 
     const componentFilePaths = this.findComponentClasses();
     const componentsImportingTemplates = getImportedTemplates(
@@ -171,12 +175,9 @@ module.exports = class Migrator {
 
       // Map the imported template name back to the template file paths as we
       // have them on
-      const importedTemplate = importedTemplates[0]
-        .replace(/.*\/templates/gi, "templates");
+      const importedTemplate = importedTemplates[0].replace(/.*\/templates/gi, 'templates');
 
-      const template = templateFilePaths.find(
-        path => path.includes(importedTemplate)
-      )
+      const template = templateFilePaths.find((path) => path.includes(importedTemplate));
 
       // If we've previously put this in the "allowed" bucket, we now know it
       // *shouldn't* be allowed, because it's used in another
@@ -197,8 +198,9 @@ module.exports = class Migrator {
     }
 
     for (let [templatePath, importingModules] of reusedTemplates.entries()) {
-      const importingModuleLocalPaths =
-        importingModules.map(path => path.replace(/.*\/(app|addon)/, ""));
+      const importingModuleLocalPaths = importingModules.map((path) =>
+        path.replace(/.*\/(app|addon)/, '')
+      );
 
       const message =
         `❌ Did not move '${templatePath}' because it was imported by ` +
@@ -208,24 +210,27 @@ module.exports = class Migrator {
       console.info(message);
     }
 
-    const nonImported = templateFilePaths
-      .filter(path => !allowed.has(path) && !reusedTemplates.has(path));
+    const nonImported = templateFilePaths.filter(
+      (path) => !allowed.has(path) && !reusedTemplates.has(path)
+    );
 
     return Array.from(allowed.keys()).concat(nonImported);
   }
 
   /**
-   * @param {string[]} templateFilePaths 
+   * @param {string[]} templateFilePaths
    */
   changeComponentStructureToFlat(templateFilePaths) {
-    templateFilePaths.forEach(templateFilePath => {
+    templateFilePaths.forEach((templateFilePath) => {
       // Extract '/(app|addon)/templates/components/nested1/nested-component.hbs'
       const filePathFromApp = templateFilePath.slice(this.projectRoot.length);
 
       const type = typeFromFilePath(filePathFromApp);
 
       // Extract '/nested1/nested-component.hbs'
-      const filePathFromAppTemplatesComponents = filePathFromApp.slice(`${type}/templates/components/`.length);
+      const filePathFromAppTemplatesComponents = filePathFromApp.slice(
+        `${type}/templates/components/`.length
+      );
 
       // '[APP_PATH]/(app|addon)/components/nested1/nested-component.hbs'
       const root = type === 'app' ? this.appRoot : this.addonRoot;
@@ -235,19 +240,21 @@ module.exports = class Migrator {
   }
 
   /**
-   * @param {string[]} templateFilePaths 
+   * @param {string[]} templateFilePaths
    */
   changeComponentStructureToNested(templateFilePaths) {
     const classFilePaths = this.findComponentClasses();
 
-    templateFilePaths.forEach(templateFilePath => {
+    templateFilePaths.forEach((templateFilePath) => {
       // Extract '/(app|addon)/templates/components/nested1/nested-component.hbs'
       const filePathFromProject = templateFilePath.slice(this.projectRoot.length);
 
       const type = typeFromFilePath(filePathFromProject);
 
       // Extract '/nested1/nested-component.hbs'
-      const filePathFromAppTemplatesComponents = filePathFromProject.slice(`${type}/templates/components/`.length);
+      const filePathFromAppTemplatesComponents = filePathFromProject.slice(
+        `${type}/templates/components/`.length
+      );
       const fileExtension = path.extname(filePathFromAppTemplatesComponents);
 
       // Extract '/nested1/nested-component'
@@ -261,42 +268,39 @@ module.exports = class Migrator {
       // Build '[APP_PATH]/(app|addon)/components/nested1/nested-component/index.js'
       const classFilePath = {
         js: path.join(root, 'components', `${targetPath}.js`),
-        ts: path.join(root, 'components', `${targetPath}.ts`)
+        ts: path.join(root, 'components', `${targetPath}.ts`),
       };
 
       if (classFilePaths.includes(classFilePath.js)) {
         const newClassFilePath = path.join(root, 'components', targetPath, 'index.js');
         moveFile(classFilePath.js, newClassFilePath);
-
       } else if (classFilePaths.includes(classFilePath.ts)) {
         const newClassFilePath = path.join(root, 'components', targetPath, 'index.ts');
         moveFile(classFilePath.ts, newClassFilePath);
-
       }
     });
   }
 
   /**
-   * @param {string[]} templateFilePaths 
+   * @param {string[]} templateFilePaths
    */
   removeLayoutBinding(templateFilePaths) {
-    templateFilePaths.forEach(templateFilePath => {
+    templateFilePaths.forEach((templateFilePath) => {
       // Extract '/(app|addon)/templates/components/nested1/nested-component.hbs'
-      const filePathFromProject = templateFilePath
-        .slice(this.projectRoot.length);
-      
+      const filePathFromProject = templateFilePath.slice(this.projectRoot.length);
+
       const backingJsClassProjectPath = filePathFromProject
         .replace('templates/components', 'components')
         .replace('.hbs', '.js');
-      
+
       const backingTsClassProjectPath = filePathFromProject
         .replace('templates/components', 'components')
         .replace('.hbs', '.ts');
-      
-      const backingClassPaths =
-        [backingJsClassProjectPath, backingTsClassProjectPath].map(
-          backingClassPath => path.join(this.projectRoot, backingClassPath)
-        );
+
+      const backingClassPaths = [
+        backingJsClassProjectPath,
+        backingTsClassProjectPath,
+      ].map((backingClassPath) => path.join(this.projectRoot, backingClassPath));
 
       backingClassPaths.forEach((path) => {
         if (fs.existsSync(path)) {
@@ -306,7 +310,7 @@ module.exports = class Migrator {
             fs.writeFileSync(path, updatedContent);
           }
         }
-      })
+      });
     });
   }
 
@@ -323,7 +327,7 @@ module.exports = class Migrator {
     const removeOnlyEmptyDirectories = Boolean(
       templatesWithLayoutName.length + componentsImportingTemplates.length
     );
- 
+
     await removeDirs(this.appComponentTemplatesDir, removeOnlyEmptyDirectories);
     await removeDirs(this.addonComponentTemplatesDir, removeOnlyEmptyDirectories);
   }
@@ -333,28 +337,29 @@ module.exports = class Migrator {
     const componentsWithLayoutName = getLayoutNameTemplates(classFilePaths);
 
     let templateFilePaths = this.findComponentTemplates();
-    templateFilePaths = this.skipTemplatesUsedAsLayoutName(templateFilePaths, componentsWithLayoutName);
+    templateFilePaths = this.skipTemplatesUsedAsLayoutName(
+      templateFilePaths,
+      componentsWithLayoutName
+    );
     templateFilePaths = this.skipTemplatesUsedAsPartial(templateFilePaths);
     templateFilePaths = this.skipTemplatesUsedInMultipleBackingClasses(templateFilePaths);
 
     this.removeLayoutBinding(templateFilePaths);
 
     if (this.structure === 'flat') {
       this.changeComponentStructureToFlat(templateFilePaths);
-
     } else if (this.structure === 'nested') {
       this.changeComponentStructureToNested(templateFilePaths);
-
     }
 
     // Clean up
     await this.removeEmptyClassicComponentDirectories();
   }
-}
+};
 
 /**
  * Determine whether the file path represents an app or an addon
- * @param {string} filePathFromApp 
+ * @param {string} filePathFromApp
  * @return {'app' | 'addon'}
  */
 function typeFromFilePath(filePathFromApp) {
@@ -365,4 +370,4 @@ function typeFromFilePath(filePathFromApp) {
   } else {
     throw new Error(`invalid file path: ${filePathFromApp}`);
   }
-}
+}

lib/utils/file.js

@@ -1,6 +1,6 @@
-const fse = require("fs-extra");
-const path = require("path");
-const removeDirectories = require("remove-empty-directories");
+const fse = require('fs-extra');
+const path = require('path');
+const removeDirectories = require('remove-empty-directories');
 
 function moveFile(sourceFilePath, targetFilePath) {
   let targetFileDirectory = path.dirname(targetFilePath);

lib/utils/js-parser.js

@@ -23,12 +23,12 @@ const options = {
     'dynamicImport',
     'nullishCoalescingOperator',
     'optionalChaining',
-    'decorators-legacy'
+    'decorators-legacy',
   ],
 };
 
 module.exports = {
   parse(code) {
     return babylon.parse(code, options);
   },
-};
+};