@speclynx/apidom-parser-adapter-json 2.11.0 → 2.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-parser-adapter-json",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "Parser adapter for parsing JSON documents into base namespace.",
   "publishConfig": {
     "access": "public",
@@ -42,9 +42,9 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-core": "^2.11.0",
-    "@speclynx/apidom-datamodel": "^2.11.0",
-    "@speclynx/apidom-error": "^2.11.0",
+    "@speclynx/apidom-core": "^2.12.0",
+    "@speclynx/apidom-datamodel": "^2.12.0",
+    "@speclynx/apidom-error": "^2.12.0",
     "web-tree-sitter": "=0.26.5"
   },
   "devDependencies": {
@@ -61,5 +61,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "ee7e9488621be61f5dc1b098b8af135dc83c9ac1"
+  "gitHead": "672efe907afef6ae5b547a8028db077297a0c52e"
 }

package/src/adapter.cjs

@@ -51,16 +51,21 @@ exports.detect = detect;
  */
 const parse = async (source, {
   sourceMap = false,
+  style = false,
   strict = false
 } = {}) => {
   if (strict && sourceMap) {
     throw new _apidomError.UnsupportedOperationError('Cannot use sourceMap with strict parsing. Strict parsing does not support source maps.');
   }
+  if (strict && style) {
+    throw new _apidomError.UnsupportedOperationError('Cannot use style with strict parsing. Strict parsing does not support style preservation.');
+  }
   if (strict) {
     return native.parse(source);
   }
   return treeSitter.parse(source, {
-    sourceMap
+    sourceMap,
+    style
   });
 };
 exports.parse = parse;

package/src/adapter.mjs

