Merge pull request #2 from GavinJoyce/gj/initial

Implement initial codemod

Author: GavinJoyce

.gitignore

@@ -0,0 +1,2 @@
+/node_modules
+/tmp

REAME.md

@@ -1,3 +1,21 @@
 # ember-component-template-colocation
 
-This is a WIP codemod which aims to implement https://emberjs.github.io/rfcs/0481-component-templates-co-location.html
+This codemod will co-locate component JS and HBS as described in the [Component Templates Co-location RFC](https://emberjs.github.io/rfcs/0481-component-templates-co-location.html).
+
+### Examples
+
+ * [Travis CI](https://github.com/GavinJoyce/travis-web/pull/1)
+ * [Ghost Admin](https://github.com/GavinJoyce/Ghost-Admin/pull/1)
+
+### Usage
+
+To run the migrator on your app:
+
+```sh
+cd your/project/path
+npx github:gavinjoyce/ember-component-template-colocation-migrator
+```
+
+### Running Tests
+
+ * `npm run test`

bin/ember-component-template-colocation-migrator

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+'use strict';
+
+// Provide a title to the process in `ps`
+process.title = 'ember-component-template-colocation-migrator';
+
+let fs = require('fs');
+let Migrator = require('../lib/migrator');
+let nopt = require("nopt");
+let options = {
+  'project-root': [String]
+};
+
+let parsed = nopt(options);
+let projectRoot = parsed['project-root'] || process.cwd();
+
+let migrator = new Migrator({ projectRoot });
+
+migrator.execute().then(function() {
+  console.log('Codemod finished successfully!');
+}).catch(function(error) {
+  console.error(error.stack);
+});

lib/migrator.js

@@ -0,0 +1,34 @@
+var fse = require("fs-extra");
+var path = require('path');
+var glob = require("glob");
+
+function moveFile(sourceFilePath, targetFilePath) {
+  let targetFileDirectory = path.dirname(targetFilePath);
+  if (!fse.existsSync(targetFileDirectory)) {
+    console.info(`📁 Creating ${targetFileDirectory}`);
+    fse.mkdirSync(targetFileDirectory, { recursive: true })
+  }
+
+  console.info(`👍 Moving ${sourceFilePath} -> ${targetFilePath}`);
+  fse.renameSync(sourceFilePath, targetFilePath);
+}
+
+module.exports = class Migrator {
+  constructor(options) {
+    this.options = options;
+  }
+
+  async execute() {
+    let sourceComponentTemplatesPath = path.join(this.options.projectRoot, 'app/templates/components');
+    var sourceTemplateFilePaths = glob.sync(`${sourceComponentTemplatesPath}/**/*.hbs`);
+
+    sourceTemplateFilePaths.forEach(sourceTemplateFilePath => {
+      let sourceTemplatePathInApp = sourceTemplateFilePath.slice(this.options.projectRoot.length); // '/app/templates/components/nested1/nested-component.hbs'
+      let templatePath = sourceTemplatePathInApp.slice('app/templates/components/'.length); // '/nested1/nested-component.hbs'
+      let targetTemplateFilePath = path.join(this.options.projectRoot, 'app/components', templatePath); // '[APP_PATH]/app/components/nested1/nested-component.hbs'
+      moveFile(sourceTemplateFilePath, targetTemplateFilePath);
+    });
+
+    await fse.remove(sourceComponentTemplatesPath);
+  }
+}

package.json

@@ -0,0 +1,33 @@
+{
+  "name": "ember-component-template-colocation-migrator",
+  "version": "1.0.0",
+  "description": "A codemod that moves your component .hbs files to be co-located with their .js",
+  "author": "Gavin Joyce <[email protected]>",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "bin": {
+    "ember-component-template-colocation-migrator": "./bin/ember-component-template-colocation-migrator"
+  },
+  "scripts": {
+    "test": "mocha test/*-test.js test/**/*-test.js"
+  },
+  "devDependencies": {
+    "assert-diff": "^2.0.3",
+    "fixturify": "^1.0.1",
+    "mocha": "^6.1.1",
+    "power-assert": "^1.3.1"
+  },
+  "dependencies": {
+    "fs-extra": "^7.0.1",
+    "glob": "^7.1.4",
+    "nopt": "^4.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/GavinJoyce/ember-component-template-colocation-migrator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/GavinJoyce/ember-component-template-colocation-migrator/issues"
+  },
+  "homepage": "https://github.com/GavinJoyce/ember-component-template-colocation-migrator#readme"
+}

test/fixtures/classic-app/input.js

@@ -0,0 +1,26 @@
+module.exports = {
+  app: {
+    'app.js': '// app',
+    components: {
+      'top-level-component.js': '// top-level-component.js',
+      nested1: {
+        'nested-component.js': '// nested1/nested-component.js',
+        nested2: {
+          'super-nested-component.js': '// nested1/nested2/super-nested-component.js',
+        }
+      }
+    },
+    templates: {
+      'application.hbs': '{{outlet}}',
+      components: {
+        'top-level-component.hbs': '{{!-- top-level-component.hbs --}}',
+        nested1: {
+          'nested-component.hbs': '{{!-- nested1/nested-component.hbs --}}',
+          nested2: {
+            'super-nested-component.hbs': '{{!-- nested1/nested2/super-nested-component.hbs --}}'
+          }
+        }
+      }
+    }
+  },
+};

test/fixtures/classic-app/output.js

@@ -0,0 +1,20 @@
+module.exports = {
+  app: {
+    'app.js': '// app',
+    components: {
+      'top-level-component.hbs': '{{!-- top-level-component.hbs --}}',
+      'top-level-component.js': '// top-level-component.js',
+      nested1: {
+        'nested-component.hbs': '{{!-- nested1/nested-component.hbs --}}',
+        'nested-component.js': '// nested1/nested-component.js',
+        nested2: {
+          'super-nested-component.hbs': '{{!-- nested1/nested2/super-nested-component.hbs --}}',
+          'super-nested-component.js': '// nested1/nested2/super-nested-component.js'
+        }
+      }
+    },
+    templates: {
+      'application.hbs': '{{outlet}}',
+    }
+  },
+};

test/migrator-test.js

@@ -0,0 +1,56 @@
+// inspired by https://github.com/ember-codemods/ember-module-migrator/blob/master/test/engines/classic-test.js
+
+var path = require("path");
+var assert = require("power-assert");
+var assertDiff = require('assert-diff');
+var fixturify = require("fixturify");
+var fse = require("fs-extra");
+var Migrator = require('../lib/migrator');
+
+assertDiff.options.strict = true;
+
+describe("Migrator", function() {
+  var tmpPath = "tmp/process-files";
+  var fixturesPath = path.resolve(__dirname, "fixtures");
+
+  beforeEach(function() {
+    fse.mkdirsSync(tmpPath);
+  });
+
+  afterEach(function() {
+    fse.removeSync(tmpPath);
+  });
+
+  var entries = fse.readdirSync(fixturesPath);
+
+  entries.forEach(async function(entry) {
+    it(`should migrate ${entry} fixture properly`, async function() {
+      var fixturePath = path.join(fixturesPath, entry);
+      var input = require(fixturePath + "/input");
+      var expected = require(fixturePath + "/output");
+      var migratorConfig = {};
+      try {
+        migratorConfig = require(fixturePath + "/config");
+      } catch (e) {
+        // fixture uses default config...
+      }
+
+      fixturify.writeSync(tmpPath, input);
+
+      var migratorOptions = Object.assign(
+        { projectRoot: tmpPath },
+        migratorConfig
+      );
+
+      var migrator = new Migrator(migratorOptions);
+      await migrator.execute();
+
+      var actual = fixturify.readSync(tmpPath);
+      assertDiff.deepEqual(actual, expected, "the codemod should work as expected");
+
+      await migrator.execute();
+      assertDiff.deepEqual(actual, expected, "the codemod should be idempotent");
+    });
+  });
+});
+