feat: Disable the no-unpublished-x rules in private packages (#57)

Windvis · web-flow · commit 5ccd0c5a55d5 · 2022-10-31T15:05:18.000+08:00
Private packages are never published so the `no-unpublished-import` and `no-unpublished-require` rules don't need to run. This also removes `"private": true` from most fixtures that would fail due to the rules no longer running. More information about private packages: https://docs.npmjs.com/cli/v8/configuring-npm/package-json#private
diff --git a/lib/util/check-publish.js b/lib/util/check-publish.js
@@ -26,6 +26,12 @@ exports.checkPublish = function checkPublish(context, filePath, targets) {
         return
     }
 
+    // Private packages are never published so we don't need to check the imported dependencies either.
+    // More information: https://docs.npmjs.com/cli/v8/configuring-npm/package-json#private
+    if (packageInfo.private === true) {
+        return
+    }
+
     const allowed = new Set(getAllowModules(context))
     const convertPath = getConvertPath(context)
     const basedir = path.dirname(packageInfo.filePath)
diff --git a/tests/fixtures/no-extraneous/dependencies/package.json b/tests/fixtures/no-extraneous/dependencies/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "dependencies": {
diff --git a/tests/fixtures/no-extraneous/devDependencies/package.json b/tests/fixtures/no-extraneous/devDependencies/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "devDependencies": {
diff --git a/tests/fixtures/no-extraneous/noDependencies/package.json b/tests/fixtures/no-extraneous/noDependencies/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0"
 }
diff --git a/tests/fixtures/no-extraneous/optionalDependencies/package.json b/tests/fixtures/no-extraneous/optionalDependencies/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "optionalDependencies": {
diff --git a/tests/fixtures/no-extraneous/peerDependencies/package.json b/tests/fixtures/no-extraneous/peerDependencies/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "peerDependencies": {
diff --git a/tests/fixtures/no-unpublished-bin/issue115/package.json b/tests/fixtures/no-unpublished-bin/issue115/package.json
@@ -1,7 +1,10 @@
 {
-    "private": true,
     "name": "test",
     "version": "1.0.0",
-    "bin": {"a": "lib/a.js"},
-    "files": ["lib/a.js"]
+    "bin": {
+        "a": "lib/a.js"
+    },
+    "files": [
+        "lib/a.js"
+    ]
 }
diff --git a/tests/fixtures/no-unpublished-bin/multi-files/package.json b/tests/fixtures/no-unpublished-bin/multi-files/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "1.0.0",
     "bin": {
@@ -9,4 +8,4 @@
     "files": [
         "lib"
     ]
-}
+}
diff --git a/tests/fixtures/no-unpublished-bin/multi-npmignore/package.json b/tests/fixtures/no-unpublished-bin/multi-npmignore/package.json
@@ -1,9 +1,8 @@
 {
-    "private": true,
     "name": "test",
     "version": "1.0.0",
     "bin": {
         "a": "a.js",
         "b": "b.js"
     }
-}
+}
diff --git a/tests/fixtures/no-unpublished-bin/simple-files/package.json b/tests/fixtures/no-unpublished-bin/simple-files/package.json
@@ -1,9 +1,8 @@
 {
-    "private": true,
     "name": "test",
     "version": "1.0.0",
     "bin": "a.js",
     "files": [
         "lib"
     ]
-}
+}
diff --git a/tests/fixtures/no-unpublished-bin/simple-npmignore/package.json b/tests/fixtures/no-unpublished-bin/simple-npmignore/package.json
@@ -1,6 +1,5 @@
 {
-    "private": true,
     "name": "test",
     "version": "1.0.0",
     "bin": "a.js"
-}
+}
diff --git a/tests/fixtures/no-unpublished-bin/simple-ok/package.json b/tests/fixtures/no-unpublished-bin/simple-ok/package.json
@@ -1,6 +1,5 @@
 {
-    "private": true,
     "name": "test",
     "version": "1.0.0",
     "bin": "a.js"
-}
+}
diff --git a/tests/fixtures/no-unpublished/1/package.json b/tests/fixtures/no-unpublished/1/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "dependencies": {
@@ -8,4 +7,4 @@
     "devDependencies": {
         "bbb": "0.0.0"
     }
-}
+}
diff --git a/tests/fixtures/no-unpublished/2/package.json b/tests/fixtures/no-unpublished/2/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "dependencies": {
@@ -8,4 +7,4 @@
     "devDependencies": {
         "bbb": "0.0.0"
     }
-}
+}
diff --git a/tests/fixtures/no-unpublished/3/package.json b/tests/fixtures/no-unpublished/3/package.json
@@ -1,12 +1,13 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
-    "files": ["pub"],
+    "files": [
+        "pub"
+    ],
     "dependencies": {
         "aaa": "0.0.0"
     },
     "devDependencies": {
         "bbb": "0.0.0"
     }
