@bhsd/lezer-json 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2020 by Marijn Haverbeke <marijn@haverbeke.berlin>, Arun Srinivasan <rulfzid@gmail.com>, and others
+
+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,42 @@
+# @bhsd/lezer-json
+
+This is a fork of [@lezer/json](https://www.npmjs.com/package/@lezer/json) and [@codemirror/lang-json](https://www.npmjs.com/package/@codemirror/lang-json) that adds a dialect for [JSONC](https://jsonc.org/) to provide support for comments and trailing commas.
+
+## Installation
+
+You can install the package via npm and import it as a module:
+
+```bash
+npm install @bhsd/lezer-json
+```
+
+## Language Support
+
+```ts
+import {json} from '@bhsd/lezer-json';
+import type {LanguageSupport} from '@codemirror/language';
+
+const jsonLanguageSupport: LanguageSupport = json(),
+	jsoncLanguageSupport: LanguageSupport = json('jsonc');
+```
+
+## Language
+
+You can also import the [LR language](https://codemirror.net/docs/ref/#language.LRLanguage) for JSON or JSONC alone.
+
+```ts
+import {jsonLanguage, jsoncLanguage} from '@bhsd/lezer-json';
+```
+
+## Lint Source
+
+This package also provides [lint sources](https://codemirror.net/docs/ref/#lint.LintSource) for JSON or JSONC syntax checking.
+
+```ts
+import {linter} from '@codemirror/lint';
+import {jsonLinter, jsoncLinter} from '@bhsd/lezer-json';
+import type {Extension} from '@codemirror/state';
+
+const jsonLintExtension: Extension = linter(jsonLinter),
+	jsoncLintExtension: Extension = linter(jsoncLinter);
+```

package/dist/highlight.d.ts

@@ -0,0 +1 @@
+export declare const jsonHighlighting: import("@lezer/common").NodePropSource;

package/dist/highlight.js

@@ -0,0 +1,13 @@
+import { styleTags, tags as t } from '@lezer/highlight';
+export const jsonHighlighting = styleTags({
+    LineComment: t.lineComment,
+    BlockComment: t.blockComment,
+    String: t.string,
+    Number: t.number,
+    'True False': t.bool,
+    PropertyName: t.propertyName,
+    Null: t.null,
+    ', :': t.separator,
+    '[ ]': t.squareBracket,
+    '{ }': t.brace,
+});

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { LRLanguage, LanguageSupport } from '@codemirror/language';
+import type { LintSource } from '@codemirror/lint';
+/** LR language for JSON. */
+export declare const jsonLanguage: LRLanguage;
+/** LR language for JSONC. */
+export declare const jsoncLanguage: LRLanguage;
+/**
+ * Get language support for JSON or JSONC.
+ * @param dialect The dialect to use, either omitted or `'jsonc'` for JSON with comments.
+ */
+export declare const json: (dialect?: "jsonc") => LanguageSupport;
+/** Lint source for JSON */
+export declare const jsonLinter: LintSource;
+/** Lint source for JSONC */
+export declare const jsoncLinter: LintSource;

package/dist/index.js

@@ -0,0 +1,44 @@
+import { continuedIndent, indentNodeProp, foldNodeProp, foldInside, LRLanguage, LanguageSupport, } from '@codemirror/language';
+import { lintJSON, lintJSONC } from '@bhsd/common';
+import { parser } from './parser.js';
+const props = [
+    indentNodeProp.add({
+        Object: continuedIndent({ except: /^\s*\}/u }),
+        Array: continuedIndent({ except: /^\s*\]/u }),
+    }),
+    foldNodeProp.add({
+        'Object Array': foldInside,
+    }),
+], languageData = {
+    closeBrackets: { brackts: ['[', '{', '"'] },
+    indentOnInput: /^\s*[}\]]$/u,
+};
+/** LR language for JSON. */
+export const jsonLanguage = LRLanguage.define({
+    name: 'json',
+    parser: parser.configure({ props }),
+    languageData,
+});
+/** LR language for JSONC. */
+export const jsoncLanguage = LRLanguage.define({
+    name: 'jsonc',
+    parser: parser.configure({ props, dialect: 'jsonc' }),
+    languageData: {
+        ...languageData,
+        commentTokens: {
+            line: '//',
+            block: { open: '/*', close: '*/' },
+        },
+    },
+});
+/**
+ * Get language support for JSON or JSONC.
+ * @param dialect The dialect to use, either omitted or `'jsonc'` for JSON with comments.
+ */
+export const json = (dialect) => new LanguageSupport(dialect === 'jsonc' ? jsoncLanguage : jsonLanguage);
+const getLintSource = (lint) => ({ state: { doc } }) => lint(doc.toString())
+    .map(({ message, from, to = from, severity }) => ({ message, severity, from, to }));
+/** Lint source for JSON */
+export const jsonLinter = /* @__PURE__ */ getLintSource(lintJSON);
+/** Lint source for JSONC */
+export const jsoncLinter = /* @__PURE__ */ getLintSource(lintJSONC);

