@cldmv/eslint-plugin-jsonv 1.0.0

package/LICENSE

@@ -0,0 +1,210 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+   Subject to the terms and conditions of this License, each Contributor
+   hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+   royalty-free, irrevocable copyright license to reproduce, prepare
+   Derivative Works of, publicly display, publicly perform, sublicense,
+   and distribute the Work and such Derivative Works in Source or Object
+   form.
+
+3. Grant of Patent License.
+
+   Subject to the terms and conditions of this License, each Contributor
+   hereby grants to You a perpetual, worldwide, non-exclusive, no-charge,
+   royalty-free, irrevocable (except as stated in this section) patent
+   license to make, have made, use, offer to sell, sell, import, and
+   otherwise transfer the Work, where such license applies only to those
+   patent claims licensable by such Contributor that are necessarily
+   infringed by their Contribution(s) alone or by combination of their
+   Contribution(s) with the Work to which such Contribution(s) was
+   submitted. If You institute patent litigation against any entity
+   (including a cross-claim or counterclaim in a lawsuit) alleging that
+   the Work or a Contribution incorporated within the Work constitutes
+   direct or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate as of
+   the date such litigation is filed.
+
+4. Redistribution.
+
+   You may reproduce and distribute copies of the Work or Derivative
+   Works thereof in any medium, with or without modifications, and in
+   Source or Object form, provided that You meet the following conditions:
+
+   (a) You must give any other recipients of the Work or Derivative Works
+   a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+   stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works that
+   You distribute, all copyright, patent, trademark, and attribution
+   notices from the Source form of the Work, excluding those notices
+   that do not pertain to any part of the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+   distribution, then any Derivative Works that You distribute must
+   include a readable copy of the attribution notices contained
+   within such NOTICE file, excluding those notices that do not
+   pertain to any part of the Derivative Works, in at least one
+   of the following places: within a NOTICE text file distributed
+   as part of the Derivative Works; within the Source form or
+   documentation, if provided along with the Derivative Works; or,
+   within a display generated by the Derivative Works, if and
+   wherever such third-party notices normally appear. The contents
+   of the NOTICE file are for informational purposes only and
+   do not modify the License. You may add Your own attribution
+   notices within Derivative Works that You distribute, alongside
+   or as an addendum to the NOTICE text from the Work, provided
+   that such additional attribution notices cannot be construed
+   as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions.
+
+   Unless You explicitly state otherwise, any Contribution intentionally
+   submitted for inclusion in the Work by You to the Licensor shall be
+   under the terms and conditions of this License, without any additional
+   terms or conditions. Notwithstanding the above, nothing herein shall
+   supersede or modify the terms of any separate license agreement you
+   may have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+   This License does not grant permission to use the trade names,
+   trademarks, service marks, or product names of the Licensor, except
+   as required for describing the origin of the Work and reproducing
+   the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+   Unless required by applicable law or agreed to in writing, Licensor
+   provides the Work (and each Contributor provides its Contributions)
+   on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+   either express or implied, including, without limitation, any
+   warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY,
+   or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for
+   determining the appropriateness of using or redistributing the Work
+   and assume any risks associated with Your exercise of permissions
+   under this License.
+
+8. Limitation of Liability.
+
+   In no event and under no legal theory, whether in tort (including
+   negligence), contract, or otherwise, unless required by applicable
+   law (such as deliberate and grossly negligent acts) or agreed to in
+   writing, shall any Contributor be liable to You for damages, including
+   any direct, indirect, special, incidental, or consequential damages
+   of any character arising as a result of this License or out of the
+   use or inability to use the Work (including but not limited to damages
+   for loss of goodwill, work stoppage, computer failure or malfunction,
+   or any and all other commercial damages or losses), even if such
+   Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+   While redistributing the Work or Derivative Works thereof, You may choose
+   to offer, and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this License.
+   However, in accepting such obligations, You may act only on Your own behalf
+   and on Your sole responsibility, not on behalf of any other Contributor,
+   and only if You agree to indemnify, defend, and hold each Contributor
+   harmless for any liability incurred by, or claims asserted against, such
+   Contributor by reason of your accepting any such warranty or additional
+   liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included
+on the same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,131 @@
+# eslint-plugin-jsonv
+
+ESLint plugin for validating `.jsonv` files using the @cldmv/jsonv parser.
+
+## Features
+
+- **Syntax Validation**: Validates jsonv syntax using the actual jsonv parser
+- **ES2011-2025 Support**: All JSON5, ES2015, ES2020, ES2021 features supported
+- **Internal References**: Validates bare identifiers, template interpolation, nested property access
+- **BigInt Support**: Validates BigInt literals and numeric separators
+- **Accurate Error Reporting**: Parse errors include line/column information
+- **Year-Based Features**: Configurable target ES year for feature detection
+
+## Installation
+
+```bash
+npm install --save-dev eslint-plugin-jsonv
+```
+
+**Note:** This plugin requires `@cldmv/jsonv` as a peer dependency.
+
+```bash
+npm install @cldmv/jsonv
+```
+
+## Building the Plugin
+
+If you're developing the plugin:
+
+```bash
+npm install
+npm run build
+```
+
+This will:
+1. Copy `index.mjs` into `dist/index.mjs`
+2. Generate type definitions into `dist/index.d.mts`
+3. Prepare the plugin for use
+
+## Usage
+
+### ESLint Flat Config (eslint.config.mjs)
+
+```javascript
+import jsonv from 'eslint-plugin-jsonv';
+
+export default [
+  {
+    files: ["**/*.jsonv"],
+    plugins: { jsonv },
+    language: "jsonv/jsonv",
+    extends: ["jsonv/recommended"]
+  }
+];
+```
+
+### Configuration Options
+
+The parser supports the following options:
+
+```javascript
+{
+  files: ["**/*.jsonv"],
+  plugins: { jsonv },
+  language: "jsonv/jsonv",
+  languageOptions: {
+    year: 2025,           // Target ES year (2011, 2015, 2020, 2021, 2022-2025)
+    strictBigInt: false,  // Require 'n' suffix for large integers
+    mode: "jsonv"         // Parse mode: "jsonv", "json5", "json"
+  }
+}
+```
+
+## Supported Features
+
+### ES2011 (JSON5 Base)
+- Single-line (`//`) and multi-line (`/* */`) comments
+- Trailing commas in objects and arrays
+- Unquoted object keys
+- Single-quoted strings
+- Hexadecimal number literals (`0xFF`)
+- Leading/trailing decimal points (`.5`, `5.`)
+- Explicit positive sign (`+5`)
+- `Infinity`, `-Infinity`, `NaN`
+- Multi-line strings with backslash continuation
+- **Internal references via bare identifiers**: `{ port: 8080, backup: port }`
+
+### ES2015 (ES6)
+- Binary literals (`0b1010`)
+- Octal literals (`0o755`, also legacy `0755`)
+- Template literals (backtick strings)
+- **Template interpolation for internal refs**: `` url: `http://${host}:${port}` ``
+
+### ES2020
+- BigInt literals (`9007199254740992n`)
+- BigInt in hex/binary/octal formats
+
+### ES2021
+- Numeric separators (`1_000_000`, `0xFF_AA`, `0b1111_0000`)
+
+## Example
+
+**config.jsonv:**
+```jsonv
+{
+  // Server configuration with internal references
+  host: "localhost",
+  port: 8080,
+  
+  // Template interpolation
+  url: `http://${host}:${port}`,
+  
+  // ES2021 numeric separators
+  maxConnections: 1_000_000,
+  
+  // ES2020 BigInt
+  userId: 9007199254740993n,
+  
+  // ES2015 binary flags
+  permissions: 0b1111_0000,
+  
+  // Nested reference
+  monitoring: {
+    healthCheck: url
+  }
+}
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/dist/index.d.mts

