Improve output for no-git-* rules (#608)

* Improve output for no-git-* rules * Update dependency-audit.ts * Update dependency-audit.ts
tclindner · Mar 19, 2022 · 59dd6cb · 59dd6cb
1 parent 85a8424
commit 59dd6cb
Show file tree

Hide file tree

Showing 8 changed files with 159 additions and 66 deletions.
diff --git a/src/rules/no-git-dependencies.ts b/src/rules/no-git-dependencies.ts
@@ -1,19 +1,27 @@
 import {PackageJson} from 'type-fest';
-import {doVersContainGitRepository} from '../validators/dependency-audit';
+import {auditDependenciesForGitRepositoryVersion} from '../validators/dependency-audit';
 import {LintIssue} from '../lint-issue';
 import {RuleType} from '../types/rule-type';
 import {Severity} from '../types/severity';
 
 const lintId = 'no-git-dependencies';
 const nodeName = 'dependencies';
-const message = 'You are using dependencies from git repository. Please use dependencies from npm.';
 
 export const ruleType = RuleType.OptionalObject;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const lint = (packageJsonData: PackageJson | any, severity: Severity, config: any): LintIssue | null => {
-  if (packageJsonData.hasOwnProperty(nodeName) && doVersContainGitRepository(packageJsonData, nodeName, config)) {
-    return new LintIssue(lintId, severity, nodeName, message);
+  const auditResult = auditDependenciesForGitRepositoryVersion(packageJsonData, nodeName, config);
+
+  if (packageJsonData.hasOwnProperty(nodeName) && auditResult.hasGitRepositoryVersions) {
+    return new LintIssue(
+      lintId,
+      severity,
+      nodeName,
+      `You are using ${nodeName} from git repository. Please use ${nodeName} from npm. Invalid ${nodeName} include: ${auditResult.dependenciesWithGitRepositoryVersion.join(
+        ', '
+      )}`
+    );
   }
 
   return null;

diff --git a/src/rules/no-git-devDependencies.ts b/src/rules/no-git-devDependencies.ts
@@ -1,19 +1,27 @@
 import {PackageJson} from 'type-fest';
-import {doVersContainGitRepository} from '../validators/dependency-audit';
+import {auditDependenciesForGitRepositoryVersion} from '../validators/dependency-audit';
 import {LintIssue} from '../lint-issue';
 import {RuleType} from '../types/rule-type';
 import {Severity} from '../types/severity';
 
 const lintId = 'no-git-devDependencies';
 const nodeName = 'devDependencies';
-const message = 'You are using devDependencies from git repository. Please use devDependencies from npm.';
 
 export const ruleType = RuleType.OptionalObject;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const lint = (packageJsonData: PackageJson | any, severity: Severity, config: any): LintIssue | null => {
-  if (packageJsonData.hasOwnProperty(nodeName) && doVersContainGitRepository(packageJsonData, nodeName, config)) {
-    return new LintIssue(lintId, severity, nodeName, message);
+  const auditResult = auditDependenciesForGitRepositoryVersion(packageJsonData, nodeName, config);
+
+  if (packageJsonData.hasOwnProperty(nodeName) && auditResult.hasGitRepositoryVersions) {
+    return new LintIssue(
+      lintId,
+      severity,
+      nodeName,
+      `You are using ${nodeName} from git repository. Please use ${nodeName} from npm. Invalid devDependencies include: ${auditResult.dependenciesWithGitRepositoryVersion.join(
+        ', '
+      )}`
+    );
   }
 
   return null;

diff --git a/src/validators/dependency-audit.ts b/src/validators/dependency-audit.ts
@@ -199,10 +199,12 @@ export const doVersContainInvalidRange = (
 export interface AbsoluteVersionCheckerResult {
   onlyAbsoluteVersionDetected: boolean;
   dependenciesChecked: number;
+  dependenciesWithAbsoluteVersion: string[];
+  dependenciesWithoutAbsoluteVersion: string[];
 }
 
 /**
- * Determines whether or not all dependency versions are absolut
+ * Determines whether or not all dependency versions are absolute
  * @param {object} packageJsonData    Valid JSON
  * @param {string} nodeName           Name of a node in the package.json file
  * @param {object} config             Rule configuration
@@ -218,6 +220,8 @@ const absoluteVersionChecker = (
   const firstCharOfStr = 0;
   let onlyAbsoluteVersionDetected = true;
   let dependenciesChecked = 0;
+  const dependenciesWithAbsoluteVersion = [];
+  const dependenciesWithoutAbsoluteVersion = [];
 
   // eslint-disable-next-line no-restricted-syntax
   for (const dependencyName in packageJsonData[nodeName]) {
@@ -236,6 +240,9 @@ const absoluteVersionChecker = (
       dependencyVersion.indexOf('*') !== notFound
     ) {
       onlyAbsoluteVersionDetected = false;
+      dependenciesWithoutAbsoluteVersion.push(dependencyName);
+    } else {
+      dependenciesWithAbsoluteVersion.push(dependencyName);
     }
 
     dependenciesChecked += 1;
@@ -244,6 +251,8 @@ const absoluteVersionChecker = (
   return {
     onlyAbsoluteVersionDetected,
     dependenciesChecked,
+    dependenciesWithAbsoluteVersion,
+    dependenciesWithoutAbsoluteVersion,
   };
 };
 
@@ -263,10 +272,10 @@ export const areVersionsAbsolute = (packageJsonData: PackageJson | any, nodeName
 
 /**
  * Determines whether or not all dependency versions are absolut
- * @param {object} packageJsonData    Valid JSON
- * @param {string} nodeName           Name of a node in the package.json file
- * @param {object} config             Rule configuration
- * @return {boolean}                  False if the package has an non-absolute version. True if it is not or the node is missing.
+ * @param packageJsonData Valid JSON
+ * @param nodeName Name of a node in the package.json file
+ * @param config Rule configuration
+ * @return False if the package has an non-absolute version. True if it is not or the node is missing.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const doVersContainNonAbsolute = (packageJsonData: PackageJson | any, nodeName: string, config: any): boolean => {
@@ -318,15 +327,30 @@ const isGitRepositoryUrl = (version: string): boolean => {
   return match;
 };
 
+export interface AuditDependenciesForGitRepositoryVersionResponse {
+  hasGitRepositoryVersions: boolean;
+  dependenciesWithGitRepositoryVersion: string[];
+  dependenciesWithoutGitRepositoryVersion: string[];
+}
+
 /**
  * Determines whether or not dependency versions are git repository
- * @param {object} packageJsonData    Valid JSON
- * @param {string} nodeName           Name of a node in the package.json file
- * @param {object} config             Rule configuration
- * @return {boolean}                  True if the package has an git repo.
+ * @param packageJsonData Valid JSON
+ * @param nodeName Name of a node in the package.json file
+ * @param config Rule configuration
+ * @return True if the package has an git repo.
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const doVersContainGitRepository = (packageJsonData: PackageJson | any, nodeName: string, config: any): boolean => {
+export const auditDependenciesForGitRepositoryVersion = (
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  packageJsonData: PackageJson | any,
+  nodeName: string,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  config: any
+): AuditDependenciesForGitRepositoryVersionResponse => {
+  let hasGitRepositoryVersions = false;
+  const dependenciesWithGitRepositoryVersion = [];
+  const dependenciesWithoutGitRepositoryVersion = [];
+
   // eslint-disable-next-line no-restricted-syntax
   for (const dependencyName in packageJsonData[nodeName]) {
     if (hasExceptions(config) && config.exceptions.includes(dependencyName)) {
@@ -337,11 +361,18 @@ export const doVersContainGitRepository = (packageJsonData: PackageJson | any, n
     const dependencyVersion = packageJsonData[nodeName][dependencyName];
 
     if (isGitRepositoryUrl(dependencyVersion) || isGithubRepositoryShortcut(dependencyVersion)) {
-      return true;
+      hasGitRepositoryVersions = true;
+      dependenciesWithGitRepositoryVersion.push(dependencyName);
+    } else {
+      dependenciesWithoutGitRepositoryVersion.push(dependencyName);
     }
   }
 
-  return false;
+  return {
+    hasGitRepositoryVersions,
+    dependenciesWithGitRepositoryVersion,
+    dependenciesWithoutGitRepositoryVersion,
+  };
 };
 
 export interface AuditDependenciesForArchiveUrlVersionResponse {

diff --git a/test/unit/rules/no-git-dependencies.test.ts b/test/unit/rules/no-git-dependencies.test.ts
@@ -22,7 +22,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -40,7 +40,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -58,7 +58,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -76,7 +76,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -94,7 +94,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -112,7 +112,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -130,7 +130,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -148,7 +148,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -166,7 +166,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -184,7 +184,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });
@@ -202,7 +202,7 @@ describe('no-git-dependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('dependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using dependencies from git repository. Please use dependencies from npm.'
+          'You are using dependencies from git repository. Please use dependencies from npm. Invalid dependencies include: my-module'
         );
       });
     });

diff --git a/test/unit/rules/no-git-devDependencies.test.ts b/test/unit/rules/no-git-devDependencies.test.ts
@@ -22,7 +22,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -40,7 +40,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -58,7 +58,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -76,7 +76,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -94,7 +94,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -112,7 +112,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -130,7 +130,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -148,7 +148,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -166,7 +166,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -184,7 +184,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });
@@ -202,7 +202,7 @@ describe('no-git-devDependencies Unit Tests', () => {
         expect(response.severity).toStrictEqual('error');
         expect(response.node).toStrictEqual('devDependencies');
         expect(response.lintMessage).toStrictEqual(
-          'You are using devDependencies from git repository. Please use devDependencies from npm.'
+          'You are using devDependencies from git repository. Please use devDependencies from npm. Invalid devDependencies include: my-module'
         );
       });
     });