10836483327

Committed 12 Sep 2024 06:20PM UTC coverage: 93.14% (-0.5%) from 93.623%

Build # 10836483327

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #231 from ext/feature/proper-location

feat: show proper line and column in package.json

Run Details

178 of 198 branches covered (89.9%)

Branch coverage included in aggregate %.

85 of 92 new or added lines in 12 files covered. (92.39%)

1 existing line in 1 file now uncovered.

528 of 560 relevant lines covered (94.29%)

90.69 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

67.21

/src/rules/deprecated-dependency.ts

import { type DocumentNode } from "@humanwhocodes/momoa";
import semver from "semver";
import { type Message } from "../message";
import { type VerifyPackageJsonOptions } from "../package-json";
import { type PackageJson } from "../types";
import { jsonLocation, npmInfo } from "../utils";
import { isNpmInfoError } from "../utils/npm-info";

const ruleId = "no-deprecated-dependency";

interface Dependency {
        name: string;
        version: string;
        spec: string;
        source: "dependencies" | "devDependencies" | "peerDependencies";
}

function createEntry(
        key: string,
        version: string,
        source: Dependency["source"],
): Dependency | null {
        /* handle npm: prefix */
        if (version.startsWith("npm:")) {
                const [newKey, newVersion] = version.slice("npm:".length).split("@", 2);
                key = newKey;
                version = newVersion;
        }

        /* ignore this as this package is sometimes is present as version "*" which
         * just yields way to many versions to handle causing MaxBuffer errors and
         * there is another rule to make sure the outermost @types/node package
         * matches the configured engines */
        if (key === "@types/node") {
                return null;
        }

        const minVersion = semver.minVersion(version);
        return {
                name: key,
                version,
                spec: `${key}@${minVersion ? minVersion.version : version}`,
                source,
        };
}

function* getDependencies(pkg: PackageJson): Generator<Dependency> {
        const { dependencies = {}, devDependencies = {}, peerDependencies = {} } = pkg;
        for (const [key, version] of Object.entries(dependencies)) {
                const entry = createEntry(key, version, "dependencies");
                if (entry) {
                        yield entry;
                }
        }
        for (const [key, version] of Object.entries(devDependencies)) {
                const entry = createEntry(key, version, "devDependencies");
                if (entry) {
                        yield entry;
                }
        }
        for (const [key, version] of Object.entries(peerDependencies)) {
                const entry = createEntry(key, version, "peerDependencies");
                if (entry) {
                        yield entry;
                }
        }
}

export async function deprecatedDependency(
        pkg: PackageJson,
        pkgAst: DocumentNode,
        options: VerifyPackageJsonOptions,
): Promise<Message[]> {
        const { allowedDependencies } = options;
        const messages: Message[] = [];

        for await (const dependency of getDependencies(pkg)) {
                /* allow explicitly allowed dependencies */
                if (allowedDependencies.has(dependency.name)) {
                        continue;
                }

                try {
                        const { deprecated } = await npmInfo(dependency.spec);
                        if (!deprecated) {
                                continue;
                        }
                        const { line, column } = jsonLocation(pkgAst, "member", dependency.source, dependency.name);
                        messages.push({
                                ruleId,
                                severity: 2,
                                message: `"${dependency.spec}" is deprecated and must not be used`,
                                line,
                                column,
                        });
                } catch (err: unknown) {
                        if (isNpmInfoError(err) && err.code === "E404") {
                                if (dependency.source === "devDependencies") {
                                        continue;
                                }
                                const { line, column } = jsonLocation(pkgAst, "member", dependency.source, dependency.name);
                                messages.push({
                                        ruleId,
                                        severity: 1,
                                        message: `"${dependency.spec}" is not published to the NPM registry`,
                                        line,
                                        column,
                                });
                                continue;
                        }
                        throw err;
                }
        }

        return messages;
}

