eslint-plugin-workspaces - npm Package Compare versions

Comparing version 0.7.0 to 0.8.0-rc1

CHANGELOG.md

@@ -0,1 +1,13 @@
+## [v0.7.0] - 2021-10-08
+
+- Fixed a bug where imports were incorrectly flagged as relative imports ([#11](https://github.com/joshuajaco/eslint-plugin-workspaces/issues/11))
+- It is no longer necessary to add the plugin when also extending one of the presets:
+
+```patch
+{
+-  "plugins": ["workspaces"],
+  "extends": ["plugin:workspaces/recommended"]
+}
+```
+
 ## [v0.6.2] - 2020-10-16
@@ -14,4 +26,5 @@
 
+[v0.7.0]: https://github.com/joshuajaco/eslint-plugin-workspaces/compare/v0.6.2...v0.7.0
 [v0.6.2]: https://github.com/joshuajaco/eslint-plugin-workspaces/compare/v0.6.1...v0.6.2
 [v0.6.1]: https://github.com/joshuajaco/eslint-plugin-workspaces/compare/v0.6.0...v0.6.1
 [v0.6.0]: https://github.com/joshuajaco/eslint-plugin-workspaces/compare/v0.5.5...v0.6.0

lib/rules/no-absolute-imports.js

 'use strict';
 
 const { dirname, relative } = require('path');
-const { isSubPath, packages, getImport, pathToImport } = require('../utils');
+const { findWorkspaces } = require('find-workspaces');
+const { isSubPath, getImport, pathToImport } = require('../utils');
 
@@ -21,6 +22,8 @@ module.exports.meta = {
 
-module.exports.create = (context) =>
-  getImport(context, ({ node, path, start, end }) => {
-    packages.forEach(({ name, location }) => {
-      if (isSubPath(location, context.getFilename()) && isSubPath(name, path)) {
+module.exports.create = (context) => {
+  const filename = context.getFilename();
+  const workspaces = findWorkspaces(filename);
+  return getImport(workspaces, filename, ({ node, path, start, end }) => {
+    workspaces.forEach(({ package: { name }, location }) => {
+      if (isSubPath(location, filename) && isSubPath(name, path)) {
         context.report({
@@ -33,6 +36,3 @@ node,
               pathToImport(
-                relative(
-                  dirname(context.getFilename()),
-                  path.replace(name, location),
-                ),
+                relative(dirname(filename), path.replace(name, location)),
               ),
@@ -44,1 +44,2 @@ ),
   });
+};

lib/rules/no-cross-imports.js

 'use strict';
 
-const { isSubPath, packages, getImport } = require('../utils');
+const { findWorkspaces } = require('find-workspaces');
+const { isSubPath, getImport } = require('../utils');
 
@@ -69,26 +70,37 @@ module.exports.meta = {
 
-  const forbidden = packages.filter(({ name }) => !allowed.includes(name));
+  const filename = context.getFilename();
+  const workspaces = findWorkspaces(filename);
 
-  return getImport(context, ({ node, value, path, currentPackage }) => {
-    forbidden
-      .filter(
-        filterSharedPackagesInCurrentScope(
-          currentPackage,
-          scopedEnabled,
-          scopedSharingFolderName,
-        ),
-      )
-      .forEach(({ name, location }) => {
-        if (
-          name !== currentPackage.name &&
-          (isSubPath(name, value) || isSubPath(location, path))
-        ) {
-          context.report({
-            node,
-            messageId: 'noCrossImports',
-            data: { name },
-          });
-        }
-      });
-  });
+  if (!workspaces) return {};
+
+  const forbidden = workspaces.filter(
+    ({ package: { name } }) => !allowed.includes(name),
+  );
+
+  return getImport(
+    workspaces,
+    filename,
+    ({ node, value, path, currentWorkspace }) => {
+      forbidden
+        .filter(
+          filterSharedPackagesInCurrentScope(
+            currentWorkspace,
+            scopedEnabled,
+            scopedSharingFolderName,
+          ),
+        )
+        .forEach(({ package: { name }, location }) => {
+          if (
+            name !== currentWorkspace.package.name &&
+            (isSubPath(name, value) || isSubPath(location, path))
+          ) {
+            context.report({
+              node,
+              messageId: 'noCrossImports',
+              data: { name },
+            });
+          }
+        });
+    },
+  );
 };

lib/rules/no-relative-imports.js

 'use strict';
 
-const { isSubPath, packages, getImport } = require('../utils');
+const { findWorkspaces } = require('find-workspaces');
+const { isSubPath, getImport } = require('../utils');
 
@@ -19,21 +20,28 @@ module.exports.meta = {
 
-module.exports.create = (context) =>
-  getImport(context, ({ node, path, start, end, currentPackage }) => {
-    packages.forEach(({ name, location }) => {
-      if (
-        name !== path &&
-        name !== currentPackage.name &&
-        isSubPath(location, path)
-      ) {
-        context.report({
-          node,
-          messageId: 'noRelativeImports',
-          fix: (fixer) =>
-            fixer.replaceTextRange(
-              [start + 1, end - 1],
-              path.replace(location, name),
-            ),
-        });
-      }
-    });
-  });
+module.exports.create = (context) => {
+  const filename = context.getFilename();
+  const workspaces = findWorkspaces(filename);
+  return getImport(
+    workspaces,
+    filename,
+    ({ node, path, start, end, currentWorkspace }) => {
+      workspaces.forEach(({ package: { name }, location }) => {
+        if (
+          name !== path &&
+          name !== currentWorkspace.package.name &&
+          isSubPath(location, path)
+        ) {
+          context.report({
+            node,
+            messageId: 'noRelativeImports',
+            fix: (fixer) =>
+              fixer.replaceTextRange(
+                [start + 1, end - 1],
+                path.replace(location, name),
+              ),
+          });
+        }
+      });
+    },
+  );
+};

lib/rules/require-dependency.js

 'use strict';
 
-const { isSubPath, packages, getImport } = require('../utils');
+const { findWorkspaces } = require('find-workspaces');
+const { isSubPath, getImport } = require('../utils');
 
@@ -19,19 +20,27 @@ module.exports.meta = {
 
-module.exports.create = (context) =>
-  getImport(context, ({ node, value, path, currentPackage }) => {
-    packages.forEach(({ name, location }) => {
-      const { dependencies, devDependencies } = currentPackage;
+module.exports.create = (context) => {
+  const filename = context.getFilename();
+  const workspaces = findWorkspaces(filename);
+  return getImport(
+    workspaces,
+    filename,
+    ({ node, value, path, currentWorkspace }) => {
+      workspaces.forEach(({ package: { name }, location }) => {
+        const { dependencies = {}, devDependencies = {} } =
+          currentWorkspace.package;
 
-      if (
-        name !== currentPackage.name &&
-        (isSubPath(name, value) || isSubPath(location, path)) &&
-        !Object.keys(dependencies).includes(name) &&
-        !Object.keys(devDependencies).includes(name)
-      ) {
-        context.report({
-          node,
-          messageId: 'requireDependency',
-        });
-      }
-    });
-  });
+        if (
+          name !== currentWorkspace.package.name &&
+          (isSubPath(name, value) || isSubPath(location, path)) &&
+          !Object.keys(dependencies).includes(name) &&
+          !Object.keys(devDependencies).includes(name)
+        ) {
+          context.report({
+            node,
+            messageId: 'requireDependency',
+          });
+        }
+      });
+    },
+  );
+};

lib/utils.js

 'use strict';
 
-const getPackages = require('@joshuajaco/get-monorepo-packages');
-const fs = require('fs');
-const {
-  dirname,
-  join,
-  relative,
-  sep,
-  normalize,
-  isAbsolute,
-  resolve,
-} = require('path');
+const { dirname, join, relative, sep, normalize, isAbsolute } = require('path');
 
@@ -20,42 +10,2 @@ const isSubPath = (parent, path) => {
 
-const directoryContainsRootPackageJson = (path) => {
-  const pathToCheck = resolve(path, 'package.json');
-  if (!fs.existsSync(pathToCheck)) return false;
-  const pkg = require(pathToCheck);
-  if (pkg && {}.hasOwnProperty.call(pkg, 'workspaces')) {
-    return true;
-  }
-  return false;
-};
-
-const getRepositoryRoot = (path = process.cwd()) => {
-  let pathForCheck = path;
-
-  if (directoryContainsRootPackageJson(pathForCheck)) {
-    return pathForCheck;
-  }
-
-  while (pathForCheck !== resolve(pathForCheck, '..')) {
-    pathForCheck = resolve(pathForCheck, '..');
-
-    if (directoryContainsRootPackageJson(pathForCheck)) {
-      return pathForCheck;
-    }
-  }
-
-  return path;
-};
-
-const packages = getPackages(getRepositoryRoot()).map(
-  ({
-    package: { name, dependencies = {}, devDependencies = {} },
-    location,
-  }) => ({
-    name,
-    location,
-    dependencies,
-    devDependencies,
-  }),
-);
-
 const resolvePath = (parent, path) => {
@@ -67,6 +17,6 @@ if (path[0] !== '.') return path;
 
-const resolveImport = (context, node, { value, range }, currentPackage) => {
-  const path = resolvePath(dirname(context.getFilename()), value);
+const resolveImport = (filename, node, { value, range }, currentWorkspace) => {
+  const path = resolvePath(dirname(filename), value);
   const [start, end] = range;
-  return { node, value, path, start, end, currentPackage };
+  return { node, value, path, start, end, currentWorkspace };
 };
@@ -84,13 +34,14 @@
 
-const findCurrentPackage = (context) =>
-  packages.find(({ location }) => isSubPath(location, context.getFilename()));
+const getImport = (workspaces, filename, callback) => {
+  if (!workspaces) return {};
 
-const getImport = (context, callback) => {
-  const currentPackage = findCurrentPackage(context);
+  const currentWorkspace = workspaces.find(({ location }) =>
+    isSubPath(location, filename),
+  );
 
-  if (!currentPackage) return {};
+  if (!currentWorkspace) return {};
 
   return {
     ImportDeclaration: (node) => {
-      callback(resolveImport(context, node, node.source, currentPackage));
+      callback(resolveImport(filename, node, node.source, currentWorkspace));
     },
@@ -105,3 +56,3 @@ CallExpression: (node) => {
         callback(
-          resolveImport(context, node, node.arguments[0], currentPackage),
+          resolveImport(filename, node, node.arguments[0], currentWorkspace),
         );
@@ -112,3 +63,3 @@ }
       if (node.source.type === 'Literal') {
-        callback(resolveImport(context, node, node.source, currentPackage));
+        callback(resolveImport(filename, node, node.source, currentWorkspace));
       }
@@ -121,6 +72,4 @@ },
   isSubPath,
-  packages,
   getImport,
   pathToImport,
-  getRepositoryRoot,
 };

package.json

 {
   "name": "eslint-plugin-workspaces",
-  "version": "0.7.0",
+  "version": "0.8.0-rc1",
   "main": "lib/index.js",
@@ -33,3 +33,3 @@ "license": "MIT",
     "format": "prettier --write \"**/*.{js,json,md,yml}\" --ignore-path .gitignore",
-    "mocha": "mocha tests --recursive --file tests/setup.js",
+    "mocha": "mocha tests --recursive",
     "test": "yarn lint && nyc yarn mocha",
@@ -41,3 +41,3 @@ "coverage": "mkdir -p coverage && touch ./coverage/lcov.info && nyc report --reporter=text-lcov > ./coverage/lcov.info",
   "dependencies": {
-    "@joshuajaco/get-monorepo-packages": "^1.2.1"
+    "find-workspaces": "^0.0.1"
   },
@@ -52,6 +52,6 @@ "devDependencies": {
     "mocha": "^9.1.2",
-    "mock-require": "^3.0.3",
     "nyc": "^15.1.0",
-    "prettier": "^2.4.1"
+    "prettier": "^2.4.1",
+    "proxyquire": "^2.1.3"
   }
 }

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

15894

1.36%

Number of low supply chain risk alerts

1

-66.67%

Worsened metrics

Lines of code

299

-5.08%

Number of medium maintenance alerts

1

Infinity%

Dependency changes

• + Added

  find-workspaces@^0.0.1

• + Added

  @nodelib/fs.scandir@2.1.5
  (transitive)

• + Added

  @nodelib/fs.stat@2.0.5
  (transitive)

• + Added

  @nodelib/fs.walk@1.2.8
  (transitive)

• + Added

  array-union@2.1.0
  (transitive)

• + Added

  braces@3.0.3
  (transitive)

• + Added

  dir-glob@3.0.1
  (transitive)

• + Added

  fast-glob@3.3.3
  (transitive)

• + Added

  fastq@1.19.1
  (transitive)

• + Added

  fill-range@7.1.1
  (transitive)

• + Added

  find-workspaces@0.0.1
  (transitive)

• + Added

  glob-parent@5.1.2
  (transitive)

• + Added

  globby@11.1.0
  (transitive)

• + Added

  ignore@5.3.2
  (transitive)

• + Added

  is-extglob@2.1.1
  (transitive)

• + Added

  is-glob@4.0.3
  (transitive)

• + Added

  is-number@7.0.0
  (transitive)

• + Added

  merge2@1.4.1
  (transitive)

• + Added

  micromatch@4.0.8
  (transitive)

• + Added

  path-type@4.0.0
  (transitive)

• + Added

  picomatch@2.3.1
  (transitive)

• + Added

  queue-microtask@1.2.3
  (transitive)

• + Added

  reusify@1.1.0
  (transitive)

• + Added

  run-parallel@1.2.0
  (transitive)

• + Added

  slash@3.0.0
  (transitive)

• + Added

  to-regex-range@5.0.1
  (transitive)

• - Removed

  @joshuajaco/get-monorepo-packages@^1.2.1

• - Removed

  @joshuajaco/get-monorepo-packages@1.2.1
  (transitive)

• - Removed

  array-union@1.0.2
  (transitive)

• - Removed

  array-uniq@1.0.3
  (transitive)

• - Removed

  balanced-match@1.0.2
  (transitive)

• - Removed

  brace-expansion@1.1.12
  (transitive)

• - Removed

  concat-map@0.0.1
  (transitive)

• - Removed

  dir-glob@2.2.2
  (transitive)

• - Removed

  error-ex@1.3.2
  (transitive)

• - Removed

  fs.realpath@1.0.0
  (transitive)

• - Removed

  glob@7.2.3
  (transitive)

• - Removed

  globby@7.1.1
  (transitive)

• - Removed

  graceful-fs@4.2.11
  (transitive)

• - Removed

  ignore@3.3.10
  (transitive)

• - Removed

  inflight@1.0.6
  (transitive)

• - Removed

  inherits@2.0.4
  (transitive)

• - Removed

  is-arrayish@0.2.1
  (transitive)

• - Removed

  json-parse-better-errors@1.0.2
  (transitive)

• - Removed

  load-json-file@4.0.0
  (transitive)

• - Removed

  minimatch@3.1.2
  (transitive)

• - Removed

  once@1.4.0
  (transitive)

• - Removed

  parse-json@4.0.0
  (transitive)

• - Removed

  path-is-absolute@1.0.1
  (transitive)

• - Removed

  path-type@3.0.0
  (transitive)

• - Removed

  pify@3.0.0
  (transitive)

• - Removed

  slash@1.0.0
  (transitive)

• - Removed

  strip-bom@3.0.0
  (transitive)

• - Removed

  wrappy@1.0.2
  (transitive)