added transform for removing import for htmlbars-inline-precompile and adding import for ember-cli-htmlbars

jeannettetang · jeannettetang · commit 9f46696a83a5 · 2019-10-02T22:34:06.000-05:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+!.*
+__testfixtures__
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,20 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+
+  plugins: ['prettier', 'node'],
+  extends: ['eslint:recommended', 'plugin:prettier/recommended', 'plugin:node/recommended'],
+  env: {
+    node: true,
+  },
+  rules: {},
+  overrides: [
+    {
+      files: ['__tests__/**/*.js'],
+      env: {
+        jest: true,
+      },
+    },
+  ],
+};
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 100
+}
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,24 @@
+---
+language: node_js
+node_js:
+  - "8"
+
+sudo: false
+dist: trusty
+
+cache:
+  yarn: true
+
+before_install:
+  - curl -o- -L https://yarnpkg.com/install.sh | bash
+  - export PATH=$HOME/.yarn/bin:$PATH
+
+install:
+  - yarn install
+
+script:
+  - yarn lint
+  - yarn test:coverage
+
+after_success:
+  - yarn coveralls
diff --git a/bin/cli.js b/bin/cli.js
@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+'use strict';
+
+require('codemod-cli').runTransform(
+  __dirname,
+  process.argv[2] /* transform name */,
+  process.argv.slice(3) /* paths or globs */
+);
diff --git a/package.json b/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "ember-cli-htmlbars-inline-precompile-codemod",
+  "version": "0.1.0",
+  "scripts": {
+    "lint": "eslint --cache .",
+    "test": "codemod-cli test",
+    "test:coverage": "codemod-cli test --coverage",
+    "update-docs": "codemod-cli update-docs",
+    "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls"
+  },
+  "bin": "./bin/cli.js",
+  "keywords": [
+    "codemod-cli"
+  ],
+  "dependencies": {
+    "codemod-cli": "^2.1.0"
+  },
+  "devDependencies": {
+    "coveralls": "^3.0.6",
+    "eslint": "^6.4.0",
+    "eslint-config-prettier": "^6.3.0",
+    "eslint-plugin-node": "^10.0.0",
+    "eslint-plugin-prettier": "^3.1.1",
+    "jest": "^24.9.0",
+    "prettier": "^1.18.2"
+  },
+  "engines": {
+    "node": "8.* || 10.* || >= 12"
+  },
+  "jest": {
+    "testEnvironment": "node"
+  }
+}
diff --git a/transforms/.gitkeep b/transforms/.gitkeep
diff --git a/transforms/main/README.md b/transforms/main/README.md
@@ -0,0 +1,21 @@
+# main
+
+
+## Usage
+
+```
+npx ember-cli-htmlbars-inline-precompile-codemod main path/of/files/ or/some**/*glob.js
+
+# or
+
+yarn global add ember-cli-htmlbars-inline-precompile-codemod
+ember-cli-htmlbars-inline-precompile-codemod main path/of/files/ or/some**/*glob.js
+```
+
+## Input / Output
+
+<!--FIXTURES_TOC_START-->
+<!--FIXTURES_TOC_END-->
+
+<!--FIXTURES_CONTENT_START-->
+<!--FIXTURES_CONTENT_END-->
diff --git a/transforms/main/__testfixtures__/basic.input.js b/transforms/main/__testfixtures__/basic.input.js
@@ -0,0 +1 @@
+import hbs from 'htmlbars-inline-precompile';
diff --git a/transforms/main/__testfixtures__/basic.output.js b/transforms/main/__testfixtures__/basic.output.js
@@ -0,0 +1 @@
+import { hbs } from 'ember-cli-htmlbars';
diff --git a/transforms/main/index.js b/transforms/main/index.js
@@ -0,0 +1,14 @@
+const { getParser } = require('codemod-cli').jscodeshift;
+const { addImportStatement, writeImportStatements } = require('../utils');
+// const { getOptions } = require('codemod-cli');
+
+module.exports = function transformer(file, api) {
+  const j = getParser(api);
+
+  const root = j(file.source);
+
+  addImportStatement(['hbs']);
+  writeImportStatements(j, root);
+
+  return root.toSource({ quote: 'single' });
+};
diff --git a/transforms/main/test.js b/transforms/main/test.js
@@ -0,0 +1,8 @@
+'use strict';
+
+const { runTransformTest } = require('codemod-cli');
+
+runTransformTest({
+  type: 'jscodeshift',
+  name: 'main',
+});
diff --git a/transforms/utils.js b/transforms/utils.js
@@ -0,0 +1,109 @@
+// The following utils are borrowed from @simonihmig's
+// https://github.com/simonihmig/ember-test-helpers-codemod/blob/master/transforms/utils.js
+
+let _statementsToImport = new Set();
+
+/**
+ * Adds (one or more) named imports to a private import statement collection.
+ * To write the import statements to a file, use writeImportStatements.
+ *
+ * @param j
+ * @param {array} imports
+ */
+function addImportStatement(imports) {
+  imports.forEach(method => _statementsToImport.add(method));
+}
+
+/**
+ * Adds all collected named imports to an (existing or to be created) `import { namedImport } from 'htmlbars-inline-precompile';
+ * To add named imports to the collection, use addImportStatement
+ *
+ * @param j
+ * @param root
+ */
+function writeImportStatements(j, root) {
+  if (_statementsToImport.size > 0) {
+    let body = root.get().value.program.body;
+
+    const inlineImportStatement = root.find(j.ImportDeclaration, {
+      source: {
+        value: 'htmlbars-inline-precompile',
+      },
+    });
+
+    const emberCliImportStatement = root.find(j.ImportDeclaration, {
+      source: {
+        value: 'ember-cli-htmlbars',
+      },
+    });
+
+    if (inlineImportStatement.length !== 0) {
+      inlineImportStatement.remove();
+    }
+
+    if (emberCliImportStatement.length === 0) {
+      const importStatement = createImportStatement(
+        j,
+        'ember-cli-htmlbars',
+        'default',
+        Array.from(_statementsToImport)
+      );
+      body.unshift(importStatement);
+    } else {
+      let existingSpecifiers = emberCliImportStatement.get('specifiers');
+      _statementsToImport.forEach(name => {
+        if (existingSpecifiers.filter(exSp => exSp.value.imported.name === name).length === 0) {
+          existingSpecifiers.push(j.importSpecifier(j.identifier(name)));
+        }
+      });
+    }
+  }
+  _statementsToImport = new Set();
+}
+
+/**
+ * Create an ES6 module import statement
+ *
+ * @param j
+ * @param source
+ * @param imported
+ * @param local
+ * @returns {*}
+ */
+function createImportStatement(j, source, imported, local) {
+  let declaration, variable, idIdentifier, nameIdentifier;
+
+  // if no variable name, return `import 'jquery'`
+  if (!local) {
+    declaration = j.importDeclaration([], j.literal(source));
+    return declaration;
+  }
+
+  // multiple variable names indicates a destructured import
+  if (Array.isArray(local)) {
+    let variableIds = local.map(function(v) {
+      return j.importSpecifier(j.identifier(v), j.identifier(v));
+    });
+
+    declaration = j.importDeclaration(variableIds, j.literal(source));
+  } else {
+    // else returns `import $ from 'jquery'`
+    nameIdentifier = j.identifier(local); //import var name
+    variable = j.importDefaultSpecifier(nameIdentifier);
+
+    // if propName, use destructuring `import {pluck} from 'underscore'`
+    if (imported && imported !== 'default') {
+      idIdentifier = j.identifier(imported);
+      variable = j.importSpecifier(idIdentifier, nameIdentifier); // if both are same, one is dropped...
+    }
+
+    declaration = j.importDeclaration([variable], j.literal(source));
+  }
+
+  return declaration;
+}
+
+module.exports = {
+  addImportStatement,
+  writeImportStatements,
+};
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+import hbs from 'htmlbars-inline-precompile';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+import { hbs } from 'ember-cli-htmlbars';`