@markuplint/parser-utils 1.6.1 → 2.0.0-dev.23

package/lib/const.d.ts

@@ -1,2 +1,8 @@
 export declare const MASK_CHAR = "\uE000";
 export declare const rePCEN: RegExp;
+/**
+ * SVG Element list
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element
+ */
+export declare const svgElementList: string[];

package/lib/const.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rePCEN = exports.MASK_CHAR = void 0;
+exports.svgElementList = exports.rePCEN = exports.MASK_CHAR = void 0;
 exports.MASK_CHAR = '\uE000';
 /**
  * PotentialCustomElementName
@@ -38,3 +38,98 @@ const rePCENChar = [
     '[\uD800-\uDBFF][\uDC00-\uDFFF]',
 ].join('|');
 exports.rePCEN = new RegExp(`^[a-z](?:${rePCENChar})*\\-(?:${rePCENChar})*$`, 'i');
+/**
+ * SVG Element list
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Element
+ */
+exports.svgElementList = [
+    'a',
+    'animate',
+    'animateMotion',
+    'animateTransform',
+    'circle',
+    'clipPath',
+    'defs',
+    'desc',
+    'discard',
+    'ellipse',
+    'feBlend',
+    'feColorMatrix',
+    'feComponentTransfer',
+    'feComposite',
+    'feConvolveMatrix',
+    'feDiffuseLighting',
+    'feDisplacementMap',
+    'feDistantLight',
+    'feDropShadow',
+    'feFlood',
+    'feFuncA',
+    'feFuncB',
+    'feFuncG',
+    'feFuncR',
+    'feGaussianBlur',
+    'feImage',
+    'feMerge',
+    'feMergeNode',
+    'feMorphology',
+    'feOffset',
+    'fePointLight',
+    'feSpecularLighting',
+    'feSpotLight',
+    'feTile',
+    'feTurbulence',
+    'filter',
+    'foreignObject',
+    'g',
+    'hatch',
+    'hatchpath',
+    'image',
+    'line',
+    'linearGradient',
+    'marker',
+    'mask',
+    'mesh',
+    'meshgradient',
+    'meshpatch',
+    'meshrow',
+    'metadata',
+    'mpath',
+    'path',
+    'pattern',
+    'polygon',
+    'polyline',
+    'radialGradient',
+    'rect',
+    'script',
+    'set',
+    'stop',
+    'style',
+    'svg',
+    'switch',
+    'symbol',
+    'text',
+    'textPath',
+    'title',
+    'tspan',
+    'use',
+    'view',
+    // Below: Obsolete and deprecated elements
+    'altGlyph',
+    'altGlyphDef',
+    'altGlyphItem',
+    'animateColor',
+    'cursor',
+    'font',
+    'font-face',
+    'font-face-format',
+    'font-face-name',
+    'font-face-src',
+    'font-face-uri',
+    'glyph',
+    'glyphRef',
+    'hkern',
+    'missing-glyph',
+    'tref',
+    'vkern',
+];

package/lib/create-token.d.ts

@@ -0,0 +1,4 @@
+import type { MLToken } from '@markuplint/ml-ast';
+export declare function tokenizer(raw: string | null, startLine: number, startCol: number, startOffset: number): MLToken;
+export declare function createTokenFromRawCode(raw: string | null, startOffset: number, rawCode: string): MLToken;
+export declare function uuid(): string;

package/lib/create-token.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uuid = exports.createTokenFromRawCode = exports.tokenizer = void 0;
+const uuid_1 = require("uuid");
+const get_location_1 = require("./get-location");
+function tokenizer(raw, startLine, startCol, startOffset) {
+    raw = raw || '';
+    const endLine = (0, get_location_1.getEndLine)(raw, startLine);
+    const endCol = (0, get_location_1.getEndCol)(raw, startCol);
+    const endOffset = startOffset + raw.length;
+    return {
+        uuid: uuid(),
+        raw,
+        startOffset,
+        endOffset,
+        startLine,
+        endLine,
+        startCol,
+        endCol,
+    };
+}
+exports.tokenizer = tokenizer;
+function createTokenFromRawCode(raw, startOffset, rawCode) {
+    raw = raw || '';
+    const loc = (0, get_location_1.sliceFragment)(rawCode, startOffset, startOffset + raw.length);
+    return {
+        uuid: uuid(),
+        ...loc,
+    };
+}
+exports.createTokenFromRawCode = createTokenFromRawCode;
+function uuid() {
+    return (0, uuid_1.v4)();
+}
+exports.uuid = uuid;

