eslint-plugin-package-json 0.2.0 → 0.3.1

package/.eslintrc

@@ -5,7 +5,7 @@
     },
     "extends": ["eslint:recommended"],
     "parserOptions": {
-        "ecmaVersion": 6,
+        "ecmaVersion": 2021,
         "sourceType": "module"
     }
 }

package/.github/actions/prepare/action.yml

@@ -0,0 +1,12 @@
+description: Prepares the repo for a typical CI job
+
+name: Prepare
+
+runs:
+    steps:
+        - uses: actions/setup-node@v4
+          with:
+              node-version: '18'
+        - run: npm ci
+          shell: bash
+    using: composite

package/.github/workflows/format.yml

@@ -0,0 +1,15 @@
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/prepare
+      - run: npm run format -- --check
+
+name: Format
+
+on:
+  pull_request: ~
+  push:
+    branches:
+      - main

package/.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/prepare
+      - run: npm run lint
+
+name: Lint
+
+on:
+  pull_request: ~
+  push:
+    branches:
+      - main

package/.github/workflows/test.yml

@@ -3,10 +3,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 18
-      - run: npm ci
+      - uses: ./.github/actions/prepare
       - run: npm run test
 
 name: Test

package/.github/workflows/tsc.yml

@@ -0,0 +1,15 @@
+jobs:
+  tsc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/prepare
+      - run: npm run tsc
+
+name: Type Check
+
+on:
+  pull_request: ~
+  push:
+    branches:
+      - main

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["dbaeumer.vscode-eslint"]
+}

package/.vscode/launch.json

@@ -1,17 +1,16 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-      {
-          "type": "node",
-          "request": "attach",
-          "name": "Attach",
-          "skipFiles": [
-              "node-internals:*"
-          ],
-          "port": 9229
-      }
-  ]
+    "configurations": [
+        {
+            "args": ["run", "${relativeFile}"],
+            "autoAttachChildProcesses": true,
+            "console": "integratedTerminal",
+            "name": "Debug Current Test File",
+            "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
+            "request": "launch",
+            "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+            "smartStep": true,
+            "type": "node"
+        }
+    ],
+    "version": "0.2.0"
 }

package/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }],
+    "typescript.tsdk": "node_modules/typescript/lib"
+}

package/README.md

@@ -2,49 +2,52 @@
 
 Rules for valid, consistent, and readable package.json files
 
-## Installation
-
-You'll first need to install [ESLint](http://eslint.org):
+> ⚠️ This README.md is for the `0.3.x` versions of this package.
+> Those versions are tagged as `beta` on npm.
+> For 0.2.x, see [the latest 0.2.x README.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/tree/a1c3bf76fb1a55e85f071051be55dc06ebb47c8b).
 
-```
-$ npm i eslint --save-dev
-```
+## Installation
 
-Next, install `eslint-plugin-package-json`:
+You'll first need to install [ESLint](http://eslint.org) >=8 and `eslint-plugin-package-json`:
 
-```
-$ npm install eslint-plugin-package-json --save-dev
+```shell
+$ npm install eslint eslint-plugin-package-json jsonc-eslint-parser --save-dev
 ```
 
 **Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-package-json` globally.
 
 ## Usage
 
-Add `package-json` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
-
-```json
-{
-    "plugins": ["package-json"]
-}
-```
-
-Use the prepackaged config by adding an "extends" property, or appending to an existing "extends" property:
-
-```json
-{
-    "extends": ["eslint:recommended", "plugin:package-json/recommended"],
-    "plugins": ["package-json"]
-}
+Add an override to your ESLint configuration file that specifies this plugin, [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser) and its recommended rules for your `package.json` file:
+
+```js
+module.exports = {
+    overrides: [
+        {
+            extends: ['plugin:package-json/recommended'],
+            files: ['package.json'],
+            parser: 'jsonc-eslint-parser',
+            plugins: ['package-json']
+        }
+    ]
+};
 ```
 
 Or, individually configure the rules you want to use under the rules section.
 
-```json
-{
-    "rules": {
-        "package-json/rule-name": 2
-    }
-}
+```js
+module.exports = {
+    overrides: [
+        {
+            files: ['package.json'],
+            parser: 'jsonc-eslint-parser',
+            plugins: ['package-json'],
+            rules: {
+                'package-json/valid-package-def': 'error'
+            }
+        }
+    ]
+};
 ```
 
 ## Supported Rules

package/lib/createRule.d.ts