package/dist/parser.js

@@ -0,0 +1,24 @@
+// This file was generated by lezer-generator. You probably shouldn't edit it.
+import {LRParser, LocalTokenGroup} from "@lezer/lr"
+import {jsonHighlighting} from "./highlight.js"
+export const parser = LRParser.deserialize({
+  version: 14,
+  states: "&YO]QPOOPtOPOOOOQO'#Cd'#CdOyQPO'#CgO!UQPO'#CoOOQO'#Cy'#CyQOQPOOP!`OSO'#C^POOO)C>j)C>jOOQO'#Ci'#CiO!hQPO'#ChO!mQQO'#C{OOQO'#C{'#C{OOQO,59R,59RO!uQPO,59RO!zQQO'#C|OOQO'#C|'#C|OOQO,59Z,59ZO#SQPO,59ZPOOO'#Cp'#CpP#XOSO,58xPOOO,58x,58xO]QPO,59SO#aQPO,59gO#iQQO,59gOOQO1G.m1G.mO#qQPO,59hO#xQQO,59hOOQO1G.u1G.uPOOO-E6n-E6nPOOO1G.d1G.dOOQO1G.n1G.nOOQO,59],59]O$QQPO1G/ROOQO-E6o-E6oOOQO,59^,59^O$YQPO1G/SOOQO-E6p-E6pP!PQPO'#CqP]QPO'#Cr",
+  stateData: "$e~OiOSPOSjPQ~OSTOTTOUTOVTOYRObSOnQO~OjVO~OX]O`[OnXO~O``OaaO~P]OkcOleO~O^fO~O_gOXoX~OXiO~O_jOapX~OalO~OkcOlnO~OnXOXoa~O_qOXoa~Oapa~P]O_tOapa~OnXOXoi~Oapi~P]OPj`~",
+  goto: "#TqPPrPPPPPuPPu}!VPPPPPu!]!c!iPPPPPP!oP!}#QRWP]TOSfjtwQZRVpgqvXYRgqvQdVRmdQhZRrhQk_RukQUOQ_SQofVsjtwR^RRbS",
+  nodeNames: "⚠ LineComment BlockComment JsonText True False Null Number String } { Object Property PropertyName : , , ] [ Array",
+  maxTerm: 32,
+  nodeProps: [
+    ["isolate", -2,8,13,""],
+    ["openedBy", 9,"{",17,"["],
+    ["closedBy", 10,"}",18,"]"]
+  ],
+  propSources: [jsonHighlighting],
+  skippedNodes: [0,1,2,20],
+  repeatNodeCount: 3,
+  tokenData: ")x~RbXY!ZYZ!Z]^!Zpq!Zrs!`|}$x}!O%P!P!Q&y!Q!R%Y!R![&h![!]'p!}#O'u#P#Q'z#Y#Z(P#b#c(n#h#i)V#o#p)n#q#r)s~!`Oi~~!cWpq!`qr!`rs!{s#O!`#O#P#Q#P;'S!`;'S;=`$r<%lO!`~#QOn~~#TXrs!`!P!Q!`#O#P!`#U#V!`#Y#Z!`#b#c!`#f#g!`#h#i!`#i#j#p~#sR!Q![#|!c!i#|#T#Z#|~$PR!Q![$Y!c!i$Y#T#Z$Y~$]R!Q![$f!c!i$f#T#Z$f~$iR!Q![!`!c!i!`#T#Z!`~$uP;=`<%l!`U%PO_S`Q~%SQ!Q!R%Y!R![&h~%_RV~!O!P%h!g!h%|#X#Y%|~%kP!Q![%n~%sRV~!Q![%n!g!h%|#X#Y%|~&PR{|&Y}!O&Y!Q![&`~&]P!Q![&`~&ePV~!Q![&`~&mSV~!O!P%h!Q![&h!g!h%|#X#Y%|~&|Qz{'S!P!Q'X~'XOj~~'^SP~OY'XZ;'S'X;'S;=`'j<%lO'X~'mP;=`<%l'X~'uO^~~'zOb~~(POa~~(SP#T#U(V~(YP#`#a(]~(`P#g#h(c~(fP#X#Y(i~(nOT~~(qP#i#j(t~(wP#`#a(z~(}P#`#a)Q~)VOU~~)YP#f#g)]~)`P#i#j)c~)fP#X#Y)i~)nOS~~)sOY~~)xOX~",
+  tokenizers: [1, 2, new LocalTokenGroup("b~RPz{U~XP!P!Q[~aOl~~", 17, 27)],
+  topRules: {"JsonText":[0,3]},
+  dialects: {jsonc: 155},
+  tokenPrec: 0
+})

