eslint-plugin-package-jsonc 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 otakutyrant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# eslint-plugin-package-jsonc
+
+An ESLint plugin that ensures `package.json` is consistent with `package.jsonc`.
+
+## Installation
+
+```bash
+npm install --save-dev eslint-plugin-package-jsonc
+```
+
+## Usage
+
+Add the plugin to your ESLint configuration:
+
+### Flat Config (eslint.config.js)
+
+```javascript
+import packageJsonc from "eslint-plugin-package-jsonc";
+
+export default [
+    {
+        plugins: {
+            "package-jsonc": packageJsonc,
+        },
+        rules: {
+            "package-jsonc/sync": "error",
+        },
+    },
+];
+```
+
+### Legacy Config (.eslintrc)
+
+```json
+{
+    "plugins": ["package-jsonc"],
+    "rules": {
+        "package-jsonc/sync": "error"
+    }
+}
+```
+
+## Rule: `package-jsonc/sync`
+
+This rule ensures that `package.json` is always in sync with `package.jsonc`:
+
+- If `package.json` does not exist but `package.jsonc` does, the rule reports an error and can generate `package.json` when running with `--fix`.
+- If `package.json` exists but has different content than what would be generated from `package.jsonc`, the rule reports an error and can update `package.json` when running with `--fix`.
+
+### Fix Mode
+
+When running ESLint with the `--fix` flag, the plugin will automatically:
+
+1. Generate `package.json` if it doesn't exist
+2. Update `package.json` if it's inconsistent with `package.jsonc`
+
+```bash
+eslint package.jsonc --fix
+```
+
+## How It Works
+
+1. The plugin parses `package.jsonc` (JSON with comments) by stripping out comments
+2. It compares the parsed content with the existing `package.json` (if any)
+3. If they differ, it reports an error
+4. In fix mode, it writes the normalized JSON to `package.json`
+
+## Why Use This?
+
+- **Comments in package.json**: JSONC allows you to add comments to your package configuration while maintaining a standard `package.json` for npm compatibility.
+- **Single source of truth**: `package.jsonc` becomes the source of truth, and `package.json` is auto-generated.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { ESLint } from "eslint";
+declare const plugin: ESLint.Plugin;
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGrC,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,MAYpB,CAAC;AAMF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,19 @@
+import packageJsoncRule, { clearFixedFiles } from "./rules/package-jsonc.js";
+const plugin = {
+    rules: {
+        sync: packageJsoncRule,
+    },
+    configs: {
+        recommended: {
+            plugins: ["package-jsonc"],
+            rules: {
+                "package-jsonc/sync": "error",
+            },
+        },
+    },
+};
+// Export the clearFixedFiles function for testing
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+plugin.clearFixedFiles = clearFixedFiles;
+export default plugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,gBAAgB,EAAE,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE7E,MAAM,MAAM,GAAkB;IAC1B,KAAK,EAAE;QACH,IAAI,EAAE,gBAAgB;KACzB;IACD,OAAO,EAAE;QACL,WAAW,EAAE;YACT,OAAO,EAAE,CAAC,eAAe,CAAC;YAC1B,KAAK,EAAE;gBACH,oBAAoB,EAAE,OAAO;aAChC;SACJ;KACJ;CACJ,CAAC;AAEF,kDAAkD;AAClD,8DAA8D;AAC7D,MAAc,CAAC,eAAe,GAAG,eAAe,CAAC;AAElD,eAAe,MAAM,CAAC"}

package/dist/rules/package-jsonc.d.ts

@@ -0,0 +1,5 @@
+import type { Rule } from "eslint";
+declare const rule: Rule.RuleModule;
+export declare function clearFixedFiles(): void;
+export default rule;
+//# sourceMappingURL=package-jsonc.d.ts.map

package/dist/rules/package-jsonc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-jsonc.d.ts","sourceRoot":"","sources":["../../src/rules/package-jsonc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAkDnC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAkGhB,CAAC;AAGF,wBAAgB,eAAe,IAAI,IAAI,CAEtC;AAED,eAAe,IAAI,CAAC"}

package/dist/rules/package-jsonc.js