@@ -0,0 +1,9 @@
+export default plugin;
+/**
+ * ESLint plugin export
+ *
+ * @public
+ * @type {Object}
+ */
+declare const plugin: Object;
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../index.mjs"],"names":[],"mappings":";AAuNA;;;;;GAKG;AACH,sBAFU,MAAM,CAqBd"}

package/dist/index.mjs

@@ -0,0 +1,243 @@
+/**
+ * @fileoverview ESLint plugin for @cldmv/jsonv files
+ * @module eslint-plugin-jsonv
+ * @public
+ *
+ * @description
+ * Custom ESLint plugin for validating .jsonv files using the @cldmv/jsonv parser.
+ * Provides language definition, parser, and recommended rules for jsonv files.
+ *
+ * Features:
+ * - Validates jsonv syntax using the actual jsonv parser
+ * - Reports parse errors with accurate source locations
+ * - Supports all ES2011-2025 features (JSON5, binary/octal literals, BigInt, numeric separators, etc.)
+ * - Detects internal reference errors (circular refs, undefined refs)
+ * - Configurable year-based feature detection
+ *
+ * @example
+ * // In eslint.config.mjs
+ * import jsonv from 'eslint-plugin-jsonv';
+ *
+ * export default [
+ *   {
+ *     files: ["**\/*.jsonv"],
+ *     plugins: { jsonv },
+ *     language: "jsonv/jsonv",
+ *     extends: ["jsonv/recommended"]
+ *   }
+ * ];
+ */
+
+// Use proper package import - package is copied to node_modules during build
+import { parseWithOptions } from "@cldmv/jsonv/parser";
+
+/**
+ * Language definition for jsonv files
+ *
+ * @public
+ * @type {Object}
+ */
+const jsonvLanguage = {
+	/** File type - must be "text" for text-based languages */
+	fileType: "text",
+	/** Line numbering starts at 1 */
+	lineStart: 1,
+	/** Column numbering starts at 1 */
+	columnStart: 1,
+	/** Property name for node types */
+	nodeTypeKey: "type",
+
+	/**
+	 * Parse jsonv source code - ESLint 9 Language API
+	 * @param {Object} file - File object with body property containing source text
+	 * @param {Object} context - Context with languageOptions
+	 * @returns {Object} Parse result {ok, ast, jsonvValue} or {ok: false, errors}
+	 */
+	parse(file, context) {
+		const text = file.body;
+		const options = context.languageOptions || {};
+
+		try {
+			// Parse with all features enabled (ES2025) and strict mode off by default
+			const result = parseWithOptions(text, {
+				year: options.year || 2025,
+				strictBigInt: options.strictBigInt !== undefined ? options.strictBigInt : false,
+				mode: "jsonv",
+				preserveComments: true,
+				tolerant: false
+			});
+
+			// Return parse result with minimal ESTree-compatible AST
+			return {
+				ok: true,
+				ast: {
+					type: "Program",
+					body: [],
+					sourceType: "module",
+					comments: [],
+					tokens: []
+				},
+				// Store the parsed jsonv value for potential use by rules
+				jsonvValue: result
+			};
+		} catch (error) {
+			// Return error result
+			return {
+				ok: false,
+				errors: [
+					{
+						message: error.message,
+						line: error.line || 1,
+						column: error.column || 1
+					}
+				]
+			};
+		}
+	},
+
+	/**
+	 * Create source code object
+	 * Required by ESLint 9 language API
+	 *
+	 * @public
+	 * @param {Object} file - The file object
+	 * @param {Object} parseResult - The result from parse()
+	 * @param {Object} context - Context object
+	 * @returns {Object} SourceCode object
+	 */
+	createSourceCode(file, parseResult, context) {
+		const text = typeof file.body === "string" ? file.body : String(file.body || "");
+		const ast = parseResult.ast;
+
+		return {
+			text,
+			ast,
+			lines: text.split(/\r\n|[\r\n\u2028\u2029]/g),
+			hasBOM: text.charCodeAt(0) === 0xfeff,
+
+			// Required methods
+			getLoc(node) {
+				return node.loc || { start: { line: 1, column: 0 }, end: { line: 1, column: 0 } };
+			},
+
+			getRange(node) {
+				return node.range || [0, 0];
+			},
+
+			traverse() {
+				// ESLint expects: { kind: 1 (VISIT), target: node, phase: 1|2, args: [] }
+				// kind: 1 = STEP_KIND_VISIT
+				// phase: 1 = enter, 2 = exit
+				return [
+					{
+						kind: 1,
+						target: ast,
+						phase: 1,
+						args: [ast]
+					},
+					{
+						kind: 1,
+						target: ast,
+						phase: 2,
+						args: [ast]
+					}
+				].values();
+			},
+
+			// Optional helper methods
+			getText(node, beforeCount, afterCount) {
+				if (node && node.range) {
+					const [start, end] = node.range;
+					return text.slice(Math.max(0, start - (beforeCount || 0)), Math.min(text.length, end + (afterCount || 0)));
+				}
+				return text;
+			},
+
+			getLines() {
+				return text.split(/\r\n|[\r\n\u2028\u2029]/g);
+			}
+		};
+	},
+
+	/**
+	 * Validate language options
+	 * Required by ESLint 9 language API
+	 *
+	 * @public
+	 * @param {Object} languageOptions - The language options to validate
+	 * @returns {void}
+	 */
+	validateLanguageOptions(___languageOptions) {
+		// No validation needed - all options are optional
+		// year, strictBigInt, mode, preserveComments, tolerant
+	},
+
+	/**
+	 * Validate language options
+	 * Required by ESLint 9 language API
+	 *
+	 * @public
+	 * @param {Object} languageOptions - The language options to validate
+	 * @returns {void}
+	 */
+	validateLanguageOptions(___languageOptions) {
+		// No validation needed - all options are optional
+		// year, strictBigInt, mode, preserveComments, tolerant
+	},
+
+	/**	 * Default parser options
+	 *
+	 * @public
+	 * @type {Object}
+	 */
+	defaultParserOptions: {
+		year: 2025,
+		strictBigInt: false,
+		mode: "jsonv"
+	}
+};
+
+/**
+ * Recommended configuration for jsonv files
+ *
+ * @public
+ * @type {Object}
+ */
+const recommendedConfig = {
+	languageOptions: {
+		parser: jsonvLanguage
+	},
+	rules: {
+		// Add custom jsonv rules here in the future
+		// For now, parsing validation is enough
+	}
+};
+
+/**
+ * ESLint plugin export
+ *
+ * @public
+ * @type {Object}
+ */
+const plugin = {
+	meta: {
+		name: "eslint-plugin-jsonv",
+		version: "0.1.0"
+	},
+	languages: {
+		jsonv: jsonvLanguage
+	},
+	configs: {
+		recommended: recommendedConfig
+	},
+	rules: {
+		// Future: Add custom rules for jsonv-specific validations
+		// Examples:
+		// - "no-circular-references": enforce no circular internal refs
+		// - "require-bigint-suffix": enforce 'n' suffix for large integers
+		// - "prefer-template-interpolation": prefer ${} over string concat
+		// - "no-duplicate-keys": enforce unique object keys
+	}
+};
+
+export default plugin;

