refactor: migrate from @git-validator/eslint-plugin-packagejson to …

…`eslint-plugin-pkg-json`
zanminkian · Sep 19, 2024 · d564959 · d564959
1 parent f23f207
commit d564959
Show file tree

Hide file tree

Showing 54 changed files with 97 additions and 201 deletions.
diff --git a/.changeset/friendly-poets-bake.md b/.changeset/friendly-poets-bake.md
@@ -0,0 +1,6 @@
+---
+"eslint-plugin-pkg-json": minor
+"@git-validator/eslint-config": minor
+---
+
+refactor: migrate from `@git-validator/eslint-plugin-packagejson` to `eslint-plugin-pkg-json`
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -26,7 +26,6 @@
   },
   "dependencies": {
     "@git-validator/eslint-plugin": "workspace:*",
-    "@git-validator/eslint-plugin-packagejson": "workspace:*",
     "@git-validator/eslint-plugin-ts": "workspace:*",
     "@typescript-eslint/eslint-plugin": "7.16.1",
     "@typescript-eslint/parser": "7.16.1",
@@ -37,6 +36,7 @@
     "eslint-plugin-fp": "2.3.0",
     "eslint-plugin-import": "2.30.0",
     "eslint-plugin-n": "17.10.3",
+    "eslint-plugin-pkg-json": "workspace:*",
     "eslint-plugin-promise": "7.1.0",
     "eslint-plugin-publint": "workspace:*",
     "eslint-plugin-react": "7.36.1",

diff --git a/packages/eslint-config/src/config/packagejson.ts b/packages/eslint-config/src/config/packagejson.ts
@@ -1,30 +1,30 @@
-import * as pkg from "@git-validator/eslint-plugin-packagejson";
+import * as pkg from "eslint-plugin-pkg-json";
 import * as publint from "eslint-plugin-publint";
 
 export function packagejson() {
   return [
     {
       name: "git-validator/packagejson",
       files: ["**/package.json"],
-      processor: "packagejson/processor",
+      processor: "pkg-json/processor",
       plugins: {
-        packagejson: pkg,
+        "pkg-json": pkg,
         publint,
       },
       rules: {
-        "packagejson/bottom-default": "error",
-        "packagejson/exact-dependency-version": "error",
-        "packagejson/no-conflict-types": "error",
-        "packagejson/no-lifecycle-script": "error",
-        "packagejson/no-nonstandard-property": "error",
-        "packagejson/no-types-dependency-in-workspace-root": "error",
-        "packagejson/top-types": "error",
-        "packagejson/private-workspace-root": "error",
-        "packagejson/required-engines": "error",
-        "packagejson/required-hashbang": "error",
-        "packagejson/required-repository": "error",
-        "packagejson/type-module": "error",
-        "packagejson/no-dependencies-in-workspace-root": "error",
+        "pkg-json/bottom-default": "error",
+        "pkg-json/exact-dependency-version": "error",
+        "pkg-json/no-conflict-types": "error",
+        "pkg-json/no-lifecycle-script": "error",
+        "pkg-json/no-nonstandard-property": "error",
+        "pkg-json/no-types-dependency-in-workspace-root": "error",
+        "pkg-json/top-types": "error",
+        "pkg-json/private-workspace-root": "error",
+        "pkg-json/required-engines": "error",
+        "pkg-json/required-hashbang": "error",
+        "pkg-json/required-repository": "error",
+        "pkg-json/type-module": "error",
+        "pkg-json/no-dependencies-in-workspace-root": "error",
         // "publint/suggestion": "error",
         "publint/warning": "error",
         "publint/error": "error",

diff --git a/packages/eslint-plugin-packagejson/CHANGELOG.md b/packages/eslint-plugin-packagejson/CHANGELOG.md
diff --git a/packages/eslint-plugin-packagejson/README.md b/packages/eslint-plugin-packagejson/README.md
diff --git a/packages/eslint-plugin-pkg-json/README.md b/packages/eslint-plugin-pkg-json/README.md
@@ -0,0 +1,67 @@
+# eslint-plugin-pkg-json
+
+[![](https://img.shields.io/npm/l/eslint-plugin-pkg-json.svg)](https://github.com/zanminkian/git-validator/blob/main/LICENSE)
+[![](https://img.shields.io/npm/v/eslint-plugin-pkg-json.svg)](https://www.npmjs.com/package/eslint-plugin-pkg-json)
+[![](https://img.shields.io/npm/dm/eslint-plugin-pkg-json.svg)](https://www.npmjs.com/package/eslint-plugin-pkg-json)
+[![](https://packagephobia.com/badge?p=eslint-plugin-pkg-json)](https://packagephobia.com/result?p=eslint-plugin-pkg-json)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://makeapullrequest.com)
+
+ESLint plugin for linting `package.json` file.
+
+## Features
+
+- Lint `package.json`s.
+- Simple. Tiny. Fast.
+- Zero dependencies.
+
+## Requirement
+
+- ESLint >= 8.57.0
+
+## Usage
+
+Install
+
+```sh
+pnpm add -D eslint eslint-plugin-pkg-json
+```
+
+Config `eslint.config.js`
+
+```js
+import * as pkg from "eslint-plugin-pkg-json";
+
+export default [
+  ...
+  {
+    files: ["**/package.json"],
+    processor: "pkg-json/processor",
+    plugins: { "pkg-json": pkg },
+    rules: {
+      "pkg-json/no-lifecycle-script": "error",
+      ...
+      // Visit https://github.com/zanminkian/git-validator/tree/main/packages/eslint-plugin-pkg-json/doc/rules for more other rules
+    },
+  },
+  ...
+];
+```
+
+Config `package.json`
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+## Rules
+
+Click [here](https://github.com/zanminkian/git-validator/tree/main/packages/eslint-plugin-pkg-json/doc/rules).
+
+## License
+
+MIT
diff --git a/...n-packagejson/doc/rules/bottom-default.md → ...ugin-pkg-json/doc/rules/bottom-default.md b/...n-packagejson/doc/rules/bottom-default.md → ...ugin-pkg-json/doc/rules/bottom-default.md
diff --git a/...son/doc/rules/exact-dependency-version.md → ...son/doc/rules/exact-dependency-version.md b/...son/doc/rules/exact-dependency-version.md → ...son/doc/rules/exact-dependency-version.md
diff --git a/...ackagejson/doc/rules/no-conflict-types.md → ...n-pkg-json/doc/rules/no-conflict-types.md b/...ackagejson/doc/rules/no-conflict-types.md → ...n-pkg-json/doc/rules/no-conflict-types.md
diff --git a/...ules/no-dependencies-in-workspace-root.md → ...ules/no-dependencies-in-workspace-root.md b/...ules/no-dependencies-in-workspace-root.md → ...ules/no-dependencies-in-workspace-root.md
diff --git a/...kagejson/doc/rules/no-lifecycle-script.md → ...pkg-json/doc/rules/no-lifecycle-script.md b/...kagejson/doc/rules/no-lifecycle-script.md → ...pkg-json/doc/rules/no-lifecycle-script.md
diff --git a/...json/doc/rules/no-nonstandard-property.md → ...json/doc/rules/no-nonstandard-property.md b/...json/doc/rules/no-nonstandard-property.md → ...json/doc/rules/no-nonstandard-property.md
diff --git a/.../no-types-dependency-in-workspace-root.md → .../no-types-dependency-in-workspace-root.md b/.../no-types-dependency-in-workspace-root.md → .../no-types-dependency-in-workspace-root.md
diff --git a/...ejson/doc/rules/private-workspace-root.md → ...-json/doc/rules/private-workspace-root.md b/...ejson/doc/rules/private-workspace-root.md → ...-json/doc/rules/private-workspace-root.md
diff --git a/...packagejson/doc/rules/required-engines.md → ...in-pkg-json/doc/rules/required-engines.md b/...packagejson/doc/rules/required-engines.md → ...in-pkg-json/doc/rules/required-engines.md
diff --git a/...ackagejson/doc/rules/required-hashbang.md → ...n-pkg-json/doc/rules/required-hashbang.md b/...ackagejson/doc/rules/required-hashbang.md → ...n-pkg-json/doc/rules/required-hashbang.md
diff --git a/...kagejson/doc/rules/required-repository.md → ...pkg-json/doc/rules/required-repository.md b/...kagejson/doc/rules/required-repository.md → ...pkg-json/doc/rules/required-repository.md
diff --git a/...plugin-packagejson/doc/rules/top-types.md → ...nt-plugin-pkg-json/doc/rules/top-types.md b/...plugin-packagejson/doc/rules/top-types.md → ...nt-plugin-pkg-json/doc/rules/top-types.md
diff --git a/...ugin-packagejson/doc/rules/type-module.md → ...-plugin-pkg-json/doc/rules/type-module.md b/...ugin-packagejson/doc/rules/type-module.md → ...-plugin-pkg-json/doc/rules/type-module.md
diff --git a/...es/eslint-plugin-packagejson/package.json → packages/eslint-plugin-pkg-json/package.json b/...es/eslint-plugin-packagejson/package.json → packages/eslint-plugin-pkg-json/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@git-validator/eslint-plugin-packagejson",
-  "version": "0.3.2",
-  "description": "ESlint plugin for linting package json.",
+  "name": "eslint-plugin-pkg-json",
+  "version": "0.0.0",
+  "description": "ESLint plugin for linting package.json file",
   "keywords": [
     "eslint",
     "config",
@@ -10,13 +10,14 @@
     "package-json",
     "packagejson",
     "package",
-    "json"
+    "json",
+    "node"
   ],
-  "homepage": "https://github.com/zanminkian/git-validator/tree/main/packages/eslint-plugin-packagejson",
+  "homepage": "https://github.com/zanminkian/git-validator/tree/main/packages/eslint-plugin-pkg-json",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zanminkian/git-validator.git",
-    "directory": "packages/eslint-plugin-packagejson"
+    "directory": "packages/eslint-plugin-pkg-json"
   },
   "license": "MIT",
   "author": "[email protected]",

diff --git a/...s/eslint-plugin-packagejson/src/common.ts → ...ages/eslint-plugin-pkg-json/src/common.ts b/...s/eslint-plugin-packagejson/src/common.ts → ...ages/eslint-plugin-pkg-json/src/common.ts
diff --git a/...es/eslint-plugin-packagejson/src/index.ts → packages/eslint-plugin-pkg-json/src/index.ts b/...es/eslint-plugin-packagejson/src/index.ts → packages/eslint-plugin-pkg-json/src/index.ts
diff --git a/...slint-plugin-packagejson/src/processor.ts → ...s/eslint-plugin-pkg-json/src/processor.ts b/...slint-plugin-packagejson/src/processor.ts → ...s/eslint-plugin-pkg-json/src/processor.ts
diff --git a/...n-packagejson/src/rules/bottom-default.js → ...ugin-pkg-json/src/rules/bottom-default.js b/...n-packagejson/src/rules/bottom-default.js → ...ugin-pkg-json/src/rules/bottom-default.js
diff --git a/...kagejson/src/rules/bottom-default.spec.ts → ...pkg-json/src/rules/bottom-default.spec.ts b/...kagejson/src/rules/bottom-default.spec.ts → ...pkg-json/src/rules/bottom-default.spec.ts
diff --git a/...son/src/rules/exact-dependency-version.js → ...son/src/rules/exact-dependency-version.js b/...son/src/rules/exact-dependency-version.js → ...son/src/rules/exact-dependency-version.js
diff --git a/...rc/rules/exact-dependency-version.spec.ts → ...rc/rules/exact-dependency-version.spec.ts b/...rc/rules/exact-dependency-version.spec.ts → ...rc/rules/exact-dependency-version.spec.ts
diff --git a/...ackagejson/src/rules/no-conflict-types.js → ...n-pkg-json/src/rules/no-conflict-types.js b/...ackagejson/src/rules/no-conflict-types.js → ...n-pkg-json/src/rules/no-conflict-types.js
diff --git a/...ejson/src/rules/no-conflict-types.spec.ts → ...-json/src/rules/no-conflict-types.spec.ts b/...ejson/src/rules/no-conflict-types.spec.ts → ...-json/src/rules/no-conflict-types.spec.ts
diff --git a/...ules/no-dependencies-in-workspace-root.js → ...ules/no-dependencies-in-workspace-root.js b/...ules/no-dependencies-in-workspace-root.js → ...ules/no-dependencies-in-workspace-root.js
diff --git a/...no-dependencies-in-workspace-root.spec.ts → ...no-dependencies-in-workspace-root.spec.ts b/...no-dependencies-in-workspace-root.spec.ts → ...no-dependencies-in-workspace-root.spec.ts
diff --git a/...kagejson/src/rules/no-lifecycle-script.js → ...pkg-json/src/rules/no-lifecycle-script.js b/...kagejson/src/rules/no-lifecycle-script.js → ...pkg-json/src/rules/no-lifecycle-script.js
diff --git a/...son/src/rules/no-lifecycle-script.spec.ts → ...son/src/rules/no-lifecycle-script.spec.ts b/...son/src/rules/no-lifecycle-script.spec.ts → ...son/src/rules/no-lifecycle-script.spec.ts
diff --git a/...json/src/rules/no-nonstandard-property.js → ...json/src/rules/no-nonstandard-property.js b/...json/src/rules/no-nonstandard-property.js → ...json/src/rules/no-nonstandard-property.js
diff --git a/...src/rules/no-nonstandard-property.spec.ts → ...src/rules/no-nonstandard-property.spec.ts b/...src/rules/no-nonstandard-property.spec.ts → ...src/rules/no-nonstandard-property.spec.ts
diff --git a/.../no-types-dependency-in-workspace-root.js → .../no-types-dependency-in-workspace-root.js b/.../no-types-dependency-in-workspace-root.js → .../no-types-dependency-in-workspace-root.js
diff --git a/...ypes-dependency-in-workspace-root.spec.ts → ...ypes-dependency-in-workspace-root.spec.ts b/...ypes-dependency-in-workspace-root.spec.ts → ...ypes-dependency-in-workspace-root.spec.ts
diff --git a/...ejson/src/rules/private-workspace-root.js → ...-json/src/rules/private-workspace-root.js b/...ejson/src/rules/private-workspace-root.js → ...-json/src/rules/private-workspace-root.js
diff --git a/.../src/rules/private-workspace-root.spec.ts → .../src/rules/private-workspace-root.spec.ts b/.../src/rules/private-workspace-root.spec.ts → .../src/rules/private-workspace-root.spec.ts
diff --git a/...packagejson/src/rules/required-engines.js → ...in-pkg-json/src/rules/required-engines.js b/...packagejson/src/rules/required-engines.js → ...in-pkg-json/src/rules/required-engines.js
diff --git a/...gejson/src/rules/required-engines.spec.ts → ...g-json/src/rules/required-engines.spec.ts b/...gejson/src/rules/required-engines.spec.ts → ...g-json/src/rules/required-engines.spec.ts
diff --git a/...ackagejson/src/rules/required-hashbang.js → ...n-pkg-json/src/rules/required-hashbang.js b/...ackagejson/src/rules/required-hashbang.js → ...n-pkg-json/src/rules/required-hashbang.js
diff --git a/...ejson/src/rules/required-hashbang.spec.ts → ...-json/src/rules/required-hashbang.spec.ts b/...ejson/src/rules/required-hashbang.spec.ts → ...-json/src/rules/required-hashbang.spec.ts
diff --git a/...kagejson/src/rules/required-repository.js → ...pkg-json/src/rules/required-repository.js b/...kagejson/src/rules/required-repository.js → ...pkg-json/src/rules/required-repository.js
diff --git a/...son/src/rules/required-repository.spec.ts → ...son/src/rules/required-repository.spec.ts b/...son/src/rules/required-repository.spec.ts → ...son/src/rules/required-repository.spec.ts
diff --git a/...plugin-packagejson/src/rules/top-types.js → ...nt-plugin-pkg-json/src/rules/top-types.js b/...plugin-packagejson/src/rules/top-types.js → ...nt-plugin-pkg-json/src/rules/top-types.js
diff --git a/...n-packagejson/src/rules/top-types.spec.ts → ...ugin-pkg-json/src/rules/top-types.spec.ts b/...n-packagejson/src/rules/top-types.spec.ts → ...ugin-pkg-json/src/rules/top-types.spec.ts
diff --git a/...ugin-packagejson/src/rules/type-module.js → ...-plugin-pkg-json/src/rules/type-module.js b/...ugin-packagejson/src/rules/type-module.js → ...-plugin-pkg-json/src/rules/type-module.js
diff --git a/...packagejson/src/rules/type-module.spec.ts → ...in-pkg-json/src/rules/type-module.spec.ts b/...packagejson/src/rules/type-module.spec.ts → ...in-pkg-json/src/rules/type-module.spec.ts
diff --git a/...slint-plugin-packagejson/src/test.spec.ts → ...s/eslint-plugin-pkg-json/src/test.spec.ts b/...slint-plugin-packagejson/src/test.spec.ts → ...s/eslint-plugin-pkg-json/src/test.spec.ts
diff --git a/...packagejson/test/required-hashbang/bad.js → ...in-pkg-json/test/required-hashbang/bad.js b/...packagejson/test/required-hashbang/bad.js → ...in-pkg-json/test/required-hashbang/bad.js
diff --git a/...ackagejson/test/required-hashbang/good.js → ...n-pkg-json/test/required-hashbang/good.js b/...ackagejson/test/required-hashbang/good.js → ...n-pkg-json/test/required-hashbang/good.js
diff --git a/...nt-plugin-packagejson/tsconfig.build.json → ...slint-plugin-pkg-json/tsconfig.build.json b/...nt-plugin-packagejson/tsconfig.build.json → ...slint-plugin-pkg-json/tsconfig.build.json
diff --git a/...s/eslint-plugin-packagejson/tsconfig.json → ...ages/eslint-plugin-pkg-json/tsconfig.json b/...s/eslint-plugin-packagejson/tsconfig.json → ...ages/eslint-plugin-pkg-json/tsconfig.json