@@ -0,0 +1,127 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+// Track which files have been fixed in this ESLint run to avoid circular fixes
+const fixedFiles = new Set();
+/**
+ * Parse JSONC content (JSON with Comments) into a JavaScript object.
+ * Removes single-line and multi-line comments.
+ * @param content - The JSONC content
+ * @returns The parsed JSON object
+ */
+function parseJSONC(content) {
+    // Remove single-line comments (// ...)
+    let cleaned = content.replace(/\/\/.*$/gm, "");
+    // Remove multi-line comments (/* ... */)
+    cleaned = cleaned.replace(/\/\*[\s\S]*?\*\//g, "");
+    // Parse the cleaned content as JSON
+    return JSON.parse(cleaned);
+}
+/**
+ * Get the text representation of a value for comparison.
+ * Normalizes JSON formatting for reliable comparison.
+ * @param object - The object to stringify
+ * @returns Normalized JSON string
+ */
+function getNormalizedJson(object) {
+    return JSON.stringify(object, null, 2) + "\n";
+}
+/**
+ * Check if package.json needs to be updated.
+ * This is called during the fix phase to avoid circular fixes.
+ */
+function needsFix(packageJsonPath, normalizedJsonc) {
+    try {
+        const content = fs.readFileSync(packageJsonPath, "utf8");
+        const data = JSON.parse(content);
+        return normalizedJsonc !== getNormalizedJson(data);
+    }
+    catch {
+        // File doesn't exist or is invalid
+        return true;
+    }
+}
+const rule = {
+    meta: {
+        type: "problem",
+        docs: {
+            description: "Ensure package.json is consistent with package.jsonc",
+            category: "Possible Errors",
+            recommended: true,
+        },
+        fixable: "code",
+        schema: [],
+        messages: {
+            missingPackageJson: "package.json does not exist but package.jsonc does. Run 'npx eslint package.jsonc --fix' to generate it.",
+            inconsistentPackageJson: "package.json is inconsistent with package.jsonc. Run 'npx eslint package.jsonc --fix' to update it.",
+        },
+    },
+    create(context) {
+        const filename = context.getFilename();
+        const basename = path.basename(filename);
+        // Only process package.jsonc files
+        if (basename !== "package.jsonc") {
+            return {};
+        }
+        const directory = path.dirname(filename);
+        const packageJsonPath = path.join(directory, "package.json");
+        return {
+            Program(node) {
+                const sourceCode = context.getSourceCode();
+                const jsoncContent = sourceCode.getText();
+                let jsoncData;
+                try {
+                    jsoncData = parseJSONC(jsoncContent);
+                }
+                catch {
+                    // If package.jsonc has syntax errors, let other rules handle it
+                    return;
+                }
+                const normalizedJsonc = getNormalizedJson(jsoncData);
+                // Check if package.json exists and is consistent
+                let isConsistent = false;
+                try {
+                    const packageJsonContent = fs.readFileSync(packageJsonPath, "utf8");
+                    const packageJsonData = JSON.parse(packageJsonContent);
+                    isConsistent = normalizedJsonc === getNormalizedJson(packageJsonData);
+                }
+                catch {
+                    // package.json does not exist or is invalid
+                }
+                if (isConsistent) {
+                    return;
+                }
+                // Report the error with a fixer
+                const messageId = fs.existsSync(packageJsonPath)
+                    ? "inconsistentPackageJson"
+                    : "missingPackageJson";
+                context.report({
+                    node,
+                    messageId,
+                    fix(fixer) {
+                        // Check if we've already fixed this file in this run
+                        if (fixedFiles.has(filename)) {
+                            return null;
+                        }
+                        // Check if fix is actually needed
+                        if (!needsFix(packageJsonPath, normalizedJsonc)) {
+                            fixedFiles.add(filename);
+                            return null;
+                        }
+                        // Apply the fix
+                        fixedFiles.add(filename);
+                        fs.writeFileSync(packageJsonPath, normalizedJsonc, "utf8");
+                        // Return null to indicate no source text changes
+                        // The actual fix happened to a different file (package.json)
+                        return null;
+                    },
+                });
+            },
+        };
+    },
+};
+// Export a function to clear the fixed files set (for testing)
+export function clearFixedFiles() {
+    fixedFiles.clear();
+}
+export default rule;
+//# sourceMappingURL=package-jsonc.js.map

package/dist/rules/package-jsonc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-jsonc.js","sourceRoot":"","sources":["../../src/rules/package-jsonc.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,+EAA+E;AAC/E,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;AAErC;;;;;GAKG;AACH,SAAS,UAAU,CAAC,OAAe;IAC/B,uCAAuC;IACvC,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC/C,yCAAyC;IACzC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC;IACnD,oCAAoC;IACpC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAA4B,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,MAAe;IACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,SAAS,QAAQ,CACb,eAAuB,EACvB,eAAuB;IAEvB,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QACzD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACjC,OAAO,eAAe,KAAK,iBAAiB,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAAC,MAAM,CAAC;QACL,mCAAmC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;AACL,CAAC;AAED,MAAM,IAAI,GAAoB;IAC1B,IAAI,EAAE;QACF,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACF,WAAW,EAAE,sDAAsD;YACnE,QAAQ,EAAE,iBAAiB;YAC3B,WAAW,EAAE,IAAI;SACpB;QACD,OAAO,EAAE,MAAM;QACf,MAAM,EAAE,EAAE;QACV,QAAQ,EAAE;YACN,kBAAkB,EACd,0GAA0G;YAC9G,uBAAuB,EACnB,qGAAqG;SAC5G;KACJ;IAED,MAAM,CAAC,OAAyB;QAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAEzC,mCAAmC;QACnC,IAAI,QAAQ,KAAK,eAAe,EAAE,CAAC;YAC/B,OAAO,EAAE,CAAC;QACd,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;QAE7D,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;gBAC3C,MAAM,YAAY,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;gBAE1C,IAAI,SAAkC,CAAC;gBACvC,IAAI,CAAC;oBACD,SAAS,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;gBACzC,CAAC;gBAAC,MAAM,CAAC;oBACL,gEAAgE;oBAChE,OAAO;gBACX,CAAC;gBAED,MAAM,eAAe,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;gBAErD,iDAAiD;gBACjD,IAAI,YAAY,GAAG,KAAK,CAAC;gBACzB,IAAI,CAAC;oBACD,MAAM,kBAAkB,GAAG,EAAE,CAAC,YAAY,CACtC,eAAe,EACf,MAAM,CACT,CAAC;oBACF,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;oBACvD,YAAY,GAAG,eAAe,KAAK,iBAAiB,CAAC,eAAe,CAAC,CAAC;gBAC1E,CAAC;gBAAC,MAAM,CAAC;oBACL,4CAA4C;gBAChD,CAAC;gBAED,IAAI,YAAY,EAAE,CAAC;oBACf,OAAO;gBACX,CAAC;gBAED,gCAAgC;gBAChC,MAAM,SAAS,GAAG,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC;oBAC5C,CAAC,CAAC,yBAAyB;oBAC3B,CAAC,CAAC,oBAAoB,CAAC;gBAE3B,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI;oBACJ,SAAS;oBACT,GAAG,CAAC,KAAK;wBACL,qDAAqD;wBACrD,IAAI,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;4BAC3B,OAAO,IAAI,CAAC;wBAChB,CAAC;wBAED,kCAAkC;wBAClC,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC,EAAE,CAAC;4BAC9C,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;4BACzB,OAAO,IAAI,CAAC;wBAChB,CAAC;wBAED,gBAAgB;wBAChB,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;wBACzB,EAAE,CAAC,aAAa,CACZ,eAAe,EACf,eAAe,EACf,MAAM,CACT,CAAC;wBAEF,iDAAiD;wBACjD,6DAA6D;wBAC7D,OAAO,IAAI,CAAC;oBAChB,CAAC;iBACJ,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;CACJ,CAAC;AAEF,+DAA+D;AAC/D,MAAM,UAAU,eAAe;IAC3B,UAAU,CAAC,KAAK,EAAE,CAAC;AACvB,CAAC;AAED,eAAe,IAAI,CAAC"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "eslint-plugin-package-jsonc",
+  "version": "1.0.0",
+  "description": "ESLint plugin to ensure package.json is consistent with package.jsonc",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "package.json",
+    "package.jsonc",
+    "jsonc"
+  ],
+  "peerDependencies": {
+    "eslint": ">=8.0.0"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1.4.0",
+    "@eslint/js": "^9.36.0",
+    "@types/eslint": "^9.6.1",
+    "@types/node": "^25.2.1",
+    "eslint": "^9.39.1",
+    "espree": "^11.1.0",
+    "globals": "^17.3.0",
+    "jiti": "^2.6.1",
+    "prettier": "^3.6.2",
+    "prettier-plugin-organize-imports": "^4.2.0",
+    "typescript": "^5",
+    "typescript-eslint": "^8.48.0"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "lint": "tsc --noEmit && eslint",
+    "format": "prettier --write . --log-level warn",
+    "test": "node test/package-jsonc.test.js"
+  }
+}