package/package.json

@@ -0,0 +1,73 @@
+{
+	"name": "@cldmv/eslint-plugin-jsonv",
+	"version": "1.0.0",
+	"description": "ESLint plugin for @cldmv/jsonv files",
+	"type": "module",
+	"main": "./dist/index.mjs",
+	"types": "./dist/index.d.mts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.mts",
+			"import": "./dist/index.mjs"
+		}
+	},
+	"scripts": {
+		"build": "npm run build:js && npm run build:types",
+		"build:js": "node scripts/build.mjs",
+		"build:types": "tsc -p .configs/tsconfig.types.json"
+	},
+	"files": [
+		"dist/**",
+		"README.md"
+	],
+	"peerDependencies": {
+		"@cldmv/jsonv": "^1.0.0"
+	},
+	"devDependencies": {
+		"@cldmv/jsonv": "^1.0.0",
+		"typescript": "^5.9.3"
+	},
+	"keywords": [
+		"eslint",
+		"eslintplugin",
+		"jsonv",
+		"json5",
+		"linter",
+		"validation",
+		"parser",
+		"config",
+		"es2015",
+		"es2020",
+		"es2021",
+		"bigint",
+		"numeric-separators"
+	],
+	"author": {
+		"name": "Shinrai",
+		"company": "CLDMV",
+		"email": "git+npm@cldmv.net",
+		"url": "https://cldmv.net"
+	},
+	"contributors": [
+		{
+			"name": "CLDMV",
+			"url": "https://github.com/CLDMV"
+		}
+	],
+	"license": "Apache-2.0",
+	"funding": {
+		"type": "github",
+		"url": "https://github.com/sponsors/shinrai"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/CLDMV/jsonv-eslint-plugin-jsonv.git"
+	},
+	"bugs": {
+		"url": "https://github.com/CLDMV/jsonv-eslint-plugin-jsonv/issues"
+	},
+	"homepage": "https://github.com/CLDMV/jsonv-eslint-plugin-jsonv/#readme",
+	"engines": {
+		"node": ">=18.0.0"
+	}
+}