npm-pkg-lint 3.2.3 → 3.3.1

package/README.md

@@ -18,9 +18,10 @@ Core principles:
 > npx npm-pkg-lint [--tarball my-pkg-1.2.3.tgz} [--pkgfile package.json]
 
 ```
-usage: npm-pkg-lint [-h] [-v] [-t TARBALL] [-p PKGFILE] [OPTIONS]
+usage: index.js [-h] [-v] [-t TARBALL] [-p PKGFILE] [--cache CACHE]
+                [--allow-types-dependencies] [--ignore-missing-fields]
 
-npm package linter
+Opiniated linter for NPM package tarball and package.json metadata
 
 optional arguments:
   -h, --help            show this help message and exit
@@ -29,6 +30,7 @@ optional arguments:
                         specify tarball location
   -p PKGFILE, --pkgfile PKGFILE
                         specify package.json location
+  --cache CACHE         specify cache directory
   --allow-types-dependencies
                         allow dependencies to `@types/*`
   --ignore-missing-fields

package/dist/index.js

@@ -12365,7 +12365,7 @@ var require_merge_stream = __commonJS({
 var import_argparse = __toESM(require_argparse(), 1);
 import { existsSync, createWriteStream as createWriteStream2, readFileSync as readFileSync2, promises as fs4 } from "fs";
 import path7 from "path";
-import { fileURLToPath as fileURLToPath3 } from "url";
+import { fileURLToPath as fileURLToPath4 } from "url";
 
 // node_modules/find-up/index.js
 import path2 from "path";
@@ -13327,14 +13327,14 @@ function validateUrl(key, value) {
   if (value !== value.trim()) {
     throw new Error(`"${key}.url" must not have leading or trailing whitespace`);
   }
-  const url2 = new URL(value);
-  if (url2.protocol === "git+http:" || url2.protocol === "http:") {
+  const url = new URL(value);
+  if (url.protocol === "git+http:" || url.protocol === "http:") {
     throw new Error(`"${key}.url" must use "git+https://" instead of "http://"`);
   }
-  if (url2.protocol !== "git+https:") {
+  if (url.protocol !== "git+https:") {
     throw new Error(`"${key}.url" must use "git+https://" protocol`);
   }
-  if (url2.host === "") {
+  if (url.host === "") {
     throw new Error(`"${key}.url" be a valid url`);
   }
 }
@@ -13407,7 +13407,7 @@ function stripFinalNewline(input) {
 // node_modules/execa/node_modules/npm-run-path/index.js
 import process3 from "process";
 import path3 from "path";
-import url from "url";
+import { fileURLToPath as fileURLToPath3 } from "url";
 
 // node_modules/execa/node_modules/path-key/index.js
 function pathKey(options = {}) {
@@ -13422,31 +13422,43 @@ function pathKey(options = {}) {
 }
 
 // node_modules/execa/node_modules/npm-run-path/index.js
-function npmRunPath(options = {}) {
-  const {
-    cwd = process3.cwd(),
-    path: path_ = process3.env[pathKey()],
-    execPath = process3.execPath
-  } = options;
-  let previous;
-  const cwdString = cwd instanceof URL ? url.fileURLToPath(cwd) : cwd;
-  let cwdPath = path3.resolve(cwdString);
+var npmRunPath = ({
+  cwd = process3.cwd(),
+  path: pathOption = process3.env[pathKey()],
+  preferLocal = true,
+  execPath = process3.execPath,
+  addExecPath = true
+} = {}) => {
+  const cwdString = cwd instanceof URL ? fileURLToPath3(cwd) : cwd;
+  const cwdPath = path3.resolve(cwdString);
   const result = [];
+  if (preferLocal) {
+    applyPreferLocal(result, cwdPath);
+  }
+  if (addExecPath) {
+    applyExecPath(result, execPath, cwdPath);
+  }
+  return [...result, pathOption].join(path3.delimiter);
+};
+var applyPreferLocal = (result, cwdPath) => {
+  let previous;
   while (previous !== cwdPath) {
     result.push(path3.join(cwdPath, "node_modules/.bin"));
     previous = cwdPath;
     cwdPath = path3.resolve(cwdPath, "..");
   }
-  result.push(path3.resolve(cwdString, execPath, ".."));
-  return [...result, path_].join(path3.delimiter);
-}
-function npmRunPathEnv({ env = process3.env, ...options } = {}) {
+};
+var applyExecPath = (result, execPath, cwdPath) => {
+  const execPathString = execPath instanceof URL ? fileURLToPath3(execPath) : execPath;
+  result.push(path3.resolve(cwdPath, execPathString, ".."));
+};
+var npmRunPathEnv = ({ env = process3.env, ...options } = {}) => {
   env = { ...env };
-  const path8 = pathKey({ env });
-  options.path = env[path8];
-  env[path8] = npmRunPath(options);
+  const pathName = pathKey({ env });
+  options.path = env[pathName];
+  env[pathName] = npmRunPath(options);
   return env;
-}
+};
 
 // node_modules/execa/node_modules/mimic-fn/index.js
 var copyProperty = (to, from, property, ignoreNonConfigurable) => {
@@ -14986,6 +14998,10 @@ function getFilePath(key) {
   const filename2 = `${hash.slice(0, 2)}/${hash.slice(2)}.json`;
   return path5.join(cacheDir, filename2);
 }
+async function setCacheDirecory(directory2) {
+  await fs3.mkdir(directory2, { recursive: true });
+  cacheDir = directory2;
+}
 async function persistentCacheGet(key) {
   if (!enabled) {
     return null;
@@ -15072,7 +15088,12 @@ var ruleId2 = "no-deprecated-dependency";
 function* getDependencies(pkg) {
   const { dependencies = {}, devDependencies = {}, peerDependencies = {} } = pkg;
   const allDependencies = { ...dependencies, ...devDependencies, ...peerDependencies };
-  for (const [key, version2] of Object.entries(allDependencies)) {
+  for (let [key, version2] of Object.entries(allDependencies)) {
+    if (version2.startsWith("npm:")) {
+      const [newKey, newVersion] = version2.slice("npm:".length).split("@", 2);
+      key = newKey;
+      version2 = newVersion;
+    }
     if (key === "@types/node") {
       continue;
     }
@@ -15293,8 +15314,8 @@ function* outdatedEngines(pkg) {
     if (!import_semver2.default.satisfies(expanded, range)) {
       continue;
     }
-    const nodeRelease = ((parsed == null ? void 0 : parsed.major) ?? 0) || `0.${(parsed == null ? void 0 : parsed.minor) ?? ""}`;
-    const message = `engines.node is satisfied by Node ${nodeRelease} (EOL since ${descriptor.eol})`;
+    const nodeRelease = ((parsed == null ? void 0 : parsed.major) ?? 0) || `0.${String((parsed == null ? void 0 : parsed.minor) ?? "")}`;
+    const message = `engines.node is satisfied by Node ${String(nodeRelease)} (EOL since ${descriptor.eol})`;
     yield {
       ruleId: ruleId4,
       severity: severity2,
@@ -15314,7 +15335,12 @@ async function* getDeepDependencies(pkg, dependency) {
   if (!pkgData) {
     return;
   }
-  for (const [key, version2] of Object.entries(pkgData.dependencies ?? {})) {
+  for (let [key, version2] of Object.entries(pkgData.dependencies ?? {})) {
+    if (version2.startsWith("npm:")) {
+      const [newKey, newVersion] = version2.slice("npm:".length).split("@", 2);
+      key = newKey;
+      version2 = newVersion;
+    }
     if (key === "@types/node") {
       continue;
     }
@@ -15408,10 +15434,12 @@ function* typesNodeMatchingEngine(pkg) {
     return;
   }
   if (typesVersion.major !== nodeVersion.major) {
+    const actualVersion = `v${String(typesVersion.major)}`;
+    const expectedVersion = `v${String(nodeVersion.major)}`;
     yield {
       ruleId: ruleId6,
       severity: severity3,
-      message: `@types/node v${typesVersion.major} does not equal engines.node v${nodeVersion.major}`,
+      message: `@types/node ${actualVersion} does not equal engines.node ${expectedVersion}`,
       line: 1,
       column: 1
     };
@@ -15567,7 +15595,7 @@ function tarballLocation(pkg, pkgPath) {
 }
 
 // src/index.ts
-var pkgFilepath = fileURLToPath3(new URL("../package.json", import.meta.url));
+var pkgFilepath = fileURLToPath4(new URL("../package.json", import.meta.url));
 var { version } = JSON.parse(readFileSync2(pkgFilepath, "utf-8"));
 var PACKAGE_JSON = "package.json";
 async function preloadStdin() {
@@ -15623,6 +15651,7 @@ async function run() {
   parser.add_argument("-v", "--version", { action: "version", version });
   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-types-dependencies", {
     action: "store_true",
     help: "allow dependencies to `@types/*`"
@@ -15632,6 +15661,9 @@ async function run() {
     help: "ignore errors for missing fields (but still checks for empty and valid)"
   });
   const args = parser.parse_args();
+  if (args.cache) {
+    await setCacheDirecory(args.cache);
+  }
   let regenerateReportName = false;
   if (args.tarball === "-") {
     args.tarball = await preloadStdin();