@speclynx/apidom-parser-adapter-yaml-1-2 1.12.2 → 2.1.0

package/src/syntactic-analysis/indirect/visitors/CstVisitor.mjs

@@ -1,547 +0,0 @@
-import { Error, isNode as isCSTNode, Literal, ParseResult, Point, Position, YamlAlias, YamlAnchor, YamlComment, YamlDirective, YamlDocument, YamlKeyValuePair, YamlMapping, YamlNodeKind, YamlScalar, YamlSequence, YamlStream, YamlStyle, YamlStyleGroup, YamlTag } from '@speclynx/apidom-ast';
-import TreeCursorSyntaxNode from "../../TreeCursorSyntaxNode.mjs";
-export const keyMap = {
-  stream: ['children'],
-  document: ['children'],
-  mapping: ['children'],
-  keyValuePair: ['children'],
-  sequence: ['children'],
-  error: ['children']
-};
-export const isNode = node => Array.isArray(node) || isCSTNode(node);
-class CstVisitor {
-  static isScalar = this.isKind('scalar');
-  static isMapping = this.isKind('mapping');
-  static isSequence = this.isKind('sequence');
-  static isKind(ending) {
-    return node => node != null && typeof node === 'object' && 'type' in node && typeof node.type === 'string' && node.type.endsWith(ending);
-  }
-  static toPosition(node) {
-    const start = new Point({
-      row: node.startPosition.row,
-      column: node.startPosition.column,
-      char: node.startIndex
-    });
-    const end = new Point({
-      row: node.endPosition.row,
-      column: node.endPosition.column,
-      char: node.endIndex
-    });
-    return new Position({
-      start,
-      end
-    });
-  }
-  static kindNodeToYamlAnchor(node) {
-    const {
-      anchor: anchorNode
-    } = node;
-    if (typeof anchorNode === 'undefined') return undefined;
-    return new YamlAnchor({
-      name: anchorNode.text,
-      position: CstVisitor.toPosition(anchorNode)
-    });
-  }
-  static hasKeyValuePairEmptyKey(node) {
-    if (node.type !== 'block_mapping_pair' && node.type !== 'flow_pair') {
-      return false;
-    }
-    // keyNode was not explicitly provided; tag and anchor are missing too
-    return typeof node.keyNode === 'undefined';
-  }
-  static hasKeyValuePairEmptyValue(node) {
-    if (node.type !== 'block_mapping_pair' && node.type !== 'flow_pair') {
-      return false;
-    }
-    // valueNode was not explicitly provided; tag and anchor are missing too
-    return typeof node.valueNode === 'undefined';
-  }
-  static kindNodeToYamlTag(node) {
-    const {
-      tag: tagNode
-    } = node;
-    const explicitName = tagNode?.text || (node.type === 'plain_scalar' ? '?' : '!');
-    const kind = node.type.endsWith('mapping') ? YamlNodeKind.Mapping : node.type.endsWith('sequence') ? YamlNodeKind.Sequence : YamlNodeKind.Scalar;
-    const position = tagNode ? CstVisitor.toPosition(tagNode) : undefined;
-    return new YamlTag({
-      explicitName,
-      kind,
-      position
-    });
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  schema;
-  referenceManager;
-  stream = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      return new YamlStream({
-        children: node.children,
-        position,
-        isMissing: node.isMissing
-      });
-    },
-    leave: stream => {
-      return new ParseResult({
-        children: [stream]
-      });
-    }
-  };
-  yaml_directive = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const version = node?.firstNamedChild?.text;
-      return new YamlDirective({
-        position,
-        name: '%YAML',
-        parameters: {
-          version
-        }
-      });
-    }
-  };
-  tag_directive = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tagHandleNode = node.children[0];
-      const tagPrefixNode = node.children[1];
-      const tagDirective = new YamlDirective({
-        position,
-        name: '%TAG',
-        parameters: {
-          handle: tagHandleNode?.text,
-          prefix: tagPrefixNode?.text
-        }
-      });
-      this.schema.registerTagDirective(tagDirective);
-      return tagDirective;
-    }
-  };
-  reserved_directive = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const directiveNameNode = node.children[0];
-      const directiveParameter1Node = node.children[1];
-      const directiveParameter2Node = node.children[2];
-      return new YamlDirective({
-        position,
-        name: directiveNameNode?.text,
-        parameters: {
-          handle: directiveParameter1Node?.text,
-          prefix: directiveParameter2Node?.text
-        }
-      });
-    }
-  };
-  document = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      return new YamlDocument({
-        children: node.children,
-        position,
-        isMissing: node.isMissing
-      });
-    },
-    leave: node => {
-      node.children = node.children.flat();
-    }
-  };
-  block_node = {
-    enter: node => {
-      return node.children;
-    }
-  };
-  flow_node = {
-    enter: node => {
-      const [kindCandidate] = node.children.slice(-1);
-
-      // kind node is present in flow node
-      if (CstVisitor.isScalar(kindCandidate) || CstVisitor.isMapping(kindCandidate) || CstVisitor.isSequence(kindCandidate)) {
-        return node.children;
-      }
-
-      // kind node not present in flow node, creating empty node
-      const emptyPoint = new Point({
-        row: kindCandidate.endPosition.row,
-        column: kindCandidate.endPosition.column,
-        char: kindCandidate.endIndex
-      });
-      const emptyScalarNode = new YamlScalar({
-        content: '',
-        anchor: CstVisitor.kindNodeToYamlAnchor(kindCandidate),
-        tag: CstVisitor.kindNodeToYamlTag(kindCandidate),
-        position: new Position({
-          start: emptyPoint,
-          end: emptyPoint
-        }),
-        styleGroup: YamlStyleGroup.Flow,
-        style: YamlStyle.Plain
-      });
-      this.registerAnchor(emptyScalarNode);
-      return [...node.children, emptyScalarNode];
-    }
-  };
-  tag = {
-    enter: () => {
-      return null;
-    }
-  };
-  anchor = {
-    enter: () => {
-      return null;
-    }
-  };
-  block_mapping = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const mappingNode = new YamlMapping({
-        children: node.children,
-        position,
-        anchor,
-        tag,
-        styleGroup: YamlStyleGroup.Block,
-        style: YamlStyle.NextLine,
-        isMissing: node.isMissing
-      });
-      this.registerAnchor(mappingNode);
-      return this.schema.resolve(mappingNode);
-    }
-  };
-  block_mapping_pair = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const children = [...node.children];
-      if (CstVisitor.hasKeyValuePairEmptyKey(node)) {
-        const keyNode = this.createKeyValuePairEmptyKey(node);
-        children.unshift(keyNode);
-      }
-      if (CstVisitor.hasKeyValuePairEmptyValue(node)) {
-        const valueNode = this.createKeyValuePairEmptyValue(node);
-        children.push(valueNode);
-      }
-      return new YamlKeyValuePair({
-        children,
-        position,
-        styleGroup: YamlStyleGroup.Block,
-        isMissing: node.isMissing
-      });
-    }
-  };
-  flow_mapping = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const mappingNode = new YamlMapping({
-        children: node.children,
-        position,
-        anchor,
-        tag,
-        styleGroup: YamlStyleGroup.Flow,
-        style: YamlStyle.Explicit,
-        isMissing: node.isMissing
-      });
-      this.registerAnchor(mappingNode);
-      return this.schema.resolve(mappingNode);
-    }
-  };
-  flow_pair = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const children = [...node.children];
-      if (CstVisitor.hasKeyValuePairEmptyKey(node)) {
-        const keyNode = this.createKeyValuePairEmptyKey(node);
-        children.unshift(keyNode);
-      }
-      if (CstVisitor.hasKeyValuePairEmptyValue(node)) {
-        const valueNode = this.createKeyValuePairEmptyValue(node);
-        children.push(valueNode);
-      }
-      return new YamlKeyValuePair({
-        children,
-        position,
-        styleGroup: YamlStyleGroup.Flow,
-        isMissing: node.isMissing
-      });
-    }
-  };
-  keyValuePair = {
-    leave: node => {
-      node.children = node.children.flat();
-    }
-  };
-  block_sequence = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const sequenceNode = new YamlSequence({
-        children: node.children,
-        position,
-        anchor,
-        tag,
-        styleGroup: YamlStyleGroup.Block,
-        style: YamlStyle.NextLine
-      });
-      this.registerAnchor(sequenceNode);
-      return this.schema.resolve(sequenceNode);
-    }
-  };
-  block_sequence_item = {
-    enter: node => {
-      // flow or block node present; first node is always `-` literal
-      if (node.children.length > 1) {
-        return node.children;
-      }
-
-      // create empty node
-      const emptyPoint = new Point({
-        row: node.endPosition.row,
-        column: node.endPosition.column,
-        char: node.endIndex
-      });
-      const emptyScalarNode = new YamlScalar({
-        content: '',
-        tag: new YamlTag({
-          explicitName: '?',
-          kind: YamlNodeKind.Scalar
-        }),
-        position: new Position({
-          start: emptyPoint,
-          end: emptyPoint
-        }),
-        styleGroup: YamlStyleGroup.Flow,
-        style: YamlStyle.Plain
-      });
-      return [emptyScalarNode];
-    }
-  };
-  flow_sequence = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const sequenceNode = new YamlSequence({
-        children: node.children.flat(),
-        position,
-        anchor,
-        tag,
-        styleGroup: YamlStyleGroup.Flow,
-        style: YamlStyle.Explicit
-      });
-      this.registerAnchor(sequenceNode);
-      return this.schema.resolve(sequenceNode);
-    }
-  };
-  sequence = {
-    leave: node => {
-      node.children = node.children.flat(+Infinity);
-    }
-  };
-  plain_scalar = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const scalarNode = new YamlScalar({
-        content: node.text,
-        anchor,
-        tag,
-        position,
-        styleGroup: YamlStyleGroup.Flow,
-        style: YamlStyle.Plain
-      });
-      this.registerAnchor(scalarNode);
-      return this.schema.resolve(scalarNode);
-    }
-  };
-  single_quote_scalar = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const scalarNode = new YamlScalar({
-        content: node.text,
-        anchor,
-        tag,
-        position,
-        styleGroup: YamlStyleGroup.Flow,
-        style: YamlStyle.SingleQuoted
-      });
-      this.registerAnchor(scalarNode);
-      return this.schema.resolve(scalarNode);
-    }
-  };
-  double_quote_scalar = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const scalarNode = new YamlScalar({
-        content: node.text,
-        anchor,
-        tag,
-        position,
-        styleGroup: YamlStyleGroup.Flow,
-        style: YamlStyle.DoubleQuoted
-      });
-      this.registerAnchor(scalarNode);
-      return this.schema.resolve(scalarNode);
-    }
-  };
-  block_scalar = {
-    enter: node => {
-      const position = CstVisitor.toPosition(node);
-      const tag = CstVisitor.kindNodeToYamlTag(node);
-      const anchor = CstVisitor.kindNodeToYamlAnchor(node);
-      const style = node.text.startsWith('|') ? YamlStyle.Literal : node.text.startsWith('>') ? YamlStyle.Folded : YamlStyle.Plain;
-      const scalarNode = new YamlScalar({
-        content: node.text,
-        anchor,
-        tag,
-        position,
-        styleGroup: YamlStyleGroup.Block,
-        style
-      });
-      this.registerAnchor(scalarNode);
-      return this.schema.resolve(scalarNode);
-    }
-  };
-  comment = {
-    enter: node => {
-      return new YamlComment({
-        content: node.text
-      });
-    }
-  };
-  alias = {
-    enter: node => {
-      const alias = new YamlAlias({
-        content: node.text
-      });
-      return this.referenceManager.resolveAlias(alias);
-    }
-  };
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  constructor(schema) {
-    this.schema = schema;
-  }
-  enter(node) {
-    // missing anonymous literals from CST transformed into AST literal nodes
-    if (node instanceof TreeCursorSyntaxNode && !node.isNamed) {
-      const position = CstVisitor.toPosition(node);
-      const value = node.type || node.text;
-      const {
-        isMissing
-      } = node;
-      return new Literal({
-        value,
-        position,
-        isMissing
-      });
-    }
-    return undefined;
-  }
-  ERROR(node, key, parent, path) {
-    const position = CstVisitor.toPosition(node);
-    const errorNode = new Error({
-      children: node.children,
-      position,
-      isUnexpected: !node.hasError,
-      isMissing: node.isMissing,
-      value: node.text
-    });
-    if (path.length === 0) {
-      return new ParseResult({
-        children: [errorNode]
-      });
-    }
-    return errorNode;
-  }
-  registerAnchor(node) {
-    if (node.anchor !== undefined) {
-      this.referenceManager.addAnchor(node);
-    }
-  }
-  createKeyValuePairEmptyKey(node) {
-    const emptyPoint = new Point({
-      row: node.startPosition.row,
-      column: node.startPosition.column,
-      char: node.startIndex
-    });
-    const {
-      keyNode
-    } = node;
-    const children = keyNode?.children || [];
-    const tagNode = children.find(CstVisitor.isKind('tag'));
-    const anchorNode = children.find(CstVisitor.isKind('anchor'));
-    const tag = typeof tagNode !== 'undefined' ? new YamlTag({
-      explicitName: tagNode.text,
-      kind: YamlNodeKind.Scalar,
-      position: CstVisitor.toPosition(tagNode)
-    }) : new YamlTag({
-      explicitName: '?',
-      kind: YamlNodeKind.Scalar
-    });
-    const anchor = typeof anchorNode !== 'undefined' ? new YamlAnchor({
-      name: anchorNode.text,
-      position: CstVisitor.toPosition(anchorNode)
-    }) : undefined;
-    const scalarNode = new YamlScalar({
-      content: '',
-      position: new Position({
-        start: emptyPoint,
-        end: emptyPoint
-      }),
-      tag,
-      anchor,
-      styleGroup: YamlStyleGroup.Flow,
-      style: YamlStyle.Plain
-    });
-    this.registerAnchor(scalarNode);
-    return scalarNode;
-  }
-  createKeyValuePairEmptyValue(node) {
-    const emptyPoint = new Point({
-      row: node.endPosition.row,
-      column: node.endPosition.column,
-      char: node.endIndex
-    });
-    const {
-      valueNode
-    } = node;
-    const children = valueNode?.children || [];
-    const tagNode = children.find(CstVisitor.isKind('tag'));
-    const anchorNode = children.find(CstVisitor.isKind('anchor'));
-    const tag = typeof tagNode !== 'undefined' ? new YamlTag({
-      explicitName: tagNode.text,
-      kind: YamlNodeKind.Scalar,
-      position: CstVisitor.toPosition(tagNode)
-    }) : new YamlTag({
-      explicitName: '?',
-      kind: YamlNodeKind.Scalar
-    });
-    const anchor = typeof anchorNode !== 'undefined' ? new YamlAnchor({
-      name: anchorNode.text,
-      position: CstVisitor.toPosition(anchorNode)
-    }) : undefined;
-    const scalarNode = new YamlScalar({
-      content: '',
-      position: new Position({
-        start: emptyPoint,
-        end: emptyPoint
-      }),
-      tag,
-      anchor,
-      styleGroup: YamlStyleGroup.Flow,
-      style: YamlStyle.Plain
-    });
-    this.registerAnchor(scalarNode);
-    return scalarNode;
-  }
-}
-export default CstVisitor;