package/lib/debugger.d.ts

@@ -0,0 +1,3 @@
+import type { MLASTAttr, MLASTNode } from '@markuplint/ml-ast';
+export declare function nodeListToDebugMaps(nodeList: MLASTNode[], withAttr?: boolean): string[];
+export declare function attributesToDebugMaps(attributes: MLASTAttr[]): string[][];

package/lib/debugger.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attributesToDebugMaps = exports.nodeListToDebugMaps = void 0;
+function nodeListToDebugMaps(nodeList, withAttr = false) {
+    return nodeList
+        .map(n => {
+        const r = [];
+        if (!n.isGhost) {
+            r.push(tokenDebug(n));
+            if (withAttr && 'attributes' in n) {
+                r.push(...attributesToDebugMaps(n.attributes).flat());
+            }
+        }
+        else {
+            r.push(`[N/A]>[N/A](N/A)${n.nodeName}: ${visibleWhiteSpace(n.raw)}`);
+        }
+        return r;
+    })
+        .flat();
+}
+exports.nodeListToDebugMaps = nodeListToDebugMaps;
+function attributesToDebugMaps(attributes) {
+    return attributes.map(n => {
+        const r = [
+            tokenDebug({
+                ...n,
+                name: n.type === 'html-attr' ? n.name.raw : n.raw,
+            }),
+        ];
+        if (n.type === 'html-attr') {
+            r.push(`  ${tokenDebug(n.spacesBeforeName, 'bN')}`);
+            r.push(`  ${tokenDebug(n.name, 'name')}`);
+            r.push(`  ${tokenDebug(n.spacesBeforeEqual, 'bE')}`);
+            r.push(`  ${tokenDebug(n.equal, 'equal')}`);
+            r.push(`  ${tokenDebug(n.spacesAfterEqual, 'aE')}`);
+            r.push(`  ${tokenDebug(n.startQuote, 'sQ')}`);
+            r.push(`  ${tokenDebug(n.value, 'value')}`);
+            r.push(`  ${tokenDebug(n.endQuote, 'eQ')}`);
+            r.push(`  isDirective: ${!!n.isDirective}`);
+            r.push(`  isDynamicValue: ${!!n.isDynamicValue}`);
+        }
+        if (n.potentialName != null) {
+            r.push(`  potentialName: ${visibleWhiteSpace(n.potentialName)}`);
+        }
+        if (n.type === 'html-attr' && n.candidate) {
+            r.push(`  candidate: ${visibleWhiteSpace(n.candidate)}`);
+        }
+        return r;
+    });
+}
+exports.attributesToDebugMaps = attributesToDebugMaps;
+function tokenDebug(n, type = '') {
+    return `[${n.startLine}:${n.startCol}]>[${n.endLine}:${n.endCol}](${n.startOffset},${n.endOffset})${n.nodeName || n.potentialName || n.name || n.type || type}: ${visibleWhiteSpace(n.raw)}`;
+}
+function visibleWhiteSpace(chars) {
+    return chars.replace(/\n/g, '⏎').replace(/\t/g, '→').replace(/\s/g, '␣');
+}

package/lib/decision.d.ts

@@ -0,0 +1,29 @@
+/**
+ *
+ *
+ * @param nodeName
+ * @returns
+ */
+export declare function isSVGElement(nodeName: string): boolean;
+/**
+ * valid name of custom element
+ *
+ * @see https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
+ *
+ * > - name must match the [PotentialCustomElementName](https://html.spec.whatwg.org/multipage/custom-elements.html#prod-potentialcustomelementname) production
+ * > - name must not be any of the following:
+ * >   - `<annotation-xml>`
+ * >   - `<color-profile>`
+ * >   - `<font-face>`
+ * >   - `<font-face-src>`
+ * >   - `<font-face-uri>`
+ * >   - `<font-face-format>`
+ * >   - `<font-face-name>`
+ * >   - `<missing-glyph>`
+ *
+ * ASCII-case-insensitively.
+ * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
+ *
+ * @param tagName
+ */
+export declare function isPotentialCustomElementName(tagName: string): boolean;

