Merge pull request #12 from patocallaghan/patoc/conservative-mode

Added `--conservative-mode` config option

Author: NullVoxPopuli

README.md

@@ -16,6 +16,12 @@ yarn global add ember-no-implicit-this-codemod
 ember-no-implicit-this-codemod <TRANSFORM NAME> 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-->

transforms/no-implicit-this/__testfixtures__/-mock-telemetry.json

@@ -23,6 +23,10 @@
     "type": "Component",
     "computedProperties": ["foo"]
   },
+  "dont-assume-this.input": {
+    "type": "Component",
+    "computedProperties": ["foo"]
+  },
   "handlebars-with-positional-params.input": {
     "type": "Component",
     "computedProperties": ["foo", "property"],

transforms/no-implicit-this/__testfixtures__/dont-assume-this.input.hbs

@@ -0,0 +1,2 @@
+{{foo}}
+{{bar}}

transforms/no-implicit-this/__testfixtures__/dont-assume-this.options.json

@@ -0,0 +1,3 @@
+{
+  "dontAssumeThis": true
+}

transforms/no-implicit-this/__testfixtures__/dont-assume-this.output.hbs

@@ -0,0 +1,2 @@
+{{this.foo}}
+{{bar}}

transforms/no-implicit-this/helpers/determine-this-usage.js

@@ -9,7 +9,7 @@ const transformPlugin = require('./plugin');
  *
  * @param {*} ast
  */
-function determineThisUsage(ast, file) {
+function determineThisUsage(ast, file, options) {
   let { path: filePath } = file;
   let runtimeData = getTelemetryFor(path.resolve(filePath));
 
@@ -18,7 +18,7 @@ function determineThisUsage(ast, file) {
     return;
   }
 
-  recast.transform(ast, env => transformPlugin(env, runtimeData));
+  recast.transform(ast, env => transformPlugin(env, runtimeData, options));
 
   return ast;
 }

transforms/no-implicit-this/helpers/plugin.js

@@ -15,7 +15,7 @@ const ARGLESS_BUILTINS = [
 /**
  * plugin entrypoint
  */
-function transformPlugin(env, runtimeData) {
+function transformPlugin(env, runtimeData, options) {
   let { builders: b } = env.syntax;
 
   let scopedParams = [];
@@ -44,7 +44,7 @@ function transformPlugin(env, runtimeData) {
       let token = ast.parts[0];
 
       if (token !== 'this') {
-        let isThisNeeded = doesTokenNeedThis(token, nonThises, runtimeData);
+        let isThisNeeded = doesTokenNeedThis(token, nonThises, runtimeData, options);
 
         if (isThisNeeded) {
           return b.path(`this.${ast.parts.join('.')}`);
@@ -64,7 +64,12 @@ function transformPlugin(env, runtimeData) {
 // - no:
 //   - is-helper: false
 //   - is-component: false
-function doesTokenNeedThis(token, { components, helpers, scopedParams }, runtimeData) {
+function doesTokenNeedThis(
+  token,
+  { components, helpers, scopedParams },
+  runtimeData,
+  { dontAssumeThis }
+) {
   if (ARGLESS_BUILTINS.includes(token)) {
     return false;
   }
@@ -98,7 +103,7 @@ function doesTokenNeedThis(token, { components, helpers, scopedParams }, runtime
     return false;
   }
 
-  return true;
+  return dontAssumeThis ? false : true;
 }
 
 function populateInvokeables() {

transforms/no-implicit-this/index.js

@@ -2,13 +2,15 @@ const path = require('path');
 
 // const { getParser } = require('codemod-cli').jscodeshift;
 const { parse: parseHbs, print: printHbs } = require('ember-template-recast');
-
 const { determineThisUsage } = require('./helpers/determine-this-usage');
-
-// const { getOptions } = require('codemod-cli');
+const { getOptions } = require('codemod-cli');
+const DEFAULT_OPTIONS = {
+  dontAssumeThis: false,
+};
 
 module.exports = function transformer(file /*, api */) {
   let extension = path.extname(file.path);
+  const options = Object.assign({}, DEFAULT_OPTIONS, getOptions());
 
   if (!['.hbs'].includes(extension.toLowerCase())) {
     // do nothing on non-hbs files
@@ -17,7 +19,7 @@ module.exports = function transformer(file /*, api */) {
 
   let root = parseHbs(file.source);
 
-  let replaced = determineThisUsage(root, file);
+  let replaced = determineThisUsage(root, file, options);
 
   if (replaced) {
     return printHbs(replaced);