Converting htmlbars import declaration from 'htmlbars-inline-preco… (#1)

Robert Jackson · web-flow · commit 4e7acafd6921 · 2019-10-10T14:12:55.000-04:00
Converting htmlbars import declaration from 'htmlbars-inline-precompile' to 'ember-cli-htmlbars'
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/README.md b/README.md
@@ -1,2 +1,40 @@
 # ember-cli-htmlbars-inline-precompile-codemod
-Codemod away from importing from htmlbars-inline-precompile to ember-cli-htmlbars.
+
+[![Build Status](https://travis-ci.com/ember-codemods/ember-cli-htmlbars-inline-precompile-codemod.svg?branch=master)](https://travis-ci.com/ember-codemods/ember-cli-htmlbars-inline-precompile-codemod)
+[![npm version](https://badge.fury.io/js/ember-cli-htmlbars-inline-precompile-codemod.svg)](https://badge.fury.io/js/ember-cli-htmlbars-inline-precompile-codemod)
+
+A collection of codemod's for ember-cli-htmlbars-inline-precompile-codemod.
+
+## Usage
+
+To run a specific codemod from this project, you would run the following:
+
+```
+npx ember-cli-htmlbars-inline-precompile-codemod path/of/files/ or/some**/*glob.js
+
+# or
+
+yarn global add ember-cli-htmlbars-inline-precompile-codemod
+ember-cli-htmlbars-inline-precompile-codemod path/of/files/ or/some**/*
+```
+
+## Transforms
+
+<!--TRANSFORMS_START-->
+* [convert-htmlbars-import](transforms/convert-htmlbars-import/README.md)
+
+## Contributing
+
+### Installation
+
+* clone the repo
+* change into the repo directory
+* `yarn`
+
+### Running tests
+
+* `yarn test`
+
+### Update Documentation
+
+* `yarn update-docs`
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,
+  'convert-htmlbars-import' /* transform name */,
+  process.argv.slice(2) /* 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/convert-htmlbars-import/README.md b/transforms/convert-htmlbars-import/README.md
@@ -0,0 +1,51 @@
+# convert-htmlbars-import
+
+
+## Usage
+
+```
+npx ember-cli-htmlbars-inline-precompile-codemod path/of/files/ or/some**/*glob.js
+
+# or
+
+yarn global add ember-cli-htmlbars-inline-precompile-codemod
+ember-cli-htmlbars-inline-precompile-codemod path/of/files/ or/some**/*
+```
+
+## Input / Output
+
+<!--FIXTURES_TOC_START-->
+* [convert-htmlbars-import](#convert-htmlbars-import)
+* [non-standard-imported-name](#non-standard-imported-name)
+<!--FIXTURES_TOC_END-->
+
+<!--FIXTURES_CONTENT_START-->
+---
+<a id="convert-htmlbars-import">**convert-htmlbars-import**</a>
+
+**Input** (<small>[convert-htmlbars-import.input.js](transforms/convert-htmlbars-import/__testfixtures__/convert-htmlbars-import.input.js)</small>):
+```js
+import hbs from 'htmlbars-inline-precompile';
+
+```
+
+**Output** (<small>[convert-htmlbars-import.output.js](transforms/convert-htmlbars-import/__testfixtures__/convert-htmlbars-import.output.js)</small>):
+```js
+import { hbs } from 'ember-cli-htmlbars';
+
+```
+---
+<a id="non-standard-imported-name">**non-standard-imported-name**</a>
+
+**Input** (<small>[non-standard-imported-name.input.js](transforms/convert-htmlbars-import/__testfixtures__/non-standard-imported-name.input.js)</small>):
+```js
+import h from 'htmlbars-inline-precompile';
+
+```
+
+**Output** (<small>[non-standard-imported-name.output.js](transforms/convert-htmlbars-import/__testfixtures__/non-standard-imported-name.output.js)</small>):
+```js
+import { hbs as h } from 'ember-cli-htmlbars';
+
+```
+<!--FIXTURES_CONTENT_END-->
diff --git a/transforms/convert-htmlbars-import/__testfixtures__/convert-htmlbars-import.input.js b/transforms/convert-htmlbars-import/__testfixtures__/convert-htmlbars-import.input.js
@@ -0,0 +1 @@
+import hbs from 'htmlbars-inline-precompile';
diff --git a/transforms/convert-htmlbars-import/__testfixtures__/convert-htmlbars-import.output.js b/transforms/convert-htmlbars-import/__testfixtures__/convert-htmlbars-import.output.js
@@ -0,0 +1 @@
+import { hbs } from 'ember-cli-htmlbars';
diff --git a/transforms/convert-htmlbars-import/__testfixtures__/non-standard-imported-name.input.js b/transforms/convert-htmlbars-import/__testfixtures__/non-standard-imported-name.input.js
@@ -0,0 +1 @@
+import h from 'htmlbars-inline-precompile';
diff --git a/transforms/convert-htmlbars-import/__testfixtures__/non-standard-imported-name.output.js b/transforms/convert-htmlbars-import/__testfixtures__/non-standard-imported-name.output.js
@@ -0,0 +1 @@
+import { hbs as h } from 'ember-cli-htmlbars';
diff --git a/transforms/convert-htmlbars-import/index.js b/transforms/convert-htmlbars-import/index.js
@@ -0,0 +1,55 @@
+const { getParser } = require('codemod-cli').jscodeshift;
+
+module.exports = function transformer(file, api) {
+  const j = getParser(api);
+  const root = j(file.source);
+
+  writeImportStatement(j, root);
+
+  return root.toSource({ quote: 'single' });
+};
+
+function writeImportStatement(j, root) {
+  let body = root.get().value.program.body;
+
+  // finding all 'htmlbars-inline-precompile' import statements
+  const inlinePrecompileImportStatement = root.find(j.ImportDeclaration, {
+    source: {
+      value: 'htmlbars-inline-precompile',
+    },
+  });
+
+  // if any imports from 'htmlbars-inline-precompile' exists, remove it and replace with a new import
+  if (inlinePrecompileImportStatement.length !== 0) {
+    // setting up import information
+    let namedIdentifier = inlinePrecompileImportStatement.find(j.Identifier).get(0).node.name;
+    if (namedIdentifier !== 'hbs') {
+      namedIdentifier = `hbs as ${namedIdentifier}`;
+    }
+    const identifier = j.identifier(namedIdentifier);
+    const variableId = j.importSpecifier(identifier);
+
+    // remove imports from 'htmlbars-inline-precompile'
+    inlinePrecompileImportStatement.remove();
+
+    // finding all 'ember-cli-htmlbars' import statements
+    const emberCliImportStatement = root.find(j.ImportDeclaration, {
+      source: {
+        value: 'ember-cli-htmlbars',
+      },
+    });
+
+    // if no imports from 'ember-cli-htmlbars' exists, write one;
+    if (emberCliImportStatement.length === 0) {
+      const importStatement = j.importDeclaration([variableId], j.literal('ember-cli-htmlbars'));
+      body.unshift(importStatement);
+    }
+    // if any imports from 'ember-cli-htmlbars' already exists, include hbs
+    else {
+      let existingSpecifiers = emberCliImportStatement.get('specifiers');
+      if (existingSpecifiers.filter(exSp => exSp.value.imported.name === 'hbs').length === 0) {
+        existingSpecifiers.push(variableId);
+      }
+    }
+  }
+}
diff --git a/transforms/convert-htmlbars-import/test.js b/transforms/convert-htmlbars-import/test.js
@@ -0,0 +1,8 @@
+'use strict';
+
+const { runTransformTest } = require('codemod-cli');
+
+runTransformTest({
+  type: 'jscodeshift',
+  name: 'convert-htmlbars-import',
+});
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';`