package/lib/decision.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPotentialCustomElementName = exports.isSVGElement = void 0;
+const const_1 = require("./const");
+/**
+ *
+ *
+ * @param nodeName
+ * @returns
+ */
+function isSVGElement(nodeName) {
+    return const_1.svgElementList.includes(nodeName);
+}
+exports.isSVGElement = isSVGElement;
+/**
+ * valid name of custom element
+ *
+ * @see https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
+ *
+ * > - name must match the [PotentialCustomElementName](https://html.spec.whatwg.org/multipage/custom-elements.html#prod-potentialcustomelementname) production
+ * > - name must not be any of the following:
+ * >   - `<annotation-xml>`
+ * >   - `<color-profile>`
+ * >   - `<font-face>`
+ * >   - `<font-face-src>`
+ * >   - `<font-face-uri>`
+ * >   - `<font-face-format>`
+ * >   - `<font-face-name>`
+ * >   - `<missing-glyph>`
+ *
+ * ASCII-case-insensitively.
+ * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
+ *
+ * @param tagName
+ */
+function isPotentialCustomElementName(tagName) {
+    switch (tagName) {
+        case 'annotation-xml':
+        case 'color-profile':
+        case 'font-face':
+        case 'font-face-src':
+        case 'font-face-uri':
+        case 'font-face-format':
+        case 'font-face-name':
+        case 'missing-glyph': {
+            return false;
+        }
+    }
+    return const_1.rePCEN.test(tagName);
+}
+exports.isPotentialCustomElementName = isPotentialCustomElementName;

package/lib/get-location.d.ts

@@ -0,0 +1,13 @@
+export declare function getLine(html: string, startOffset: number): number;
+export declare function getCol(html: string, startOffset: number): number;
+export declare function getEndLine(html: string, line: number): number;
+export declare function getEndCol(html: string, col: number): number;
+export declare function sliceFragment(rawHtml: string, start: number, end: number): {
+    startOffset: number;
+    endOffset: number;
+    startLine: number;
+    endLine: number;
+    startCol: number;
+    endCol: number;
+    raw: string;
+};

package/lib/get-location.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sliceFragment = exports.getEndCol = exports.getEndLine = exports.getCol = exports.getLine = void 0;
+function getLine(html, startOffset) {
+    return html.slice(0, startOffset).split(/\n/g).length;
+}
+exports.getLine = getLine;
+function getCol(html, startOffset) {
+    const lines = html.slice(0, startOffset).split(/\n/g);
+    return lines[lines.length - 1].length + 1;
+}
+exports.getCol = getCol;
+function getEndLine(html, line) {
+    return html.split(/\r?\n/).length - 1 + line;
+}
+exports.getEndLine = getEndLine;
+function getEndCol(html, col) {
+    const lines = html.split(/\r?\n/);
+    const lineCount = lines.length;
+    const lastLine = lines.pop();
+    return lineCount > 1 ? lastLine.length + 1 : col + html.length;
+}
+exports.getEndCol = getEndCol;
+function sliceFragment(rawHtml, start, end) {
+    const raw = rawHtml.slice(start, end);
+    return {
+        startOffset: start,
+        endOffset: end,
+        startLine: getLine(rawHtml, start),
+        endLine: getLine(rawHtml, end),
+        startCol: getCol(rawHtml, start),
+        endCol: getCol(rawHtml, end),
+        raw,
+    };
+}
+exports.sliceFragment = sliceFragment;

package/lib/idl-attributes.d.ts

@@ -0,0 +1,4 @@
+export declare function searchIDLAttribute(name: string): {
+    idlPropName: string | undefined;
+    contentAttrName: string | undefined;
+};