Make 'no-relative-imports' fixable

Author: jj-ivx

lib/rules/no-cross-imports.js

@@ -1,7 +1,6 @@
 'use strict';
 
-const { isSubPath, packages, getImportValue } = require('../utils');
-const { resolve } = require('path');
+const { isSubPath, packages, getImport } = require('../utils');
 
 module.exports.meta = {
   type: 'problem',
@@ -40,12 +39,9 @@ module.exports.create = context => {
   const allowed = typeof allow === 'string' ? [allow] : allow;
   const forbidden = packages.filter(({ name }) => !allowed.includes(name));
 
-  return getImportValue(context, (value, node) => {
+  return getImport(context, ({ node, value, path }) => {
     forbidden.forEach(({ name, location }) => {
-      if (
-        isSubPath(name, value) ||
-        isSubPath(location, resolve(context.getFilename(), value))
-      ) {
+      if (isSubPath(name, value) || isSubPath(location, path)) {
         context.report({
           node,
           message: 'Import from package "{{name}}" is not allowed',

lib/rules/no-relative-imports.js

@@ -1,28 +1,32 @@
 'use strict';
 
-const { isSubPath, packages, getImportValue } = require('../utils');
-const { resolve } = require('path');
+const { isSubPath, packages, getImport } = require('../utils');
 
 module.exports.meta = {
   type: 'problem',
   docs: {
     url:
       'https://github.com/joshuajaco/eslint-plugin-workspaces/docs/rules/no-relative-imports.md',
   },
+  fixable: 'code',
 };
 
-module.exports.schema = [];
-
 module.exports.create = context =>
-  getImportValue(context, (value, node) => {
-    packages.forEach(({ location }) => {
+  getImport(context, ({ node, path, start, end }) => {
+    packages.forEach(({ name, location }) => {
       if (
         !isSubPath(location, context.getFilename()) &&
-        isSubPath(location, resolve(context.getFilename(), value))
-      )
+        isSubPath(location, path)
+      ) {
         context.report({
           node,
           message: 'Relative imports of other packages are not allowed',
+          fix: fixer =>
+            fixer.replaceTextRange(
+              [start + 1, end - 1],
+              path.replace(location, name),
+            ),
         });
+      }
     });
   });

lib/utils.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const getPackages = require('get-monorepo-packages');
-const { relative, sep, isAbsolute } = require('path');
+const { relative, sep, resolve, isAbsolute } = require('path');
 
 const isSubPath = (parent, path) => {
   const relativePath = relative(parent, path);
@@ -12,10 +12,13 @@ const packages = getPackages(process.cwd()).map(
   ({ package: { name }, location }) => ({ name, location }),
 );
 
-const getImportValue = (context, callback) => ({
+const getImport = (context, callback) => ({
   ImportDeclaration: node => {
     if (node.source.type === 'Literal') {
-      callback(node.source.value, node);
+      const { value, range } = node.source;
+      const path = resolve(context.getFilename(), value);
+      const [start, end] = range;
+      callback({ node, value, path, start, end });
     }
   },
   ExpressionStatement: node => {
@@ -26,10 +29,12 @@ const getImportValue = (context, callback) => ({
         (node.expression.callee.type === 'Identifier' &&
           node.expression.callee.name === 'require'))
     ) {
-      const { value } = node.expression.arguments[0];
-      callback(value, node);
+      const { value, range } = node.expression.arguments[0];
+      const path = resolve(context.getFilename(), value);
+      const [start, end] = range;
+      callback({ node, value, path, start, end });
     }
   },
 });
 
-module.exports = { isSubPath, packages, getImportValue };
+module.exports = { isSubPath, packages, getImport };

tests/rules/no-relative-imports.js

@@ -28,6 +28,7 @@ ruleTester.run('no-relative-imports', rule, {
     {
       code: "import workspace from '../../test/workspace';",
       filename: '/some/path',
+      output: "import workspace from '@test/workspace';",
       errors: [
         {
           message: 'Relative imports of other packages are not allowed',
@@ -37,6 +38,7 @@ ruleTester.run('no-relative-imports', rule, {
     {
       code: "require('../../test/workspace');",
       filename: '/some/path',
+      output: "require('@test/workspace');",
       errors: [
         {
           message: 'Relative imports of other packages are not allowed',
@@ -46,6 +48,7 @@ ruleTester.run('no-relative-imports', rule, {
     {
       code: "import('../../test/workspace');",
       filename: '/some/path',
+      output: "import('@test/workspace');",
       errors: [
         {
           message: 'Relative imports of other packages are not allowed',
@@ -55,6 +58,7 @@ ruleTester.run('no-relative-imports', rule, {
     {
       code: "import '../../test/workspace';",
       filename: '/some/path',
+      output: "import '@test/workspace';",
       errors: [
         {
           message: 'Relative imports of other packages are not allowed',
@@ -64,6 +68,7 @@ ruleTester.run('no-relative-imports', rule, {
     {
       code: "import workspace from '../another-workspace';",
       filename: '/test/workspace',
+      output: "import workspace from '@test/another-workspace';",
       errors: [
         {
           message: 'Relative imports of other packages are not allowed',
@@ -73,6 +78,7 @@ ruleTester.run('no-relative-imports', rule, {
     {
       code: "import workspace from '../another-workspace/testing';",
       filename: '/test/workspace',
+      output: "import workspace from '@test/another-workspace/testing';",
       errors: [
         {
           message: 'Relative imports of other packages are not allowed',