@@ -0,0 +1,30 @@
+import { AST, Rule, SourceCode } from 'eslint';
+import { AST as JsonAST, RuleListener } from "jsonc-eslint-parser";
+import type * as ESTree from 'estree';
+export type JsonAstBodyProperty = (JsonAST.JSONProperty & {
+    value: string;
+});
+export type JsonAstBodyExpression = ESTree.Expression & {
+    properties: JsonAstBodyProperty[];
+};
+export interface JsonAstBodyStatement extends ESTree.ExpressionStatement {
+    expression: JsonAstBodyExpression;
+}
+export interface PackageJsonAst extends AST.Program {
+    body: [JsonAstBodyStatement];
+}
+export interface PackageJsonSourceCode extends SourceCode {
+    ast: PackageJsonAst;
+}
+export interface PackageJsonRuleContext extends Rule.RuleContext {
+    sourceCode: PackageJsonSourceCode;
+}
+export interface PackageJsonRuleModule {
+    meta: Rule.RuleMetaData;
+    create(context: PackageJsonRuleContext): RuleListener;
+}
+export declare function createRule(rule: PackageJsonRuleModule): {
+    create(context: PackageJsonRuleContext): RuleListener;
+    meta: Rule.RuleMetaData;
+};
+//# sourceMappingURL=createRule.d.ts.map

package/lib/createRule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createRule.d.ts","sourceRoot":"","sources":["../src/createRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,GAAG,IAAI,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClE,OAAO,KAAK,KAAK,MAAM,MAAM,QAAQ,CAAC;AAKtC,MAAM,MAAM,mBAAmB,GAAG,CAAC,OAAO,CAAC,YAAY,GAAG;IACtD,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC,UAAU,GAAG;IACpD,UAAU,EAAE,mBAAmB,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,WAAW,oBAAqB,SAAQ,MAAM,CAAC,mBAAmB;IACpE,UAAU,EAAE,qBAAqB,CAAA;CACpC;AAED,MAAM,WAAW,cAAe,SAAQ,GAAG,CAAC,OAAO;IAC/C,IAAI,EAAE,CAAC,oBAAoB,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACrD,GAAG,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,sBAAuB,SAAQ,IAAI,CAAC,WAAW;IAC5D,UAAU,EAAE,qBAAqB,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC;IACxB,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,YAAY,CAAC;CACvD;AAGH,wBAAgB,UAAU,CAAC,IAAI,EAAE,qBAAqB;oBAG9B,sBAAsB;;EAQ7C"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/lib/rules/order-properties.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    create(context: import("../createRule.js").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
+    meta: import("eslint").Rule.RuleMetaData;
+};
+export default _default;
+//# sourceMappingURL=order-properties.d.ts.map

package/lib/rules/order-properties.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-properties.d.ts","sourceRoot":"","sources":["../../src/rules/order-properties.ts"],"names":[],"mappings":";;;;AAmCA,wBA0EG"}

package/lib/rules/sort-collections.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    create(context: import("../createRule.js").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
+    meta: import("eslint").Rule.RuleMetaData;
+};
+export default _default;
+//# sourceMappingURL=sort-collections.d.ts.map

package/lib/rules/sort-collections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-collections.d.ts","sourceRoot":"","sources":["../../src/rules/sort-collections.ts"],"names":[],"mappings":";;;;AAaA,wBAkFG"}

package/lib/rules/valid-local-dependency.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    create(context: import("../createRule.js").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
+    meta: import("eslint").Rule.RuleMetaData;
+};
+export default _default;
+//# sourceMappingURL=valid-local-dependency.d.ts.map

package/lib/rules/valid-local-dependency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-local-dependency.d.ts","sourceRoot":"","sources":["../../src/rules/valid-local-dependency.ts"],"names":[],"mappings":";;;;AAQA,wBAgEG"}

package/lib/rules/valid-package-def.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    create(context: import("../createRule.js").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
+    meta: import("eslint").Rule.RuleMetaData;
+};
+export default _default;
+//# sourceMappingURL=valid-package-def.d.ts.map

package/lib/rules/valid-package-def.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-package-def.d.ts","sourceRoot":"","sources":["../../src/rules/valid-package-def.ts"],"names":[],"mappings":";;;;AAgBA,wBA4BG"}

package/lib/tests/rules/order-properties.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=order-properties.test.d.ts.map

package/lib/tests/rules/order-properties.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-properties.test.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/order-properties.test.ts"],"names":[],"mappings":""}

package/lib/tests/rules/order-properties.test.js

