add minimal docs + collect telemetry while running the codemod (#8)

NullVoxPopuli · web-flow · commit 27aad4ef2e7d · 2019-10-04T21:03:54.000-07:00
* add minimal docs

* Update bin/cli.js

Co-Authored-By: Robert Jackson &lt;me@rwjblue.com&gt;

* update, lint, etc

* re-add the logger

* add more builtins

* add all helpers

* remove console warn

* fixed everything

* Linting
diff --git a/README.md b/README.md
@@ -5,32 +5,13 @@
 [![npm](https://img.shields.io/npm/v/ember-no-implicit-this-codemod.svg?label=npm)](https://www.npmjs.com/package/ember-no-implicit-this-codemod)
 
 
-A collection of codemod's for ember-no-implicit-this-codemod.
-
 ## Usage
 
-To run a specific codemod from this project, you would run the following:
-
-```
-npx ember-no-implicit-this-codemod http://localhost:4200 path/of/files/ or/some**/*glob.hbs
-
-# or
-
-yarn global add ember-no-implicit-this-codemod
-ember-no-implicit-this-codemod http://url/of/local/dev-server path/of/files/ or/some**/*glob.js
-```
-
-The codemod accepts the following options:
-
-| Option | Value | Default | Details |
-| --- | --- | ---| --- |
-| --dont-assume-this | boolean | false | The codemod won't prepend `this.` to `PathExpressions` names which don't appear in a component's telemetry data |
-
-## Transforms
-
-<!--TRANSFORMS_START-->
-* [no-implicit-this](transforms/no-implicit-this/README.md)
-<!--TRANSFORMS_END-->
+1. Start your ember development server
+2. Run Codemod, pointing it at the address of the development server
+    ```
+    npx ember-no-implicit-this-codemod http://localhost:4200 path/of/files/ or/some**/*glob.hbs
+    ```
 
 ## Contributing
 
@@ -44,6 +25,6 @@ The codemod accepts the following options:
 
 * `yarn test`
 
-### Update Documentation
+#### Running a single test
 
-* `yarn update-docs`
+* `yarn test --runInBand --testNamePattern=void-elements`
diff --git a/bin/cli.js b/bin/cli.js
@@ -2,13 +2,11 @@
 'use strict';
 
 const { gatherTelemetryForUrl } = require('ember-codemods-telemetry-helpers');
+const appLocation = process.argv[2];
+const args = process.argv.slice(3);
 
 (async () => {
-  await gatherTelemetryForUrl(process.argv[2]);
+  await gatherTelemetryForUrl(appLocation);
 
-  require('codemod-cli').runTransform(
-    __dirname,
-    'no-implicit-this',
-    process.argv.slice(2) /* paths or globs */
-  );
+  require('codemod-cli').runTransform(__dirname, 'no-implicit-this', args, 'hbs');
 })();
diff --git a/bin/telemetry.js b/bin/telemetry.js
@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 'use strict';
 
-const { gatherTelemetry } = require('ember-codemods-telemetry-helpers');
+const { gatherTelemetryForUrl } = require('ember-codemods-telemetry-helpers');
 
-gatherTelemetry(process.argv[2]);
+gatherTelemetryForUrl(process.argv[2]);
diff --git a/package.json b/package.json
@@ -31,27 +31,27 @@
     "codemod-cli"
   ],
   "dependencies": {
-    "codemod-cli": "^1.1.0",
-    "ember-codemods-telemetry-helpers": "^0.4.0",
-    "ember-template-recast": "^3.1.3",
+    "codemod-cli": "^2.1.0",
+    "ember-codemods-telemetry-helpers": "^0.5.0",
+    "ember-template-recast": "^3.2.0",
     "fs-extra": "^8.1.0",
     "git-repo-info": "^2.1.0",
     "minimatch": "^3.0.4",
-    "puppeteer": "^1.19.0",
+    "puppeteer": "^1.20.0",
     "sync-disk-cache": "^1.3.3",
     "walk-sync": "^2.0.2",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "babel-plugin-htmlbars-inline-precompile": "^1.0.0",
+    "babel-plugin-htmlbars-inline-precompile": "^3.0.0",
     "coveralls": "^3.0.6",
-    "eslint": "^6.1.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-plugin-prettier": "^3.1.0",
-    "execa": "^2.0.4",
-    "jest": "^24.8.0",
+    "eslint": "^6.5.1",
+    "eslint-config-prettier": "^6.3.0",
+    "eslint-plugin-prettier": "^3.1.1",
+    "execa": "^2.0.5",
+    "jest": "^24.9.0",
     "prettier": "^1.18.2",
-    "release-it": "^12.3.5",
+    "release-it": "^12.4.2",
     "release-it-lerna-changelog": "^1.0.3"
   },
   "engines": {
diff --git a/transforms/no-implicit-this/__testfixtures__/-mock-telemetry.json b/transforms/no-implicit-this/__testfixtures__/-mock-telemetry.json
@@ -4,60 +4,52 @@
   "block-component": { "type": "Component" },
   "foo": { "type": "Component" },
   "namespace/foo": { "type": "Component" },
-  "built-in-helpers.input": {
+  "built-in-helpers": {
     "type": "Component",
     "computedProperties": ["foo", "records"],
     "ownActions": ["myAction"]
   },
-  "angle-brackets-with-block-params.input": {
+  "angle-brackets-with-block-params": {
     "type": "Component",
     "computedProperties": ["foo", "property", "bar"],
     "ownActions": ["myAction"]
   },
-  "angle-brackets-with-hash-params.input": {
+  "angle-brackets-with-hash-params": {
     "type": "Component",
     "computedProperties": ["foo", "property"],
     "ownActions": ["myAction"]
   },
-  "angle-brackets-without-params.input": {
+  "angle-brackets-without-params": {
     "type": "Component",
     "computedProperties": ["foo"]
   },
-  "dont-assume-this.input": {
+  "dont-assume-this": {
     "type": "Component",
     "computedProperties": ["foo"]
   },
-  "handlebars-with-positional-params.input": {
+  "handlebars-with-positional-params": {
     "type": "Component",
     "computedProperties": ["foo", "property"],
     "ownActions": ["myAction"]
   },
-  "handlebars-with-hash-params.input": {
+  "handlebars-with-hash-params": {
     "type": "Component",
     "computedProperties": ["foo", "property"],
     "ownActions": ["myAction"]
   },
-  "handlebars-with-block-params.input": {
+  "handlebars-with-block-params": {
     "type": "Component",
     "computedProperties": ["foo", "property"]
   },
-  "handlebars-without-params.input": {
+  "handlebars-without-params": {
     "type": "Component",
     "computedProperties": ["foo", "property"],
     "getters": ["someGetter"]
   },
-  "void-elements.input": {
+  "void-elements": {
     "type": "Component",
     "computedProperties": ["previewImageUrl"]
   },
   "my-helper": { "type": "Helper" },
-  "a-helper": { "type": "Helper" },
-  "link-to": { "type": "Helper" },
-  "action": { "type": "Helper" },
-  "concat": { "type": "Helper" },
-  "each": { "type": "Helper" },
-  "mut": { "type": "Helper" },
-  "let": { "type": "Helper" },
-  "if": { "type": "Helper" },
-  "fn": { "type": "Helper" }
+  "a-helper": { "type": "Helper" }
 }
diff --git a/transforms/no-implicit-this/helpers/determine-this-usage.js b/transforms/no-implicit-this/helpers/determine-this-usage.js
@@ -15,7 +15,8 @@ function determineThisUsage(ast, file, options) {
   let runtimeData = getTelemetryFor(path.resolve(filePath));
 
   if (!runtimeData) {
-    logger.warn(`[${filePath}]: SKIPPED Could not find runtime data NO_RUNTIME_DATA`);
+    let msg = `[${filePath}]: SKIPPED Could not find runtime data NO_RUNTIME_DATA`;
+    logger.warn(msg);
     return;
   }
 
diff --git a/transforms/no-implicit-this/helpers/known-helpers.js b/transforms/no-implicit-this/helpers/known-helpers.js
@@ -0,0 +1,135 @@
+const KNOWN_HELPERS = [
+  // Ember.js
+  'action',
+  'array',
+  'component',
+  'concat',
+  'debugger',
+  'each',
+  'each-in',
+  'else',
+  'fn',
+  'get',
+  'hash',
+  'has-block',
+  'hasBlock',
+  'if',
+  'if-unless',
+  'in-element',
+  '-in-element',
+  'input',
+  'textarea',
+  'let',
+  'link-to',
+  'loc',
+  'log',
+  'mut',
+  'on',
+  'outlet',
+  'partial',
+  'query-params',
+  'readonly',
+  'unbound',
+  'unless',
+  'with',
+  'yield',
+
+  // Glimmer VM
+  'identity', // glimmer blocks
+  'render-inverse', // glimmer blocks
+  '-get-dynamic-var', // glimmer internal helper
+
+  // ember-route-helpers
+  'transition-to',
+  'replace-with',
+  'transition-to-external',
+  'replace-with-external',
+
+  // ember-intl
+  'format-date',
+  'format-message',
+  'format-relative',
+  'format-time',
+  'format-money',
+  'format-number',
+  't',
+
+  // ember-moment
+  'is-after',
+  'is-before',
+  'is-between',
+  'is-same',
+  'is-same-or-after',
+  'is-same-or-before',
+  'moment',
+  'moment-calendar',
+  'moment-diff',
+  'moment-duration',
+  'moment-format',
+  'moment-from',
+  'moment-from-now',
+  'moment-to',
+  'moment-to-now',
+  'now',
+  'unix',
+
+  // ember-cp-validations
+  'v-get',
+
+  // ember-route-action-helper
+  'route-action',
+
+  // ember-composable-helpers
+  'map-by',
+  'sort-by',
+  'filter-by',
+  'reject-by',
+  'find-by',
+  'object-at',
+  'has-block',
+  'has-next',
+  'has-previous',
+  'group-by',
+  'not-eq',
+  'is-array',
+  'is-empty',
+  'is-equal',
+
+  // liquid-fire
+  'liquid-unless',
+  'liquid-container',
+  'liquid-outlet',
+  'liquid-versions',
+  'liquid-bind',
+  'liquid-spacer',
+  'liquid-sync',
+  'liquid-measured',
+  'liquid-child',
+  'liquid-if',
+
+  // ember-animated
+  'animated-beacon',
+  'animated-each',
+  'animated-if',
+  'animated-orphans',
+  'animated-value',
+
+  // ember-app-version
+  'app-version',
+
+  // ember-font-awesome
+  'fa-icon',
+  'fa-list',
+  'fa-stack',
+
+  // ember-svg-jar
+  'svg-jar',
+
+  // ember-concurrency
+  'perform',
+
+  // ember-maybe-in-element
+  'maybe-in-element',
+];
+
+module.exports = KNOWN_HELPERS;
diff --git a/transforms/no-implicit-this/helpers/plugin.js b/transforms/no-implicit-this/helpers/plugin.js
@@ -2,20 +2,12 @@ const { getTelemetry } = require('ember-codemods-telemetry-helpers');
 // everything is copy-pasteable to astexplorer.net.
 // sorta. telemetry needs to be defined.
 // telemtry can be populated with -mock-telemetry.json
-const ARGLESS_BUILTINS = [
-  'debugger',
-  'has-block',
-  'hasBlock',
-  'input',
-  'outlet',
-  'textarea',
-  'yield',
-];
+const KNOWN_HELPERS = require('./known-helpers');
 
 /**
  * plugin entrypoint
  */
-function transformPlugin(env, runtimeData, options) {
+function transformPlugin(env, runtimeData, options = {}) {
   let { builders: b } = env.syntax;
 
   let scopedParams = [];
@@ -70,7 +62,7 @@ function doesTokenNeedThis(
   runtimeData,
   { dontAssumeThis }
 ) {
-  if (ARGLESS_BUILTINS.includes(token)) {
+  if (KNOWN_HELPERS.includes(token)) {
     return false;
   }
 
diff --git a/transforms/no-implicit-this/test-helpers.js b/transforms/no-implicit-this/test-helpers.js
@@ -0,0 +1,18 @@
+const path = require('path');
+const { setTelemetry } = require('ember-codemods-telemetry-helpers');
+const mockTelemetryData = require('./__testfixtures__/-mock-telemetry.json');
+
+function setupTelemetry() {
+  let mockTelemetry = {};
+
+  Object.keys(mockTelemetryData).forEach(key => {
+    let value = mockTelemetryData[key] || {};
+    let mockPath = path.resolve(__dirname, `./__testfixtures__/${key}`);
+
+    mockTelemetry[mockPath] = value;
+  });
+
+  setTelemetry(mockTelemetry);
+}
+
+module.exports = { setupTelemetry };
diff --git a/transforms/no-implicit-this/test.js b/transforms/no-implicit-this/test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,8 @@ function determineThisUsage(ast, file, options) {`
`15`	`15`	`let runtimeData = getTelemetryFor(path.resolve(filePath));`
`16`	`16`
`17`	`17`	`if (!runtimeData) {`
`18`		- logger.warn(`[${filePath}]: SKIPPED Could not find runtime data NO_RUNTIME_DATA`);
	`18`	+ let msg = `[${filePath}]: SKIPPED Could not find runtime data NO_RUNTIME_DATA`;
	`19`	`+ logger.warn(msg);`
`19`	`20`	`return;`
`20`	`21`	`}`
`21`	`22`