feat: add --allow-dependency to ignore disallowed dependency

README.md

@@ -19,7 +19,8 @@ Core principles:
 
 ```
 usage: index.js [-h] [-v] [-t TARBALL] [-p PKGFILE] [--cache CACHE]
-                [--allow-types-dependencies] [--ignore-missing-fields]
+                [--allow-dependency DEPENDENCY] [--allow-types-dependencies]
+                [--ignore-missing-fields]
 
 Opiniated linter for NPM package tarball and package.json metadata
 
@@ -31,8 +32,11 @@ optional arguments:
   -p PKGFILE, --pkgfile PKGFILE
                         specify package.json location
   --cache CACHE         specify cache directory
+  --allow-dependency DEPENDENCY
+                        explicitly allow given dependency (can be given
+                        multiple times or as a comma-separated list)
   --allow-types-dependencies
-                        allow dependencies to `@types/*`
+                        allow production dependencies to `@types/*`
   --ignore-missing-fields
                         ignore errors for missing fields (but still checks for
                         empty and valid)
@@ -99,29 +103,7 @@ Examples of disallowed packages:
 
 By default `@types/*` is disallowed but this can be disabled with `--allow-types-dependencies`.
 
-## Obsolete dependencies
-
-Disallows certain packages from being included as `dependencies`, `devDependencies` or `peerDependencies` entirely.
-These dependencies have native replacements supported by all supported NodeJS versions.
-
-**Why?** Obsolete packages have native replacements and thus only clutter the dependency graphs thus increasing the time to install, the size on disk and produces noise with tools analyzing `package-lock.json`.
-
-Examples of obsolete packages:
-
-- `mkdirp` - `fs#mkdir` supports the `recursive` flag since NodeJS v10.
-- `stable` - `Array#sort` is stable since NodeJS v12.
-
-## Deprecated dependencies
-
-Disallows deprecated packages from being included as `dependencies`, `devDependencies` or `peerDependencies` entirely.
-These dependences are explicitly marked as deprecated by the package author.
-
-**Why?** Deprecated packages should be removed or replaced with alternatives as they are often unmaintained and might contain security vulnerabilities.
-
-Examples of obsolete packages:
-
-- `mkdirp` - `fs#mkdir` supports the `recursive` flag since NodeJS v10.
-- `stable` - `Array#sort` is stable since NodeJS v12.
+If needed, `--allow-dependency` can be used to ignore one or more dependencies.
 
 ### ESLint
 
@@ -210,6 +192,30 @@ If your `package.json` contains the `"prettier"` keyword the Prettier packages c
 }
 ```
 
+## Obsolete dependencies
+
+Disallows certain packages from being included as `dependencies`, `devDependencies` or `peerDependencies` entirely.
+These dependencies have native replacements supported by all supported NodeJS versions.
+
+**Why?** Obsolete packages have native replacements and thus only clutter the dependency graphs thus increasing the time to install, the size on disk and produces noise with tools analyzing `package-lock.json`.
+
+Examples of obsolete packages:
+
+- `mkdirp` - `fs#mkdir` supports the `recursive` flag since NodeJS v10.
+- `stable` - `Array#sort` is stable since NodeJS v12.
+
+## Deprecated dependencies
+
+Disallows deprecated packages from being included as `dependencies`, `devDependencies` or `peerDependencies` entirely.
+These dependences are explicitly marked as deprecated by the package author.
+
+**Why?** Deprecated packages should be removed or replaced with alternatives as they are often unmaintained and might contain security vulnerabilities.
+
+Examples of obsolete packages:
+
+- `mkdirp` - `fs#mkdir` supports the `recursive` flag since NodeJS v10.
+- `stable` - `Array#sort` is stable since NodeJS v12.
+
 ## Shebang
 
 Require all binaries to have UNIX-style shebang at the beginning of the file.

src/__snapshots__/package-json.spec.ts.snap

@@ -227,15 +227,3 @@ exports[`should return engines.node supports eol version 1`] = `
   },
 ]
 `;
-
-exports[`should return error if dependency is disallowed 1`] = `
-[
-  {
-    "column": 1,
-    "line": 1,
-    "message": "eslint should be a devDependency",
-    "ruleId": "disallowed-dependency",
-    "severity": 2,
-  },
-]
-`;

src/index.ts

@@ -24,6 +24,7 @@ interface ParsedArgs {
 	pkgfile: string;
 	tarball?: string;
 	ignore_missing_fields?: boolean;
+	allow_dependency: string[];
 	allow_types_dependencies?: boolean;
 }
 
@@ -99,16 +100,23 @@ async function run(): Promise<void> {
 	parser.add_argument("-t", "--tarball", { help: "specify tarball location" });
 	parser.add_argument("-p", "--pkgfile", { help: "specify package.json location" });
 	parser.add_argument("--cache", { help: "specify cache directory" });
+	parser.add_argument("--allow-dependency", {
+		action: "append",
+		default: [],
+		metavar: "DEPENDENCY",
+		help: "explicitly allow given dependency (can be given multiple times or as a comma-separated list)",
+	});
 	parser.add_argument("--allow-types-dependencies", {
 		action: "store_true",
-		help: "allow dependencies to `@types/*`",
+		help: "allow production dependencies to `@types/*`",
 	});
 	parser.add_argument("--ignore-missing-fields", {
 		action: "store_true",
 		help: "ignore errors for missing fields (but still checks for empty and valid)",
 	});
 
 	const args = parser.parse_args() as ParsedArgs;
+	const allowedDependencies = new Set(args.allow_dependency.map((it) => it.split(",")).flat());
 
 	if (args.cache) {
 		await setCacheDirecory(args.cache);
@@ -144,6 +152,7 @@ async function run(): Promise<void> {
 	setupBlacklist(pkg.name);
 
 	const options: VerifyOptions = {
+		allowedDependencies,
 		allowTypesDependencies: args.allow_types_dependencies,
 		ignoreMissingFields: args.ignore_missing_fields,
 	};

src/package-json.spec.ts

@@ -48,7 +48,38 @@ it("should return error if dependency is disallowed", async () => {
 	const results = await verifyPackageJson(pkg, "package.json");
 	expect(results).toHaveLength(1);
 	expect(results[0].filePath).toBe("package.json");
-	expect(results[0].messages).toMatchSnapshot();
+	expect(results[0].messages).toMatchInlineSnapshot(`
+		[
+		  {
+		    "column": 1,
+		    "line": 1,
+		    "message": ""eslint" should be a devDependency",
+		    "ruleId": "disallowed-dependency",
+		    "severity": 2,
+		  },
+		]
+	`);
+});
+
+it("should return error if aliased dependency is disallowed", async () => {
+	expect.assertions(3);
+	pkg.dependencies = {
+		aliased: "npm:eslint@1.2.3",
+	};
+	const results = await verifyPackageJson(pkg, "package.json");
+	expect(results).toHaveLength(1);
+	expect(results[0].filePath).toBe("package.json");
+	expect(results[0].messages).toMatchInlineSnapshot(`
+		[
+		  {
+		    "column": 1,
+		    "line": 1,
+		    "message": """aliased" ("npm:eslint")" should be a devDependency",
+		    "ruleId": "disallowed-dependency",
+		    "severity": 2,
+		  },
+		]
+	`);
 });
 
 it("should return error if dependency is obsolete", async () => {
@@ -64,7 +95,7 @@ it("should return error if dependency is obsolete", async () => {
 		  {
 		    "column": 1,
 		    "line": 1,
-		    "message": "mkdirp is obsolete and should no longer be used: use native "fs.mkdir(..., { recursive: true })" instead",
+		    "message": ""mkdirp" is obsolete and should no longer be used: use native "fs.mkdir(..., { recursive: true })" instead",
 		    "ruleId": "obsolete-dependency",
 		    "severity": 2,
 		  },
@@ -81,6 +112,18 @@ it("should not return error if dependency is allowed", async () => {
 	expect(results).toEqual([]);
 });
 
+it("should not return error if explicitly allowed by user", async () => {
+	expect.assertions(1);
+	pkg.dependencies = {
+		eslint: "1.2.3",
+		aliased: "npm:eslint@1.2.3",
+	};
+	const results = await verifyPackageJson(pkg, "package.json", {
+		allowedDependencies: new Set(["eslint"]),
+	});
+	expect(results).toHaveLength(0);
+});
+
 it("should return engines.node supports eol version", async () => {
 	expect.assertions(3);
 	pkg.engines.node = ">= 8";
@@ -105,7 +148,10 @@ describe("@types", () => {
 
 	it("should not return error if @types is allowed", async () => {
 		expect.assertions(1);
-		const results = await verifyPackageJson(pkg, "package.json", { allowTypesDependencies: true });
+		const results = await verifyPackageJson(pkg, "package.json", {
+			allowedDependencies: new Set(),
+			allowTypesDependencies: true,
+		});
 		expect(results).toHaveLength(0);
 	});
 });
@@ -121,7 +167,10 @@ describe("present", () => {
 	it("should ignore error on missing fields if ignoreMissingFields is set", async () => {
 		expect.assertions(1);
 		delete pkg.description;
-		const results = await verifyPackageJson(pkg, "package.json", { ignoreMissingFields: true });
+		const results = await verifyPackageJson(pkg, "package.json", {
+			allowedDependencies: new Set(),
+			ignoreMissingFields: true,
+		});
 		expect(results).toHaveLength(0);
 	});
 });

src/package-json.ts

@@ -19,6 +19,7 @@ import { verifyEngineConstraint } from "./rules/verify-engine-constraint";
 import { typesNodeMatchingEngine } from "./rules/types-node-matching-engine";
 
 export interface VerifyPackageJsonOptions {
+	allowedDependencies: Set<string>;
 	allowTypesDependencies?: boolean;
 	ignoreMissingFields?: boolean;
 }
@@ -74,17 +75,31 @@ function verifyDependencies(pkg: PackageJson, options: VerifyPackageJsonOptions)
 	const { dependencies = {}, devDependencies = {}, peerDependencies = {} } = pkg;
 	const allDependencies = { ...dependencies, ...devDependencies, ...peerDependencies };
 
-	for (const dependency of Object.keys(dependencies)) {
+	for (const [key, version] of Object.entries(dependencies)) {
+		let dependency = key;
+
+		/* handle npm: prefix */
+		if (version.startsWith("npm:")) {
+			const [newKey] = version.slice("npm:".length).split("@", 2);
+			dependency = newKey;
+		}
+
+		/* skip dependencies explicitly allowed by the user */
+		if (options.allowedDependencies.has(dependency)) {
+			continue;
+		}
+
 		/* skip @types/* if explicitly allowed by user */
 		if (options.allowTypesDependencies && dependency.match(/^@types\//)) {
 			continue;
 		}
 
 		if (isDisallowedDependency(pkg, dependency)) {
+			const name = key === dependency ? dependency : `"${key}" ("npm:${dependency}")`;
 			messages.push({
 				ruleId: "disallowed-dependency",
 				severity: 2,
-				message: `${dependency} should be a devDependency`,
+				message: `"${name}" should be a devDependency`,
 				line: 1,
 				column: 1,
 			});
@@ -97,7 +112,7 @@ function verifyDependencies(pkg: PackageJson, options: VerifyPackageJsonOptions)
 			messages.push({
 				ruleId: "obsolete-dependency",
 				severity: 2,
-				message: `${dependency} is obsolete and should no longer be used: ${obsolete.message}`,
+				message: `"${dependency}" is obsolete and should no longer be used: ${obsolete.message}`,
 				line: 1,
 				column: 1,
 			});
@@ -110,7 +125,7 @@ function verifyDependencies(pkg: PackageJson, options: VerifyPackageJsonOptions)
 export async function verifyPackageJson(
 	pkg: PackageJson,
 	filePath: string,
-	options: VerifyPackageJsonOptions = {},
+	options: VerifyPackageJsonOptions = { allowedDependencies: new Set() },
 ): Promise<Result[]> {
 	const messages: Message[] = [
 		...(await deprecatedDependency(pkg)),

src/verify.ts

@@ -10,7 +10,7 @@ export async function verify(
 	pkg: PackageJson,
 	pkgPath: string,
 	tarball: TarballMeta,
-	options: VerifyOptions = {},
+	options: VerifyOptions,
 ): Promise<Result[]> {
 	return [
 		...(await verifyTarball(pkg, tarball)),

tests/integration.spec.ts

@@ -25,6 +25,6 @@ it.each(fixtures)("%s", async (fixture) => {
 	const pkgPath = path.relative(ROOT_DIRECTORY, path.join(dir, "package.json"));
 	const pkg: PackageJson = JSON.parse(await fs.readFile(pkgPath, "utf-8"));
 	const tarball = { filePath: await npmPack(pkg, fixture) };
-	const result = await verify(pkg, pkgPath, tarball);
+	const result = await verify(pkg, pkgPath, tarball, { allowedDependencies: new Set() });
 	expect(result).toMatchSnapshot();
 });