feat(eslint-config): add rule es-x/no-hashbang

zanminkian · Dec 19, 2024 · a6a67fe · a6a67fe
1 parent e36c13c
commit a6a67fe
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 9 deletions.
diff --git a/.changeset/strange-seahorses-whisper.md b/.changeset/strange-seahorses-whisper.md
@@ -0,0 +1,5 @@
+---
+"@fenge/eslint-config": patch
+---
+
+feat(eslint-config): add rule `es-x/no-hashbang`
diff --git a/packages/eslint-config/src/config/js/base.ts b/packages/eslint-config/src/config/js/base.ts
@@ -355,6 +355,7 @@ export function getJsBase() {
       "es-x/no-accessor-properties": "error",
       "es-x/no-async-iteration": "error",
       "es-x/no-generators": "error",
+      "es-x/no-hashbang": "error",
       "es-x/no-legacy-object-prototype-accessor-methods": "error",
       "es-x/no-top-level-await": "error",
       // esm

diff --git a/packages/eslint-config/src/config/js/cli.ts b/packages/eslint-config/src/config/js/cli.ts
@@ -3,6 +3,7 @@ export function getJsCli() {
     name: "fenge/javascript/cli",
     files: ["**/*.cli.{js,cjs,mjs,jsx}"],
     rules: {
+      "es-x/no-hashbang": "off",
       "es-x/no-top-level-await": "off",
       "n/no-process-exit": "off",
       // "unicorn/no-process-exit": "off", // This rule can detect a file if is a cli file, so there is no need to disable it here.

diff --git a/packages/eslint-plugin-pkg-json/doc/rules/required-hashbang.md b/packages/eslint-plugin-pkg-json/doc/rules/required-hashbang.md
@@ -12,8 +12,8 @@ The bin file should starts with a hashbang
 {"bin":[]}
 {"bin":{"foo":true}}
 {"bin":"./no-existing.js"} // filename: /foo/test/required-hashbang/package.json
-{"bin":"./bad.js"} // filename: /foo/test/required-hashbang/package.json
-{"bin":{"foo":"./bad.js"}} // filename: /foo/test/required-hashbang/package.json
+{"bin":"./bad.cli.js"} // filename: /foo/test/required-hashbang/package.json
+{"bin":{"foo":"./bad.cli.js"}} // filename: /foo/test/required-hashbang/package.json
 ```
 
 ### Pass
@@ -22,7 +22,7 @@ The bin file should starts with a hashbang
 {}
 {"name":"foo"}
 {"bin":{}}
-{"bin":"./good.js"} // filename: /foo/test/required-hashbang/package.json
-{"bin":{"foo":"./good.js","bar":"./good.js"}} // filename: /foo/test/required-hashbang/package.json
+{"bin":"./good.cli.js"} // filename: /foo/test/required-hashbang/package.json
+{"bin":{"foo":"./good.cli.js","bar":"./good.cli.js"}} // filename: /foo/test/required-hashbang/package.json
 ```
 <!-- prettier-ignore-end -->
diff --git a/packages/eslint-plugin-pkg-json/src/rules/required-hashbang.spec.ts b/packages/eslint-plugin-pkg-json/src/rules/required-hashbang.spec.ts
@@ -11,11 +11,11 @@ const valid = [
   { code: s({ name: "foo" }), filename: undefined },
   { code: s({ bin: {} }), filename: undefined },
   {
-    code: s({ bin: "./good.js" }),
+    code: s({ bin: "./good.cli.js" }),
     filename: path.join(dir, "../../test/required-hashbang/package.json"),
   },
   {
-    code: s({ bin: { foo: "./good.js", bar: "./good.js" } }),
+    code: s({ bin: { foo: "./good.cli.js", bar: "./good.cli.js" } }),
     filename: path.join(dir, "../../test/required-hashbang/package.json"),
   },
 ];
@@ -29,11 +29,11 @@ const invalid = [
     filename: path.join(dir, "../../test/required-hashbang/package.json"),
   },
   {
-    code: s({ bin: "./bad.js" }),
+    code: s({ bin: "./bad.cli.js" }),
     filename: path.join(dir, "../../test/required-hashbang/package.json"),
   },
   {
-    code: s({ bin: { foo: "./bad.js" } }),
+    code: s({ bin: { foo: "./bad.cli.js" } }),
     filename: path.join(dir, "../../test/required-hashbang/package.json"),
   },
 ];

diff --git a/...in-pkg-json/test/required-hashbang/bad.js → ...kg-json/test/required-hashbang/bad.cli.js b/...in-pkg-json/test/required-hashbang/bad.js → ...kg-json/test/required-hashbang/bad.cli.js
diff --git a/...n-pkg-json/test/required-hashbang/good.js → ...g-json/test/required-hashbang/good.cli.js b/...n-pkg-json/test/required-hashbang/good.js → ...g-json/test/required-hashbang/good.cli.js
diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json
@@ -21,7 +21,7 @@
   "author": "[email protected]",
   "type": "module",
   "exports": {
-    "./cli": "./dist/cli.js",
+    "./cli": "./dist/tsconfig.cli.js",
     "./setup": "./dist/setup.js",
     "./cjs.json": "./cjs.json",
     "./esm.json": "./esm.json",

diff --git a/packages/tsconfig/src/cli.js → packages/tsconfig/src/tsconfig.cli.js b/packages/tsconfig/src/cli.js → packages/tsconfig/src/tsconfig.cli.js