no-direct-import eslint rule - adding applyAutofix flag (#1183)

* no-direct-import eslint rule - adding `applyAutofix` flag to control autofix option

* bumping version to 1.1.00

* version number fix

* Update eslint-rules/package.json

Co-authored-by: Ethan Sharabi <[email protected]>

Co-authored-by: Ethan Sharabi <[email protected]>

Author: Inbal-Tish

eslint-rules/lib/rules/no-direct-import.js

@@ -2,13 +2,16 @@ const MAP_SCHEMA = {
   type: 'object',
   properties: {
     origin: {
-      type: 'string',
+      type: 'string'
     },
     destination: {
-      type: 'string',
+      type: 'string'
     },
+    applyAutofix: {
+      type: 'boolean'
+    }
   },
-  additionalProperties: false,
+  additionalProperties: false
 };
 
 module.exports = {
@@ -19,7 +22,7 @@ module.exports = {
       recommended: true,
     },
     messages: {
-      uiLib: 'Do not import directly from this source. Please use another import source (autofix available).',
+      uiLib: 'Do not import directly from this source. Please use another import source (autofix may be available).',
     },
     fixable: 'code',
     schema: [
@@ -31,12 +34,14 @@ module.exports = {
       try {
         const origin = context.options[0].origin;
         const destination = context.options[0].destination;
-        const message = `Do not import directly from '${origin}'. Please use '${destination}' (autofix available).`;
+        const applyAutofix = context.options[0].applyAutofix;
+        const autofixMessage = applyAutofix ? ' (autofix available)' : '';
+        const message = `Do not import directly from '${origin}'. Please use '${destination}'${autofixMessage}.`;
         context.report({
           node,
           message,
           fix(fixer) {
-            if (node && destination) {
+            if (node && applyAutofix && destination) {
               return fixer.replaceText(node.source, `'${destination}'`);
             }
           },

eslint-rules/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-uilib",
-  "version": "1.0.28",
+  "version": "1.0.29",
   "description": "uilib set of eslint rules",
   "keywords": [
     "eslint",

eslint-rules/tests/lib/rules/no-direct-import.js

@@ -1,11 +1,11 @@
 const RuleTester = require('eslint').RuleTester;
 const rule = require('../../../lib/rules/no-direct-import');
 
-const ruleOptions = [{ origin: 'some-module', destination: 'another-module' }];
+const ruleOptions = [{origin: 'some-module', destination: 'another-module', applyAutofix: true}];
 
 RuleTester.setDefaultConfig({
   parser: 'babel-eslint',
-  parserOptions: { ecmaVersion: 6, ecmaFeatures: { jsx: true } },
+  parserOptions: {ecmaVersion: 6, ecmaFeatures: {jsx: true}}
 });
 
 const ruleTester = new RuleTester();
@@ -17,17 +17,17 @@ ruleTester.run('no-direct-import', rule, {
   valid: [
     {
       options: ruleOptions,
-      code: validExample,
-    },
+      code: validExample
+    }
   ],
   invalid: [
     {
       options: ruleOptions,
       code: invalidExample,
       output: `import {Component} from 'another-module';`,
       errors: [
-        { message: `Do not import directly from 'some-module'. Please use 'another-module' (autofix available).` },
-      ],
-    },
-  ],
+        {message: `Do not import directly from 'some-module'. Please use 'another-module' (autofix available).`}
+      ]
+    }
+  ]
 });