package/package.json

@@ -0,0 +1,56 @@
+{
+	"name": "@bhsd/lezer-json",
+	"version": "2.0.0",
+	"description": "Lezer-based JSON/JSONC grammar",
+	"keywords": [
+		"codemirror",
+		"lezer",
+		"json",
+		"jsonc"
+	],
+	"homepage": "https://github.com/bhsd-harry/lezer-json#readme",
+	"bugs": {
+		"url": "https://github.com/bhsd-harry/lezer-json/issues"
+	},
+	"license": "MIT",
+	"contributors": [
+		"Arun Srinivasan <rulfzid@gmail.com>",
+		"Marijn Haverbeke <marijn@haverbeke.berlin>",
+		"Bhsd"
+	],
+	"files": [
+		"dist/"
+	],
+	"browser": "dist/index.js",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"type": "module",
+	"sideEffects": false,
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/bhsd-harry/lezer-json.git"
+	},
+	"scripts": {
+		"ls": "npm i --package-lock-only && npm ls --package-lock-only --all --omit=dev",
+		"prepublishOnly": "npm run build",
+		"build:parser": "lezer-generator src/json.grammar -o src/parser.js",
+		"build:core": "tsc && cp src/parser.js dist/",
+		"build": "npm run build:parser && npm run build:core",
+		"lint:ts": "tsc --noEmit && eslint --cache .",
+		"lint:md": "markdownlint-cli2 '**/*.md'",
+		"lint": "npm run lint:ts && npm run lint:md"
+	},
+	"dependencies": {
+		"@bhsd/common": "^2.2.1",
+		"@codemirror/language": "^6.12.3",
+		"@codemirror/lint": "^6.9.5"
+	},
+	"devDependencies": {
+		"@bhsd/code-standard": "^2.4.2",
+		"@lezer/generator": "^1.8.0",
+		"@typescript-eslint/parser": "^8.59.2",
+		"eslint": "^10.3.0",
+		"markdownlint-cli2": "^0.22.1",
+		"typescript": "^6.0.3"
+	}
+}