@@ -0,0 +1,232 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const order_properties_1 = __importDefault(require("../../rules/order-properties"));
+const ruleTester_1 = require("./ruleTester");
+ruleTester_1.ruleTester.run('order-properties', order_properties_1.default, {
+    invalid: [
+        {
+            only: true,
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            output: `{
+  "name": "invalid-top-level-property-order",
+  "version": "1.0.0",
+  "description": "npm made me this way",
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  }
+}
+`
+        },
+        {
+            only: true,
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            options: [{ order: 'legacy' }],
+            output: `{
+  "name": "invalid-top-level-property-order",
+  "version": "1.0.0",
+  "description": "npm made me this way",
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  }
+}
+`
+        },
+        {
+            only: true,
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            options: [{ order: 'sort-package-json' }],
+            output: `{
+  "name": "invalid-top-level-property-order",
+  "version": "1.0.0",
+  "description": "npm made me this way",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  },
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  }
+}
+`
+        },
+        {
+            only: true,
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            options: [{ order: ['version', 'name', 'repository'] }],
+            output: `{
+  "version": "1.0.0",
+  "name": "invalid-top-level-property-order",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  },
+  "description": "npm made me this way",
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  }
+}
+`
+        }
+    ],
+    valid: [
+        {
+            code: `{
+      "name": "treat-yo-self",
+      "version": "1.1.1",
+      "description": "Once a year.",
+      "keywords": [
+        "modern",
+        "master"
+      ]
+    }`,
+            filename: 'package.json'
+        },
+        {
+            code: `{
+      "name": "treat-yo-self",
+      "version": "0.1.0",
+      "private": true,
+      "description": "Once a year.",
+      "keywords": [
+        "modern",
+        "master"
+      ]
+    }
+    `
+        },
+        {
+            code: `{
+      "version": "1.1.1",
+      "name": "treat-yo-self",
+      "description": "Once a year.",
+      "keywords": [
+        "modern",
+        "master"
+      ]
+    }
+    `,
+            options: [{ order: ['version', 'name'] }]
+        },
+        {
+            code: `{
+    "name": "treat-yo-self",
+    "version": "1.1.1",
+    "description": "Once a year.",
+    "keywords": [
+      "modern",
+      "master"
+    ],
+    "exports": {
+      "import": "./index.js",
+      "require": "./index.js"
+    },
+    "main": "index.js"
+    }`,
+            options: [{ order: 'sort-package-json' }]
+        },
+        {
+            code: `{
+    "name": "treat-yo-self",
+    "version": "1.1.1",
+    "description": "Once a year.",
+    "main": "index.js",
+    "exports": {
+    "import": "./index.js",
+    "require": "./index.js"
+    }
+    }`,
+            options: [{ order: 'legacy' }]
+        }
+    ]
+});

package/lib/tests/rules/ruleTester.d.ts

@@ -0,0 +1,10 @@
+import { RuleTester } from 'eslint';
+import { PackageJsonRuleModule } from '../../createRule';
+export type JsonRuleTester = RuleTester & {
+    run: (name: string, rule: PackageJsonRuleModule, tests: {
+        valid?: Array<string | RuleTester.ValidTestCase> | undefined;
+        invalid?: RuleTester.InvalidTestCase[] | undefined;
+    }) => void;
+};
+export declare const ruleTester: JsonRuleTester;
+//# sourceMappingURL=ruleTester.d.ts.map

package/lib/tests/rules/ruleTester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ruleTester.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/ruleTester.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG;IACtC,GAAG,EAAE,CACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,qBAAqB,EAC3B,KAAK,EAAE;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;QAC7D,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,EAAE,GAAG,SAAS,CAAC;KACtD,KACA,IAAI,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,UAAU,gBAEH,CAAC"}

package/lib/tests/rules/ruleTester.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ruleTester = void 0;
+const eslint_1 = require("eslint");
+exports.ruleTester = new eslint_1.RuleTester({
+    parser: require.resolve('jsonc-eslint-parser')
+});

package/lib/tests/rules/sort-collections.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sort-collections.test.d.ts.map

package/lib/tests/rules/sort-collections.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-collections.test.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/sort-collections.test.ts"],"names":[],"mappings":""}

package/lib/tests/rules/sort-collections.test.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sort_collections_1 = __importDefault(require("../../rules/sort-collections"));
+const ruleTester_js_1 = require("./ruleTester.js");
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+ruleTester_js_1.ruleTester.run('sort-collections', sort_collections_1.default, {
+    valid: [
+        {
+            code: `{
+  "scripts": {
+    "build": "webpack",
+    "watch": "webpack-dev-server"
+  }
+}`,
+            filename: 'package.json'
+        },
+        // ignore if custom include rule
+        {
+            code: `{
+  "scripts": {
+    "build": "webpack",
+    "watch": "webpack-dev-server"
+  }
+}`,
+            filename: 'package.json',
+            options: [['devDependencies']]
+        },
+        {
+            code: `{
+        "scripts": { "watch": "out of order...", "build": "but okay" }
+}`,
+            filename: 'not-a-package.json',
+            options: [['devDependencies']]
+        }
+    ],
+    invalid: [
+        {
+            code: `{
+  "scripts": {
+    "watch": "webpack-dev-server",
+    "build": "webpack"
+  }
+}`,
+            filename: 'package.json',
+            errors: [
+                {
+                    message: 'Package scripts are not alphabetized',
+                    type: 'JSONProperty'
+                }
+            ],
+            output: `{
+  "scripts": {
+    "build": "webpack",
+    "watch": "webpack-dev-server"
+  }
+}`
+        }
+    ]
+});

package/lib/tests/rules/valid-local-dependency.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=valid-local-dependency.test.d.ts.map

package/lib/tests/rules/valid-local-dependency.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-local-dependency.test.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/valid-local-dependency.test.ts"],"names":[],"mappings":""}