@@ -42,15 +42,20 @@ export const detect = async (source, {
  */
 export const parse = async (source, {
   sourceMap = false,
+  style = false,
   strict = false
 } = {}) => {
   if (strict && sourceMap) {
     throw new UnsupportedOperationError('Cannot use sourceMap with strict parsing. Strict parsing does not support source maps.');
   }
+  if (strict && style) {
+    throw new UnsupportedOperationError('Cannot use style with strict parsing. Strict parsing does not support style preservation.');
+  }
   if (strict) {
     return native.parse(source);
   }
   return treeSitter.parse(source, {
-    sourceMap
+    sourceMap,
+    style
   });
 };

package/src/tree-sitter/index.cjs

@@ -40,12 +40,14 @@ exports.detect = detect;
  * @public
  */
 const parse = async (source, {
-  sourceMap = false
+  sourceMap = false,
+  style = false
 } = {}) => {
   const cst = await (0, _index.default)(source);
   try {
     return (0, _index2.default)(cst, {
-      sourceMap
+      sourceMap,
+      style
     });
   } finally {
     cst.delete();

package/src/tree-sitter/index.mjs

@@ -35,12 +35,14 @@ export const detect = async source => {
  * @public
  */
 export const parse = async (source, {
-  sourceMap = false
+  sourceMap = false,
+  style = false
 } = {}) => {
   const cst = await lexicalAnalysis(source);
   try {
     return syntacticAnalysis(cst, {
-      sourceMap
+      sourceMap,
+      style
     });
   } finally {
     cst.delete();

package/src/tree-sitter/syntactic-analysis/index.cjs

@@ -26,6 +26,24 @@ const maybeAddSourceMap = (info, element, ctx) => {
   element.endCharacter = info.endPosition.column;
   element.endOffset = info.endIndex;
 };
+
+// build json style object for an element
+const buildJsonStyle = (ctx, extras) => {
+  const jsonStyle = {
+    indent: ctx.indent
+  };
+  if (extras) Object.assign(jsonStyle, extras);
+  return {
+    json: jsonStyle
+  };
+};
+
+// detect indent from an object's first pair child position
+// called during transformChildren when we encounter the first pair
+const detectIndent = (objectColumn, firstPairColumn) => {
+  const diff = firstPairColumn - objectColumn;
+  return diff > 0 ? diff : 2;
+};
 const transform = (cursor, transformerMap, ctx) => {
   const info = getCursorInfo(cursor);
 
@@ -89,11 +107,27 @@ const createTransformers = transformerMap => ({
     const element = new _apidomDatamodel.ObjectElement();
     maybeAddSourceMap(info, element, ctx);
 
+    // Detect indent from first pair if style is enabled and not yet detected
+    if (ctx.style && ctx.indent === 0) {
+      if (cursor.gotoFirstChild()) {
+        do {
+          if (cursor.nodeType === 'pair') {
+            ctx.indent = detectIndent(info.startPosition.column, cursor.startPosition.column);
+            break;
+          }
+        } while (cursor.gotoNextSibling());
+        cursor.gotoParent();
+      }
+    }
+
     // Transform children (pairs)
     const children = transformChildren(cursor, transformerMap, ctx);
     for (const child of children) {
       element.push(child);
     }
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     return element;
   },
   array(cursor, ctx) {
@@ -106,6 +140,9 @@ const createTransformers = transformerMap => ({
     for (const child of children) {
       element.push(child);
     }
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     return element;
   },
   pair(cursor, ctx) {
@@ -147,30 +184,47 @@ const createTransformers = transformerMap => ({
         });
       }
     }
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   number(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new _apidomDatamodel.NumberElement(Number(info.text));
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx, {
+        rawContent: info.text
+      });
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   null(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new _apidomDatamodel.NullElement();
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   true(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new _apidomDatamodel.BooleanElement(true);
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   false(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new _apidomDatamodel.BooleanElement(false);
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
@@ -201,11 +255,14 @@ Object.assign(transformers, createTransformers(transformers));
  * @public
  */
 const analyze = (cst, {
-  sourceMap = false
+  sourceMap = false,
+  style = false
 } = {}) => {
   const cursor = cst.walk();
   const ctx = {
     sourceMap,
+    style,
+    indent: 0,
     annotations: []
   };
   const result = transform(cursor, transformers, ctx);

package/src/tree-sitter/syntactic-analysis/index.mjs

@@ -22,6 +22,24 @@ const maybeAddSourceMap = (info, element, ctx) => {
   element.endCharacter = info.endPosition.column;
   element.endOffset = info.endIndex;
 };
+
+// build json style object for an element
+const buildJsonStyle = (ctx, extras) => {
+  const jsonStyle = {
+    indent: ctx.indent
+  };
+  if (extras) Object.assign(jsonStyle, extras);
+  return {
+    json: jsonStyle
+  };
+};
+
+// detect indent from an object's first pair child position
+// called during transformChildren when we encounter the first pair
+const detectIndent = (objectColumn, firstPairColumn) => {
+  const diff = firstPairColumn - objectColumn;
+  return diff > 0 ? diff : 2;
+};
 const transform = (cursor, transformerMap, ctx) => {
   const info = getCursorInfo(cursor);
 
@@ -85,11 +103,27 @@ const createTransformers = transformerMap => ({
     const element = new ObjectElement();
     maybeAddSourceMap(info, element, ctx);
 
+    // Detect indent from first pair if style is enabled and not yet detected
+    if (ctx.style && ctx.indent === 0) {
+      if (cursor.gotoFirstChild()) {
+        do {
+          if (cursor.nodeType === 'pair') {
+            ctx.indent = detectIndent(info.startPosition.column, cursor.startPosition.column);
+            break;
+          }
+        } while (cursor.gotoNextSibling());
+        cursor.gotoParent();
+      }
+    }
+
     // Transform children (pairs)
     const children = transformChildren(cursor, transformerMap, ctx);
     for (const child of children) {
       element.push(child);
     }
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     return element;
   },
   array(cursor, ctx) {
@@ -102,6 +136,9 @@ const createTransformers = transformerMap => ({
     for (const child of children) {
       element.push(child);
     }
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     return element;
   },
   pair(cursor, ctx) {
@@ -143,30 +180,47 @@ const createTransformers = transformerMap => ({
         });
       }
     }
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   number(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new NumberElement(Number(info.text));
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx, {
+        rawContent: info.text
+      });
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   null(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new NullElement();
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   true(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new BooleanElement(true);
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
   false(cursor, ctx) {
     const info = getCursorInfo(cursor);
     const element = new BooleanElement(false);
+    if (ctx.style) {
+      element.style = buildJsonStyle(ctx);
+    }
     maybeAddSourceMap(info, element, ctx);
     return element;
   },
@@ -197,11 +251,14 @@ Object.assign(transformers, createTransformers(transformers));
  * @public
  */
 const analyze = (cst, {
-  sourceMap = false
+  sourceMap = false,
+  style = false
 } = {}) => {
   const cursor = cst.walk();
   const ctx = {
     sourceMap,
+    style,
+    indent: 0,
     annotations: []
   };
   const result = transform(cursor, transformers, ctx);

package/types/apidom-parser-adapter-json.d.ts

@@ -43,7 +43,7 @@ export declare const namespace: Namespace;
 /**
  * @public
  */
-export declare const parse: (source: string, { sourceMap, strict }?: ParseOptions) => Promise<ParseResultElement>;
+export declare const parse: (source: string, { sourceMap, style, strict }?: ParseOptions) => Promise<ParseResultElement>;
 
 /**
  * @public
@@ -57,6 +57,7 @@ export declare interface ParseDetectOptions {
  */
 export declare interface ParseOptions {
     sourceMap?: boolean;
+    style?: boolean;
     strict?: boolean;
 }
 
@@ -70,8 +71,9 @@ export declare interface ParseOptions {
  * Single pass transformation from CST to ApiDOM.
  * @public
  */
-export declare const syntacticAnalysis: (cst: Tree, { sourceMap }?: {
+export declare const syntacticAnalysis: (cst: Tree, { sourceMap, style }?: {
     sourceMap?: boolean | undefined;
+    style?: boolean | undefined;
 }) => ParseResultElement;
 
 export { Tree }