npm-pkg-lint 1.13.0 → 1.14.0

package/README.md

@@ -60,6 +60,12 @@ Verifies the presence of files specified in:
 - `bin`
 - `man`
 
+## TypeScript `types` in `exports`
+
+Requires `types` to be the first condition in `exports`.
+
+**Why?** For TypeScript to properly detect `types` it need to come before `require` or `import`, else it will fall back to detecting by filename.
+
 ## Disallowed dependencies
 
 Disallows certain packages from being included as `dependencies` (use `devDependencies` or `peerDependencies` instead).

package/dist/index.js

@@ -9250,7 +9250,7 @@ var require_pack = __commonJS({
     };
     var MiniPass = require_minipass();
     var zlib = require_minizlib();
-    var ReadEntry2 = require_read_entry();
+    var ReadEntry = require_read_entry();
     var WriteEntry = require_write_entry();
     var WriteEntrySync = WriteEntry.Sync;
     var WriteEntryTar = WriteEntry.Tar;
@@ -9346,7 +9346,7 @@ var require_pack = __commonJS({
         if (this[ENDED]) {
           throw new Error("write after end");
         }
-        if (path8 instanceof ReadEntry2) {
+        if (path8 instanceof ReadEntry) {
           this[ADDTARENTRY](path8);
         } else {
           this[ADDFSENTRY](path8);
@@ -15892,7 +15892,7 @@ async function getFileContent(tarball, filenames) {
     rs.pipe(t);
   });
 }
-async function blacklistedFiles(filelist) {
+function blacklistedFiles(filelist) {
   return filelist.filter(isBlacklisted);
 }
 function normalizeRequiredFiles(src) {
@@ -15972,7 +15972,7 @@ function fileExists(filelist, filename2) {
 async function verifyTarball(pkg, tarball) {
   const messages = [];
   const filelist = await getFileList(tarball.filePath);
-  for (const filename2 of await blacklistedFiles(filelist)) {
+  for (const filename2 of blacklistedFiles(filelist)) {
     messages.push({
       ruleId: "no-disallowed-files",
       severity: 2,
@@ -16035,9 +16035,11 @@ function nonempty(key, value) {
     }
     return;
   }
-  const values = Object.values(value);
-  if (values.length === 0) {
-    throw new Error(`"${key}" must not be empty`);
+  if (value && typeof value === "object") {
+    const values = Object.values(value);
+    if (values.length === 0) {
+      throw new Error(`"${key}" must not be empty`);
+    }
   }
 }
 
@@ -16148,6 +16150,37 @@ function isDisallowedDependency(pkg, dependency) {
   return match(disallowedDependencies, dependency);
 }
 
+// src/rules/exports-types-order.ts
+var ruleId2 = "exports-types-order";
+var severity = Severity.ERROR;
+function* validateOrder(value, path7) {
+  if (!value || typeof value === "string") {
+    return;
+  }
+  const keys = Object.keys(value);
+  if (keys.length === 0) {
+    return;
+  }
+  if (keys.includes("types") && keys[0] !== "types") {
+    const property = path7.map((it) => `["${it}"]`).join("");
+    yield {
+      ruleId: ruleId2,
+      severity,
+      message: `"types" must be the first condition in "exports${property}"`,
+      line: 1,
+      column: 1
+    };
+  }
+  for (const key of keys) {
+    yield* validateOrder(value[key], [...path7, key]);
+  }
+}
+function* exportsTypesOrder(pkg) {
+  if (pkg.exports) {
+    yield* validateOrder(pkg.exports, []);
+  }
+}
+
 // src/rules/outdated-engines.ts
 var import_semver = __toESM(require_semver2(), 1);
 
@@ -16167,13 +16200,13 @@ var nodeVersions = [
 ];
 
 // src/rules/outdated-engines.ts
-var ruleId2 = "outdated-engines";
-var severity = Severity.ERROR;
+var ruleId3 = "outdated-engines";
+var severity2 = Severity.ERROR;
 function* outdatedEngines(pkg) {
   if (!pkg.engines || !pkg.engines.node) {
     yield {
-      ruleId: ruleId2,
-      severity,
+      ruleId: ruleId3,
+      severity: severity2,
       message: "Missing engines.node field",
       line: 1,
       column: 1
@@ -16183,8 +16216,8 @@ function* outdatedEngines(pkg) {
   const range = pkg.engines.node;
   if (!import_semver.default.validRange(range)) {
     yield {
-      ruleId: ruleId2,
-      severity,
+      ruleId: ruleId3,
+      severity: severity2,
       message: `engines.node "${range}" is not a valid semver range`,
       line: 1,
       column: 1
@@ -16200,11 +16233,11 @@ function* outdatedEngines(pkg) {
     if (!import_semver.default.satisfies(expanded, range)) {
       continue;
     }
-    const nodeRelease = (parsed == null ? void 0 : parsed.major) || `0.${parsed == null ? void 0 : parsed.minor}`;
+    const nodeRelease = (parsed == null ? void 0 : parsed.major) || `0.${(parsed == null ? void 0 : parsed.minor) ?? ""}`;
     const message = `engines.node is satisfied by Node ${nodeRelease} (EOL since ${descriptor.eol})`;
     yield {
-      ruleId: ruleId2,
-      severity,
+      ruleId: ruleId3,
+      severity: severity2,
       message,
       line: 1,
       column: 1
@@ -17356,7 +17389,7 @@ async function npmInfo(pkg) {
 }
 
 // src/rules/verify-engine-constraint.ts
-var ruleId3 = "invalid-engine-constraint";
+var ruleId4 = "invalid-engine-constraint";
 async function* getDeepDependencies(pkg, dependency) {
   const pkgData = dependency ? await npmInfo(dependency) : pkg;
   for (const [key, value] of Object.entries(pkgData.dependencies ?? {})) {
@@ -17365,7 +17398,7 @@ async function* getDeepDependencies(pkg, dependency) {
     }
     const deep = `${key}@${value}`;
     yield deep;
-    yield* await getDeepDependencies(pkg, deep);
+    yield* getDeepDependencies(pkg, deep);
   }
 }
 async function verifyEngineConstraint(pkg) {
@@ -17387,7 +17420,7 @@ async function verifyEngineConstraint(pkg) {
     }
     if (!import_semver2.default.satisfies(minDeclared, constraint)) {
       messages.push({
-        ruleId: ruleId3,
+        ruleId: ruleId4,
         severity: 2,
         message: `the transitive dependency "${dependency}" (node ${constraint}) does not satisfy the declared node engine "${declaredConstraint}"`,
         line: 1,
@@ -17400,8 +17433,8 @@ async function verifyEngineConstraint(pkg) {
 
 // src/rules/types-node-matching-engine.ts
 var import_semver3 = __toESM(require_semver2(), 1);
-var ruleId4 = "types-node-matching-engine";
-var severity2 = Severity.ERROR;
+var ruleId5 = "types-node-matching-engine";
+var severity3 = Severity.ERROR;
 function* typesNodeMatchingEngine(pkg) {
   if (!pkg.engines || !pkg.engines.node) {
     return;
@@ -17421,8 +17454,8 @@ function* typesNodeMatchingEngine(pkg) {
   }
   if (typesVersion.major !== nodeVersion.major) {
     yield {
-      ruleId: ruleId4,
-      severity: severity2,
+      ruleId: ruleId5,
+      severity: severity3,
       message: `@types/node v${typesVersion.major} does not equal engines.node v${nodeVersion.major}`,
       line: 1,
       column: 1
@@ -17487,6 +17520,7 @@ function verifyDependencies(pkg, options) {
 async function verifyPackageJson(pkg, filePath, options = {}) {
   const messages = [
     ...await verifyEngineConstraint(pkg),
+    ...exportsTypesOrder(pkg),
     ...verifyFields(pkg, options),
     ...verifyDependencies(pkg, options),
     ...outdatedEngines(pkg),
@@ -17661,7 +17695,10 @@ async function run() {
   }, 0);
   process.exitCode = totalErrors > 0 ? 1 : 0;
 }
-run();
+run().catch((err) => {
+  console.error(err);
+  process.exitCode = 1;
+});
 /*! Bundled license information:
 
 tmp/lib/tmp.js: