@markuplint/ml-core 2.0.0-rc.0 → 2.0.0-rc.6

package/lib/index.d.ts

@@ -1,8 +1,8 @@
 export { RuleInfo, RuleConfig, RuleConfigValue } from '@markuplint/ml-config';
+export { getAttrSpecs } from '@markuplint/ml-spec';
 export * from './convert-ruleset';
 export * from './ml-core';
 export * from './ml-rule';
-export { default as MLParseError } from './ml-error/ml-parse-error';
 export { default as Ruleset } from './ruleset';
 export * from './ml-dom';
 export * from './plugin';

package/lib/index.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.enableDebug = exports.getIndent = exports.Ruleset = exports.MLParseError = void 0;
+exports.enableDebug = exports.getIndent = exports.Ruleset = exports.getAttrSpecs = void 0;
 const tslib_1 = require("tslib");
+var ml_spec_1 = require("@markuplint/ml-spec");
+Object.defineProperty(exports, "getAttrSpecs", { enumerable: true, get: function () { return ml_spec_1.getAttrSpecs; } });
 (0, tslib_1.__exportStar)(require("./convert-ruleset"), exports);
 (0, tslib_1.__exportStar)(require("./ml-core"), exports);
 (0, tslib_1.__exportStar)(require("./ml-rule"), exports);
-var ml_parse_error_1 = require("./ml-error/ml-parse-error");
-Object.defineProperty(exports, "MLParseError", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(ml_parse_error_1).default; } });
 var ruleset_1 = require("./ruleset");
 Object.defineProperty(exports, "Ruleset", { enumerable: true, get: function () { return (0, tslib_1.__importDefault)(ruleset_1).default; } });
 (0, tslib_1.__exportStar)(require("./ml-dom"), exports);

package/lib/ml-core.d.ts

@@ -1,7 +1,7 @@
 import type { MLFabric } from './types';
 import type { RuleConfigValue, Violation } from '@markuplint/ml-config';
+import { ParserError } from '@markuplint/parser-utils';
 import { Document } from './ml-dom';