1	import { type DocumentNode } from "@humanwhocodes/momoa";
2	import semver from "semver";	2✔
3	import { type Message } from "../message";
4	import { type VerifyPackageJsonOptions } from "../package-json";
5	import { type PackageJson } from "../types";
6	import { jsonLocation, npmInfo } from "../utils";	2✔
7	import { isNpmInfoError } from "../utils/npm-info";	2✔
8
9	const ruleId = "no-deprecated-dependency";	2✔
10
11	interface Dependency {
12	name: string;
13	version: string;
14	spec: string;
15	source: "dependencies" \| "devDependencies" \| "peerDependencies";
16	}
17
18	function createEntry(
19	key: string,
20	version: string,
21	source: Dependency["source"],
22	): Dependency \| null {
23	/* handle npm: prefix */
24	if (version.startsWith("npm:")) {	8✔
25	const [newKey, newVersion] = version.slice("npm:".length).split("@", 2);	2✔
26	key = newKey;	2✔
27	version = newVersion;	2✔
28	}
29
30	/* ignore this as this package is sometimes is present as version "*" which
31	* just yields way to many versions to handle causing MaxBuffer errors and
32	* there is another rule to make sure the outermost @types/node package
33	* matches the configured engines */
34	if (key === "@types/node") {	8!
35	return null;	×
36	}
37
38	const minVersion = semver.minVersion(version);	8✔
39	return {	8✔
40	name: key,
41	version,
42	spec: `${key}@${minVersion ? minVersion.version : version}`,	8!
43	source,
44	};
45	}
46
47	function* getDependencies(pkg: PackageJson): Generator<Dependency> {
48	const { dependencies = {}, devDependencies = {}, peerDependencies = {} } = pkg;	38✔
49	for (const [key, version] of Object.entries(dependencies)) {	38✔
50	const entry = createEntry(key, version, "dependencies");	7✔
51	if (entry) {	7✔
52	yield entry;	7✔
53	}
54	}
55	for (const [key, version] of Object.entries(devDependencies)) {	38✔
56	const entry = createEntry(key, version, "devDependencies");	1✔
57	if (entry) {	1✔
58	yield entry;	1✔
59	}
60	}
61	for (const [key, version] of Object.entries(peerDependencies)) {	38✔
62	const entry = createEntry(key, version, "peerDependencies");	×
63	if (entry) {	×
64	yield entry;	×
65	}
66	}
67	}
68
69	export async function deprecatedDependency(	2✔
70	pkg: PackageJson,
71	pkgAst: DocumentNode,
72	options: VerifyPackageJsonOptions,
73	): Promise<Message[]> {
74	const { allowedDependencies } = options;	38✔
75	const messages: Message[] = [];	38✔
76
77	for await (const dependency of getDependencies(pkg)) {	38✔
78	/* allow explicitly allowed dependencies */
79	if (allowedDependencies.has(dependency.name)) {	8✔
80	continue;	2✔
81	}
82
83	try {	6✔
84	const { deprecated } = await npmInfo(dependency.spec);	6✔
85	if (!deprecated) {	6✔
86	continue;	6✔
87	}
NEW 88	const { line, column } = jsonLocation(pkgAst, "member", dependency.source, dependency.name);	×
89	messages.push({	×
90	ruleId,
91	severity: 2,
92	message: `"${dependency.spec}" is deprecated and must not be used`,
93	line,
94	column,
95	});
96	} catch (err: unknown) {
97	if (isNpmInfoError(err) && err.code === "E404") {	×
98	if (dependency.source === "devDependencies") {	×
99	continue;	×
100	}
NEW 101	const { line, column } = jsonLocation(pkgAst, "member", dependency.source, dependency.name);	×
UNCOV 102	messages.push({	×
103	ruleId,
104	severity: 1,
105	message: `"${dependency.spec}" is not published to the NPM registry`,
106	line,
107	column,
108	});
109	continue;	×
110	}
111	throw err;	×
112	}
113	}
114
115	return messages;	38✔
116	}

ext / npm-pkg-lint / 10836483327

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous