Merge pull request #50 from suchitadoshi1987/suchita/customHelpers

Add config option to support custom helpers

Author: NullVoxPopuli

transforms/no-implicit-this/__testfixtures__/-helpers.json

@@ -0,0 +1,3 @@
+{
+  "helpers": ["biz", "bang"]
+}

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

@@ -10,6 +10,7 @@
     "computedProperties": ["foo", "records"],
     "ownActions": ["myAction"]
   },
+  "custom-helpers": { "type": "Component" },
   "angle-brackets-with-block-params": {
     "type": "Component",
     "computedProperties": ["foo", "property", "bar"],

transforms/no-implicit-this/__testfixtures__/custom-helpers.input.hbs

@@ -0,0 +1,2 @@
+{{biz}}
+{{bang}}

transforms/no-implicit-this/__testfixtures__/custom-helpers.options.json

@@ -0,0 +1,3 @@
+{
+  "config": "./transforms/no-implicit-this/__testfixtures__/-helpers.json" 
+}

transforms/no-implicit-this/__testfixtures__/custom-helpers.output.hbs

@@ -0,0 +1,2 @@
+{{biz}}
+{{bang}}

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

@@ -63,9 +63,9 @@ function doesTokenNeedThis(
   token,
   { components, helpers, scopedParams },
   runtimeData,
-  { dontAssumeThis }
+  { dontAssumeThis, customHelpers }
 ) {
-  if (KNOWN_HELPERS.includes(token)) {
+  if (KNOWN_HELPERS.includes(token) || customHelpers.includes(token)) {
     return false;
   }
 

transforms/no-implicit-this/index.js

@@ -1,12 +1,46 @@
 const path = require('path');
+const fs = require('fs');
 
 const { parse: parseHbs, print: printHbs } = require('ember-template-recast');
 const { determineThisUsage } = require('./helpers/determine-this-usage');
-const { getOptions } = require('codemod-cli');
+const { getOptions: getCLIOptions } = require('codemod-cli');
 const DEFAULT_OPTIONS = {
   dontAssumeThis: false,
 };
 
+/**
+ * Accepts the config path for custom helpers and returns the array of helpers
+ * if the file path is resolved.
+ * Context: This will allow the users to specify their custom list of helpers
+ * along with the known helpers, this would give them more flexibility for handling
+ * special usecases.
+ * @param {string} configPath
+ */
+function _getCustomHelpersFromConfig(configPath) {
+  let customHelpers = [];
+  if (configPath) {
+    let filePath = path.join(process.cwd(), configPath);
+    let config = JSON.parse(fs.readFileSync(filePath));
+    if (config.helpers) {
+      customHelpers = config.helpers;
+    }
+  }
+  return customHelpers;
+}
+
+/**
+ * Returns custom options object to support the custom helpers config path passed
+ * by the user.
+ */
+function getOptions() {
+  let cliOptions = getCLIOptions();
+  let options = {
+    dontAssumeThis: cliOptions.dontAssumeThis,
+    customHelpers: _getCustomHelpersFromConfig(cliOptions.config),
+  };
+  return options;
+}
+
 module.exports = function transformer(file /*, api */) {
   let extension = path.extname(file.path);
   let options = Object.assign({}, DEFAULT_OPTIONS, getOptions());