-import MLParseError from './ml-error/ml-parse-error';
 export declare type MLCoreParams = {
     sourceCode: string;
     filename: string;
@@ -10,9 +10,10 @@ export declare type MLCoreParams = {
 export declare class MLCore {
     #private;
     constructor({ parser, sourceCode, ruleset, rules, locale, schemas, parserOptions, filename, debug }: MLCoreParams);
-    get document(): MLParseError | Document<RuleConfigValue, unknown>;
+    get document(): ParserError | Document<RuleConfigValue, unknown>;
     verify(fix?: boolean): Promise<Violation[]>;
     setCode(sourceCode: string): void;
     update({ parser, ruleset, rules, locale, schemas, parserOptions }: Partial<MLFabric>): void;
+    private _parse;
     private _createDocument;
 }

package/lib/ml-core.js

@@ -3,10 +3,9 @@ var _MLCore_filename, _MLCore_document, _MLCore_parser, _MLCore_sourceCode, _MLC
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MLCore = void 0;
 const tslib_1 = require("tslib");
+const parser_utils_1 = require("@markuplint/parser-utils");
 const debug_1 = require("./debug");
 const ml_dom_1 = require("./ml-dom");
-const ml_parse_error_1 = (0, tslib_1.__importDefault)(require("./ml-error/ml-parse-error"));
-const _1 = require(".");
 const resultLog = debug_1.log.extend('result');
 class MLCore {
     constructor({ parser, sourceCode, ruleset, rules, locale, schemas, parserOptions, filename, debug }) {
@@ -15,12 +14,15 @@ class MLCore {
         _MLCore_document.set(this, void 0);
         _MLCore_parser.set(this, void 0);
         _MLCore_sourceCode.set(this, void 0);
-        _MLCore_ast.set(this, void 0);
+        _MLCore_ast.set(this, null);
         _MLCore_ruleset.set(this, void 0);
         _MLCore_locale.set(this, void 0);
         _MLCore_rules.set(this, void 0);
         _MLCore_schemas.set(this, void 0);
         _MLCore_ignoreFrontMatter.set(this, void 0);
+        if (debug) {
+            (0, debug_1.enableDebug)();
+        }
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_parser, parser, "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_sourceCode, sourceCode, "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_ignoreFrontMatter, !!parserOptions.ignoreFrontMatter, "f");
@@ -31,12 +33,9 @@ class MLCore {
         }, "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_locale, locale, "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_schemas, schemas, "f");
-        (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_ast, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_parser, "f").parse((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_sourceCode, "f"), 0, 0, 0, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ignoreFrontMatter, "f")), "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_filename, filename, "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_rules, rules, "f");
-        if (debug) {
-            (0, _1.enableDebug)();
-        }
+        this._parse();
         this._createDocument();
     }
     get document() {
@@ -45,7 +44,7 @@ class MLCore {
     async verify(fix = false) {
         (0, debug_1.log)('verify: start');
         const violations = [];
-        if ((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_document, "f") instanceof ml_parse_error_1.default) {
+        if ((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_document, "f") instanceof parser_utils_1.ParserError) {
             violations.push({
                 ruleId: 'parse-error',
                 severity: 'error',
@@ -58,18 +57,18 @@ class MLCore {
             return violations;
         }
         for (const rule of (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_rules, "f")) {
-            const ruleInfo = rule.optimizeOption((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ruleset, "f").rules[rule.name] || false);
-            if (ruleInfo.disabled) {
+            const ruleInfo = rule.getRuleInfo((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ruleset, "f"), rule.name);
+            if (ruleInfo.disabled && ruleInfo.nodeRules.length === 0 && ruleInfo.childNodeRules.length === 0) {
                 continue;
             }
             (0, debug_1.log)('%s Rule: verify', rule.name);
             const results = await rule.verify((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_document, "f"), (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_locale, "f"), ruleInfo, fix).catch(e => {
-                if (e instanceof ml_parse_error_1.default) {
+                if (e instanceof parser_utils_1.ParserError) {
                     return e;
                 }
                 throw e;
             });
-            if (results instanceof ml_parse_error_1.default) {
+            if (results instanceof parser_utils_1.ParserError) {
                 (0, debug_1.log)('%s Rule: verify error %o', rule.name, results.message);
                 violations.push({
                     ruleId: 'parse-error',
@@ -85,24 +84,26 @@ class MLCore {
             }
             (0, debug_1.log)('%s Rule: verify end', rule.name);
         }
-        const { e, w, i } = violations.reduce((c, v) => {
-            if (v.severity === 'error')
-                c.e += 1;
-            if (v.severity === 'warning')
-                c.w += 1;
-            if (v.severity === 'info')
-                c.i += 1;
-            return c;
-        }, { e: 0, w: 0, i: 0 });
-        resultLog('Error: %d', e);
-        resultLog('Warning: %d', w);
-        resultLog('Info: %d', i);
+        if (resultLog.enabled) {
+            const { e, w, i } = violations.reduce((c, v) => {
+                if (v.severity === 'error')
+                    c.e += 1;
+                if (v.severity === 'warning')
+                    c.w += 1;
+                if (v.severity === 'info')
+                    c.i += 1;
+                return c;
+            }, { e: 0, w: 0, i: 0 });
+            resultLog('Error: %d', e);
+            resultLog('Warning: %d', w);
+            resultLog('Info: %d', i);
+        }
         (0, debug_1.log)('verify: end');
         return violations;
     }
     setCode(sourceCode) {
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_sourceCode, sourceCode, "f");
-        (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_ast, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_parser, "f").parse((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_sourceCode, "f"), 0, 0, 0, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ignoreFrontMatter, "f")), "f");
+        this._parse();
         this._createDocument();
     }
     update({ parser, ruleset, rules, locale, schemas, parserOptions }) {
@@ -117,16 +118,38 @@ class MLCore {
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_locale, locale !== null && locale !== void 0 ? locale : (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_locale, "f"), "f");
         (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_schemas, schemas !== null && schemas !== void 0 ? schemas : (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_schemas, "f"), "f");
         if (parserOptions && parserOptions.ignoreFrontMatter !== (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ignoreFrontMatter, "f")) {
-            (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_ast, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_parser, "f").parse((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_sourceCode, "f"), 0, 0, 0, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ignoreFrontMatter, "f")), "f");
+            this._parse();
         }
         this._createDocument();
     }
+    _parse() {
+        try {
+            (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_ast, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_parser, "f").parse((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_sourceCode, "f"), 0, 0, 0, (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ignoreFrontMatter, "f")), "f");
+        }
+        catch (err) {
+            (0, debug_1.log)('Caught the parse error: %O', err);
+            (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_ast, null, "f");
+            if (err instanceof parser_utils_1.ParserError) {
+                (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_document, err, "f");
+            }
+            else {
+                throw err;
+            }
+        }
+    }
     _createDocument() {
+        if (!(0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ast, "f")) {
+            return;
+        }
         try {
-            (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_document, new ml_dom_1.Document((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ast, "f"), (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ruleset, "f"), (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_schemas, "f"), (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_filename, "f")), "f");
+            (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_document, new ml_dom_1.Document((0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ast, "f"), (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_ruleset, "f"), (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_schemas, "f"), {
+                filename: (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_filename, "f"),
+                tagNameCaseSensitive: (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_parser, "f").tagNameCaseSensitive,
+                endTag: (0, tslib_1.__classPrivateFieldGet)(this, _MLCore_parser, "f").endTag,
+            }), "f");
         }
         catch (err) {
-            if (err instanceof ml_parse_error_1.default) {
+            if (err instanceof parser_utils_1.ParserError) {
                 (0, tslib_1.__classPrivateFieldSet)(this, _MLCore_document, err, "f");
             }
             else {

package/lib/ml-dom/document.d.ts

@@ -29,6 +29,10 @@ export default class MLDOMDocument<T extends RuleConfigValue, O = null> {
      *
      */
     specs: Readonly<MLMLSpec>;
+    /**
+     *
+     */
+    readonly endTag: 'xml' | 'omittable' | 'never';
     /**
      *
      */
@@ -42,7 +46,11 @@ export default class MLDOMDocument<T extends RuleConfigValue, O = null> {
      * @param ast node list of markuplint AST
      * @param ruleset ruleset object
      */
-    constructor(ast: MLASTDocument, ruleset: Ruleset, schemas: readonly [MLMLSpec, ...ExtendedSpec[]], filename?: string);
+    constructor(ast: MLASTDocument, ruleset: Ruleset, schemas: readonly [MLMLSpec, ...ExtendedSpec[]], options?: {
+        filename?: string;
+        tagNameCaseSensitive?: boolean;
+        endTag?: 'xml' | 'omittable' | 'never';
+    });
     get doctype(): MLDOMDoctype<T, O> | null;
     get tree(): AnonymousNode<T, O>[];
     walk(walker: Walker<T, O>): Promise<void>;

package/lib/ml-dom/document.js

@@ -23,7 +23,8 @@ class MLDOMDocument {
      * @param ast node list of markuplint AST
      * @param ruleset ruleset object
      */
-    constructor(ast, ruleset, schemas, filename) {
+    constructor(ast, ruleset, schemas, options) {
+        var _a;
         /**
          *
          */
@@ -35,7 +36,8 @@ class MLDOMDocument {
         _MLDOMDocument_filename.set(this, void 0);
         this.isFragment = ast.isFragment;
         this.specs = (0, ml_spec_1.getSpec)(schemas);
-        (0, tslib_1.__classPrivateFieldSet)(this, _MLDOMDocument_filename, filename, "f");
+        this.endTag = (_a = options === null || options === void 0 ? void 0 : options.endTag) !== null && _a !== void 0 ? _a : 'omittable';
+        (0, tslib_1.__classPrivateFieldSet)(this, _MLDOMDocument_filename, options === null || options === void 0 ? void 0 : options.filename, "f");
         // console.log(ast.nodeList.map((n, i) => `${i}: ${n.uuid} "${n.raw.trim()}"(${n.type})`));
         this.nodeList = Object.freeze(ast.nodeList.map(astNode => {
             if (astNode.type === 'endtag') {
@@ -43,7 +45,7 @@ class MLDOMDocument {
             }
             return (0, helper_1.createNode)(astNode, this);
         }));
-        this._ruleMapping(ruleset);
+        this._ruleMapping(ruleset, options === null || options === void 0 ? void 0 : options.tagNameCaseSensitive);
     }
     /**
      * It could be used in rule, make sure it is immutable
@@ -124,56 +126,63 @@ class MLDOMDocument {
     debugMap() {
         return (0, debug_2.nodeListToDebugMaps)(this.nodeList, true);
     }
-    _ruleMapping(ruleset) {
+    _ruleMapping(ruleset, tagNameCaseSensitive) {
         docLog('Rule Mapping');
         const ruleMapper = new rule_mapper_1.RuleMapper(this.nodeList);
         // add rules to node
         for (const node of this.nodeList) {
-            docLog('Add rules to node <%s%s>', node.type === 'ElementCloseTag' ? '/' : '', 'nodeName' in node ? node.nodeName : `#${node.type}`);
+            if (node.type === 'ElementCloseTag') {
+                continue;
+            }
+            if (docLog.enabled) {
+                docLog('Add rules to node <%s>', 'nodeName' in node ? node.nodeName : `#${node.type}`);
+            }
             // global rules
             Object.keys(ruleset.rules).forEach(ruleName => {
                 const rule = ruleset.rules[ruleName];
                 ruleMapper.set(node, ruleName, {
                     from: 'rules',
-                    index: -1,
+                    specificity: [0, 0, 0],
                     rule,
                 });
             });
-            if (node.type !== 'Element' &&
-                node.type !== 'OmittedElement' &&
-                node.type !== 'ElementCloseTag' &&
-                node.type !== 'Text') {
+            if (node.type !== 'Element' && node.type !== 'OmittedElement' && node.type !== 'Text') {
                 continue;
             }
-            const selectorTarget = node.type === 'Element' || node.type === 'OmittedElement'
-                ? node
-                : node.type === 'ElementCloseTag'
-                    ? node.startTag
-                    : null;
+            const selectorTarget = node.type === 'Element' || node.type === 'OmittedElement' ? node : null;
             // node specs and special rules for node by selector
             ruleset.nodeRules.forEach((nodeRule, i) => {
                 if (!nodeRule.rules) {
                     return;
                 }
+                if (!selectorTarget) {
+                    return;
+                }
                 const selector = nodeRule.selector || nodeRule.regexSelector || nodeRule.tagName;
-                const matched = 
+                const matches = 
                 /**
                  * Forward v1.x compatibility
                  */
                 nodeRule.tagName && /^#text$/i.test(nodeRule.tagName) && node.type === 'Text'
-                    ? { __node: '#text' }
+                    ? {
+                        matched: true,
+                        selector: '#text',
+                        specificity: [0, 0, 0],
+                    }
                     : /**
                        * v2.0.0 or later
                        */
-                        selectorTarget && (0, match_selector_1.matchSelector)(selectorTarget, selector);
-                if (!matched) {
+                        (0, match_selector_1.matchSelector)(selectorTarget, selector, tagNameCaseSensitive);
+                if (!matches.matched) {
                     return;
                 }
-                docLog('Matched nodeRule: <%s%s>(%s)', node.type === 'ElementCloseTag' ? '/' : '', 'nodeName' in node ? node.nodeName : node.type, matched.__node || 'No Selector');
+                if (docLog.enabled) {
+                    docLog('Matched nodeRule: <%s>(%s)', 'nodeName' in node ? node.nodeName : node.type, matches.selector || '*');
+                }
                 const ruleList = Object.keys(nodeRule.rules);
                 for (const ruleName of ruleList) {
                     const rule = nodeRule.rules[ruleName];
-                    const convertedRule = (0, ml_config_1.exchangeValueOnRule)(rule, matched);
+                    const convertedRule = (0, ml_config_1.exchangeValueOnRule)(rule, matches.data || {});
                     if (convertedRule === undefined) {
                         continue;
                     }
@@ -182,7 +191,7 @@ class MLDOMDocument {
                     ruleLog('↑ nodeRule (%s): %O', ruleName, mergedRule);
                     ruleMapper.set(node, ruleName, {
                         from: 'nodeRules',
-                        index: i,
+                        specificity: matches.specificity,
                         rule: mergedRule,
                     });
                 }
@@ -206,15 +215,17 @@ class MLDOMDocument {
                     if (!selector) {
                         return;
                     }
-                    const matched = (0, match_selector_1.matchSelector)(selectorTarget, selector);
-                    if (!matched) {
+                    const matches = (0, match_selector_1.matchSelector)(selectorTarget, selector, tagNameCaseSensitive);
+                    if (!matches.matched) {
                         return;
                     }
-                    docLog('Matched childNodeRule: <%s%s>(%s), inheritance: %o', node.type === 'ElementCloseTag' ? '/' : '', selectorTarget.nodeName, matched.__node || 'No Selector', !!nodeRule.inheritance);
+                    if (docLog.enabled) {
+                        docLog('Matched childNodeRule: <%s>(%s), inheritance: %o', selectorTarget.nodeName, matches.selector || '*', !!nodeRule.inheritance);
+                    }
                     const targetDescendants = nodeRule.inheritance ? descendants : children;
                     Object.keys(nodeRuleRules).forEach(ruleName => {
                         const rule = nodeRuleRules[ruleName];
-                        const convertedRule = (0, ml_config_1.exchangeValueOnRule)(rule, matched);
+                        const convertedRule = (0, ml_config_1.exchangeValueOnRule)(rule, matches.data || {});
                         if (convertedRule === undefined) {
                             return;
                         }
@@ -224,7 +235,7 @@ class MLDOMDocument {
                         targetDescendants.forEach(descendant => {
                             ruleMapper.set(descendant, ruleName, {
                                 from: 'childNodeRules',
-                                index: i,
+                                specificity: matches.specificity,
                                 rule: mergedRule,
                             });
                         });

package/lib/ml-dom/helper/match-selector.d.ts

@@ -1,5 +1,16 @@
 import type MLDOMAbstractElement from '../tokens/abstract-element';
+import type { Specificity } from './selector';
 import type { RegexSelector } from '@markuplint/ml-config';
+export declare type SelectorMatches = SelectorMatched | SelectorUnmatched;
+declare type SelectorMatched = {
+    matched: true;
+    selector: string;
+    specificity: Specificity;
+    data?: Record<string, string>;
+};
+declare type SelectorUnmatched = {
+    matched: false;
+};
 declare type TargetElement = MLDOMAbstractElement<any, any>;
-export declare function matchSelector(el: TargetElement, selector: string | RegexSelector | undefined): Record<string, string> | null;
+export declare function matchSelector(el: TargetElement, selector: string | RegexSelector | undefined, tagNameCaseSensitive?: boolean): SelectorMatches;
 export {};