package/src/syntactic-analysis/indirect/visitors/YamlAstVisitor.cjs

@@ -1,164 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.keyMap = exports.isNode = exports.getNodeType = exports.default = void 0;
-var _apidomAst = require("@speclynx/apidom-ast");
-var _apidomCore = require("@speclynx/apidom-core");
-const keyMap = exports.keyMap = {
-  stream: ['children'],
-  document: ['children'],
-  mapping: ['children'],
-  keyValuePair: ['children'],
-  sequence: ['children'],
-  error: ['children'],
-  ..._apidomCore.keyMap
-};
-const getNodeType = node => {
-  if ((0, _apidomCore.isElement)(node)) {
-    return (0, _apidomCore.getNodeType)(node);
-  }
-  return (0, _apidomAst.getNodeType)(node);
-};
-exports.getNodeType = getNodeType;
-const isNode = node => (0, _apidomCore.isElement)(node) || (0, _apidomAst.isNode)(node) || Array.isArray(node);
-exports.isNode = isNode;
-class YamlAstVisitor {
-  sourceMap = false;
-  annotations;
-  namespace;
-  processedDocumentCount = 0;
-  stream = {
-    leave: node => {
-      const element = new _apidomCore.ParseResultElement();
-      // @ts-ignore
-      element._content = node.children.flat(1);
-
-      // mark first-non Annotation element as result
-      // @ts-ignore
-      const elements = element.findElements(_apidomCore.isPrimitiveElement);
-      if (elements.length > 0) {
-        const resultElement = elements[0];
-        resultElement.classes.push('result');
-      }
-
-      // provide annotations
-      this.annotations.forEach(annotationElement => {
-        element.push(annotationElement);
-      });
-      this.annotations = [];
-      return element;
-    }
-  };
-  constructor() {
-    this.annotations = [];
-    this.namespace = (0, _apidomCore.createNamespace)();
-  }
-  comment(node) {
-    const isStreamComment = this.processedDocumentCount === 0;
-
-    // we're only interested of stream comments before the first document
-    if (isStreamComment) {
-      // @ts-ignore
-      const element = new _apidomCore.CommentElement(node.content);
-      this.maybeAddSourceMap(node, element);
-      return element;
-    }
-    return null;
-  }
-  document(node) {
-    const shouldWarnAboutMoreDocuments = this.processedDocumentCount === 1;
-    const shouldSkipVisitingMoreDocuments = this.processedDocumentCount >= 1;
-    if (shouldWarnAboutMoreDocuments) {
-      const message = 'Only first document within YAML stream will be used. Rest will be discarded.';
-      const element = new _apidomCore.AnnotationElement(message);
-      element.classes.push('warning');
-      this.maybeAddSourceMap(node, element);
-      this.annotations.push(element);
-    }
-    if (shouldSkipVisitingMoreDocuments) {
-      return null;
-    }
-    this.processedDocumentCount += 1;
-    return node.children;
-  }
-  mapping(node) {
-    const element = new _apidomCore.ObjectElement();
-    // @ts-ignore
-    element._content = node.children;
-    this.maybeAddSourceMap(node, element);
-    return element;
-  }
-  keyValuePair(node) {
-    const element = new _apidomCore.MemberElement();
-
-    // @ts-ignore
-    element.content.key = node.key;
-    // @ts-ignore
-    element.content.value = node.value;
-    this.maybeAddSourceMap(node, element);
-
-    // process possible errors here that may be present in property node children as we're using direct field access
-    node.children
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    .filter(child => child.type === 'error')
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    .forEach(errorNode => {
-      this.error(errorNode, node, [], [node]);
-    });
-    return element;
-  }
-  sequence(node) {
-    const element = new _apidomCore.ArrayElement();
-    // @ts-ignore
-    element._content = node.children;
-    this.maybeAddSourceMap(node, element);
-    return element;
-  }
-  scalar(node) {
-    const element = this.namespace.toElement(node.content);
-
-    // translate style information about empty nodes
-    if (node.content === '' && node.style === _apidomAst.YamlStyle.Plain) {
-      element.classes.push('yaml-e-node');
-      element.classes.push('yaml-e-scalar');
-    }
-    this.maybeAddSourceMap(node, element);
-    return element;
-  }
-  literal(node) {
-    if (node.isMissing) {
-      const message = `(Missing ${node.value})`;
-      const element = new _apidomCore.AnnotationElement(message);
-      element.classes.push('warning');
-      this.maybeAddSourceMap(node, element);
-      this.annotations.push(element);
-    }
-    return null;
-  }
-  error(node, key, parent, path) {
-    const message = node.isUnexpected ? '(Unexpected YAML syntax error)' : '(Error YAML syntax error)';
-    const element = new _apidomCore.AnnotationElement(message);
-    element.classes.push('error');
-    this.maybeAddSourceMap(node, element);
-    if (path.length === 0) {
-      // no document to visit, only error is present in CST
-      const parseResultElement = new _apidomCore.ParseResultElement();
-      parseResultElement.push(element);
-      return parseResultElement;
-    }
-    this.annotations.push(element);
-    return null;
-  }
-  maybeAddSourceMap(node, element) {
-    if (!this.sourceMap) {
-      return;
-    }
-    const sourceMap = new _apidomCore.SourceMapElement();
-    // @ts-ignore
-    sourceMap.position = node.position;
-    // @ts-ignore
-    sourceMap.astNode = node;
-    element.meta.set('sourceMap', sourceMap);
-  }
-}
-var _default = exports.default = YamlAstVisitor;