-}
+}
diff --git a/tests/fixtures/no-unpublished/issue126/package.json b/tests/fixtures/no-unpublished/issue126/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "files": [
diff --git a/tests/fixtures/no-unpublished/negative-in-files/package.json b/tests/fixtures/no-unpublished/negative-in-files/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "files": [
diff --git a/tests/fixtures/no-unpublished/private-package/package.json b/tests/fixtures/no-unpublished/private-package/package.json
@@ -0,0 +1,8 @@
+{
+    "private": true,
+    "name": "test",
+    "version": "0.0.0",
+    "devDependencies": {
+        "bbb": "0.0.0"
+    }
+}
diff --git a/tests/fixtures/no-unsupported-features--ecma/gte-0.12.8/package.json b/tests/fixtures/no-unsupported-features--ecma/gte-0.12.8/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=0.12.8"
diff --git a/tests/fixtures/no-unsupported-features--ecma/gte-4.0.0/package.json b/tests/fixtures/no-unsupported-features--ecma/gte-4.0.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=4.0.0"
diff --git a/tests/fixtures/no-unsupported-features--ecma/gte-4.4.0-lt-5.0.0/package.json b/tests/fixtures/no-unsupported-features--ecma/gte-4.4.0-lt-5.0.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=4.4.0 <5.0.0"
diff --git a/tests/fixtures/no-unsupported-features--ecma/gte-7.10.0/package.json b/tests/fixtures/no-unsupported-features--ecma/gte-7.10.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=7.10.0"
diff --git a/tests/fixtures/no-unsupported-features--ecma/gte-7.5.0/package.json b/tests/fixtures/no-unsupported-features--ecma/gte-7.5.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=7.5.0"
diff --git a/tests/fixtures/no-unsupported-features--ecma/gte-7.6.0/package.json b/tests/fixtures/no-unsupported-features--ecma/gte-7.6.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=7.6.0"
diff --git a/tests/fixtures/no-unsupported-features--ecma/hat-4.1.2/package.json b/tests/fixtures/no-unsupported-features--ecma/hat-4.1.2/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": "^4.1.2"
diff --git a/tests/fixtures/no-unsupported-features--ecma/invalid/package.json b/tests/fixtures/no-unsupported-features--ecma/invalid/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": "foo-bar"
diff --git a/tests/fixtures/no-unsupported-features--ecma/lt-6.0.0/package.json b/tests/fixtures/no-unsupported-features--ecma/lt-6.0.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": "<6.0.0"
diff --git a/tests/fixtures/no-unsupported-features--ecma/nothing/package.json b/tests/fixtures/no-unsupported-features--ecma/nothing/package.json
@@ -1,4 +1,3 @@
 {
-    "private": true,
     "name": "test"
 }
diff --git a/tests/fixtures/no-unsupported-features--ecma/star/package.json b/tests/fixtures/no-unsupported-features--ecma/star/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": "*"
diff --git a/tests/fixtures/no-unsupported-features--ecma/without-node/package.json b/tests/fixtures/no-unsupported-features--ecma/without-node/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "vscode": "foo"
diff --git a/tests/fixtures/no-unsupported-features/gte-0.12.8/package.json b/tests/fixtures/no-unsupported-features/gte-0.12.8/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=0.12.8"
diff --git a/tests/fixtures/no-unsupported-features/gte-4.0.0/package.json b/tests/fixtures/no-unsupported-features/gte-4.0.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=4.0.0"
diff --git a/tests/fixtures/no-unsupported-features/gte-4.4.0-lt-5.0.0/package.json b/tests/fixtures/no-unsupported-features/gte-4.4.0-lt-5.0.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=4.4.0 <5.0.0"
diff --git a/tests/fixtures/no-unsupported-features/gte-7.10.0/package.json b/tests/fixtures/no-unsupported-features/gte-7.10.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=7.10.0"
diff --git a/tests/fixtures/no-unsupported-features/gte-7.5.0/package.json b/tests/fixtures/no-unsupported-features/gte-7.5.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=7.5.0"
diff --git a/tests/fixtures/no-unsupported-features/gte-7.6.0/package.json b/tests/fixtures/no-unsupported-features/gte-7.6.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": ">=7.6.0"
diff --git a/tests/fixtures/no-unsupported-features/hat-4.1.2/package.json b/tests/fixtures/no-unsupported-features/hat-4.1.2/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": "^4.1.2"
diff --git a/tests/fixtures/no-unsupported-features/invalid/package.json b/tests/fixtures/no-unsupported-features/invalid/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": "foo-bar"
diff --git a/tests/fixtures/no-unsupported-features/lt-6.0.0/package.json b/tests/fixtures/no-unsupported-features/lt-6.0.0/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "node": "<6.0.0"
diff --git a/tests/fixtures/no-unsupported-features/nothing/package.json b/tests/fixtures/no-unsupported-features/nothing/package.json
@@ -1,4 +1,3 @@
 {
-    "private": true,
     "name": "test"
 }
diff --git a/tests/fixtures/no-unsupported-features/without-node/package.json b/tests/fixtures/no-unsupported-features/without-node/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "engines": {
         "vscode": "foo"
diff --git a/tests/fixtures/shebang/no-bin-field/package.json b/tests/fixtures/shebang/no-bin-field/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0"
 }
diff --git a/tests/fixtures/shebang/object-bin/package.json b/tests/fixtures/shebang/object-bin/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "bin": {
diff --git a/tests/fixtures/shebang/string-bin/package.json b/tests/fixtures/shebang/string-bin/package.json
@@ -1,5 +1,4 @@
 {
-    "private": true,
     "name": "test",
     "version": "0.0.0",
     "bin": "./bin/test.js"
diff --git a/tests/lib/rules/no-unpublished-import.js b/tests/lib/rules/no-unpublished-import.js
@@ -145,6 +145,12 @@ ruleTester.run("no-unpublished-import", rule, {
             filename: fixture("negative-in-files/lib/__test__/index.js"),
             code: "import bbb from 'bbb';",
         },
+
+        // devDependency in a private package
+        {
+            filename: fixture("private-package/index.js"),
+            code: "import bbb from 'bbb';",
+        },
     ],
     invalid: [
         {
diff --git a/tests/lib/rules/no-unpublished-require.js b/tests/lib/rules/no-unpublished-require.js
@@ -266,6 +266,13 @@ ruleTester.run("no-unpublished-require", rule, {
             code: "require('bbb');",
             env: { node: true },
         },
+
+        // devDependency in a private package
+        {
+            filename: fixture("private-package/index.js"),
+            code: "require('bbb');",
+            env: { node: true },
+        },
     ],
     invalid: [
         {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "private": true,`
`3`	`2`	`"name": "test",`
`4`	`3`	`"version": "0.0.0",`
`5`	`4`	`"dependencies": {`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,10 @@`
`1`	`1`	`{`
`2`		`- "private": true,`
`3`	`2`	`"name": "test",`
`4`	`3`	`"version": "1.0.0",`
`5`		`- "bin": {"a": "lib/a.js"},`
`6`		`- "files": ["lib/a.js"]`
	`4`	`+ "bin": {`
	`5`	`+ "a": "lib/a.js"`
	`6`	`+ },`
	`7`	`+ "files": [`
	`8`	`+ "lib/a.js"`
	`9`	`+ ]`
`7`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,8 @@`
`1`	`1`	`{`
`2`		`- "private": true,`
`3`	`2`	`"name": "test",`
`4`	`3`	`"version": "1.0.0",`
`5`	`4`	`"bin": {`
`6`	`5`	`"a": "a.js",`
`7`	`6`	`"b": "b.js"`
`8`	`7`	`}`
`9`		`-}`
	`8`	`+}`