@markuplint/ml-core 3.12.0 → 4.0.0-alpha.1

package/lib/ml-rule/ml-rule.js

@@ -1,37 +1,34 @@
-"use strict";
 var _MLRule_f, _MLRule_v;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MLRule = void 0;
-const tslib_1 = require("tslib");
-const ml_config_1 = require("@markuplint/ml-config");
-const is_plain_object_1 = require("is-plain-object");
-const ml_rule_context_1 = require("./ml-rule-context");
-class MLRule {
+import { __classPrivateFieldGet, __classPrivateFieldSet } from "tslib";
+import { deleteUndefProp } from '@markuplint/ml-config';
+// @ts-ignore
+import { isPlainObject } from 'is-plain-object';
+import { MLRuleContext } from './ml-rule-context.js';
+export class MLRule {
     constructor(o) {
-        var _a;
         _MLRule_f.set(this, void 0);
         _MLRule_v.set(this, void 0);
         this.name = o.name;
-        this.defaultSeverity = (_a = o.defaultSeverity) !== null && _a !== void 0 ? _a : 'error';
+        this.defaultSeverity = o.defaultSeverity ?? 'error';
         // TODO: https://github.com/markuplint/markuplint/issues/808
         this.defaultValue = (o.defaultValue !== undefined ? o.defaultValue : true);
         this.defaultOptions = o.defaultOptions;
-        tslib_1.__classPrivateFieldSet(this, _MLRule_v, o.verify, "f");
-        tslib_1.__classPrivateFieldSet(this, _MLRule_f, o.fix, "f");
+        __classPrivateFieldSet(this, _MLRule_v, o.verify, "f");
+        __classPrivateFieldSet(this, _MLRule_f, o.fix, "f");
     }
     /**
      * The following getter is unused internally,
      * only for extending from 3rd party library
      */
     get f() {
-        return tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f");
+        return __classPrivateFieldGet(this, _MLRule_f, "f");
     }
     /**
      * The following getter is unused internally,
      * only for extending from 3rd party library
      */
     get v() {
-        return tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f");
+        return __classPrivateFieldGet(this, _MLRule_v, "f");
     }
     getRuleInfo(ruleSet, ruleName) {
         const info = this._optimize(ruleSet.rules, ruleName);
@@ -42,7 +39,6 @@ class MLRule {
         };
     }
     optimizeOption(configSettings) {
-        var _a;
         if (configSettings === undefined || typeof configSettings === 'boolean') {
             return {
                 disabled: !configSettings,
@@ -55,7 +51,7 @@ class MLRule {
         if (isRuleConfig(configSettings)) {
             return {
                 disabled: false,
-                severity: (_a = configSettings.severity) !== null && _a !== void 0 ? _a : this.defaultSeverity,
+                severity: configSettings.severity ?? this.defaultSeverity,
                 value: configSettings.value === undefined ||
                     // @ts-ignore
                     configSettings.value === true
@@ -77,14 +73,13 @@ class MLRule {
     // eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
     document, locale, fix) {
         document.setRule(this);
-        const context = new ml_rule_context_1.MLRuleContext(document, locale);
+        const context = new MLRuleContext(document, locale);
         const providableContext = context.provide();
-        await tslib_1.__classPrivateFieldGet(this, _MLRule_v, "f").call(this, providableContext);
-        if (tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f") && fix) {
-            await tslib_1.__classPrivateFieldGet(this, _MLRule_f, "f").call(this, providableContext);
+        await __classPrivateFieldGet(this, _MLRule_v, "f").call(this, providableContext);
+        if (__classPrivateFieldGet(this, _MLRule_f, "f") && fix) {
+            await __classPrivateFieldGet(this, _MLRule_f, "f").call(this, providableContext);
         }
         const violation = context.reports.map(report => {
-            var _a;
             if ('scope' in report) {
                 let line = report.scope.startLine;
                 let col = report.scope.startCol;
@@ -101,9 +96,9 @@ class MLRule {
                     col,
                     raw,
                     ruleId: this.name,
-                    reason: (_a = report.scope.rule.reason) !== null && _a !== void 0 ? _a : document.rule.reason,
+                    reason: report.scope.rule.reason ?? document.rule.reason,
                 };
-                (0, ml_config_1.deleteUndefProp)(violation);
+                deleteUndefProp(violation);
                 return violation;
             }
             const violation = {
@@ -115,32 +110,30 @@ class MLRule {
                 ruleId: this.name,
                 reason: document.rule.reason,
             };
-            (0, ml_config_1.deleteUndefProp)(violation);
+            deleteUndefProp(violation);
             return violation;
         });
         document.setRule(null);
         return violation;
     }
     _optimize(rules, ruleName) {
-        var _a;
-        const rule = ((_a = rules === null || rules === void 0 ? void 0 : rules[ruleName]) !== null && _a !== void 0 ? _a : false);
+        const rule = (rules?.[ruleName] ?? false);
         const info = this.optimizeOption(rule);
         return info;
     }
 }
-exports.MLRule = MLRule;
 _MLRule_f = new WeakMap(), _MLRule_v = new WeakMap();
 function isRuleConfig(data) {
-    return (0, is_plain_object_1.isPlainObject)(data);
+    return isPlainObject(data);
 }
 function mergeOptions(a, b) {
     if (Array.isArray(a) && Array.isArray(b)) {
         // @ts-ignore
         return [...a, ...b];
     }
-    if ((0, is_plain_object_1.isPlainObject)(a) && (0, is_plain_object_1.isPlainObject)(b)) {
+    if (isPlainObject(a) && isPlainObject(b)) {
         // @ts-ignore
         return { ...a, ...b };
     }
-    return b !== null && b !== void 0 ? b : a;
+    return b ?? a;
 }

package/lib/ml-rule/types.d.ts

@@ -1,5 +1,5 @@
-import type { MLRuleContext } from './ml-rule-context';
-import type { Attr, Element } from '../ml-dom';
+import type { MLRuleContext } from './ml-rule-context.js';
+import type { Attr, Element } from '../ml-dom/index.js';
 import type { Translator } from '@markuplint/i18n';
 import type { PlainData, Report, RuleConfigValue, Severity } from '@markuplint/ml-config';
 export type RuleSeed<T extends RuleConfigValue = boolean, O extends PlainData = undefined> = {

package/lib/ml-rule/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/plugin/index.d.ts

@@ -1,2 +1,2 @@
-export * from './plugin';
-export * from './types';
+export * from './plugin.js';
+export * from './types.js';

package/lib/plugin/index.js

@@ -1,5 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./plugin"), exports);
-tslib_1.__exportStar(require("./types"), exports);
+export * from './plugin.js';
+export * from './types.js';

package/lib/plugin/plugin.d.ts

@@ -1,2 +1,2 @@
-import type { PluginCreator, CreatePluginSettings } from './types';
+import type { PluginCreator, CreatePluginSettings } from './types.js';
 export declare function createPlugin<S extends CreatePluginSettings>(fn: Readonly<PluginCreator<S>>): Readonly<PluginCreator<S>>;

package/lib/plugin/plugin.js

@@ -1,7 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPlugin = void 0;
-function createPlugin(fn) {
+export function createPlugin(fn) {
     return fn;
 }
-exports.createPlugin = createPlugin;

package/lib/plugin/types.d.ts

@@ -1,4 +1,4 @@
-import type { RuleSeed } from '../ml-rule';
+import type { RuleSeed } from '../ml-rule/index.js';
 import type { Config } from '@markuplint/ml-config';
 export type Plugin = {
     readonly name: string;

package/lib/plugin/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/ruleset/index.js

@@ -1,11 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class Ruleset {
+export default class Ruleset {
     constructor(config) {
-        var _a, _b, _c;
-        this.rules = (_a = config.rules) !== null && _a !== void 0 ? _a : {};
-        this.nodeRules = (_b = config.nodeRules) !== null && _b !== void 0 ? _b : [];
-        this.childNodeRules = (_c = config.childNodeRules) !== null && _c !== void 0 ? _c : [];
+        this.rules = config.rules ?? {};
+        this.nodeRules = config.nodeRules ?? [];
+        this.childNodeRules = config.childNodeRules ?? [];
     }
 }
-exports.default = Ruleset;

package/lib/test/index.d.ts

@@ -1,16 +1,16 @@
 import type { MLMarkupLanguageParser } from '@markuplint/ml-ast';
 import type { Config, PlainData, RuleConfigValue } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
-import { Document } from '../ml-dom';
+import { Document } from '../ml-dom/index.js';
 export type CreateTestOptions = {
     readonly config?: Config;
     readonly parser?: Readonly<MLMarkupLanguageParser>;
     readonly specs?: MLMLSpec;
 };
 export declare function createTestDocument<T extends RuleConfigValue = any, O extends PlainData = any>(sourceCode: string, options?: CreateTestOptions): Document<T, O>;
-export declare function createTestNodeList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/node/node").MLNode<any, any, import("@markuplint/ml-ast").MLASTAbstractNode>[];
-export declare function createTestTokenList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/token/token").MLToken<import("@markuplint/ml-ast").MLToken>[];
-export declare function createTestElement(sourceCode: string, options?: CreateTestOptions): import("../ml-dom").Element<any, any>;
+export declare function createTestNodeList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/node/node.js").MLNode<any, any, import("@markuplint/ml-ast").MLASTAbstractNode>[];
+export declare function createTestTokenList(sourceCode: string, options?: CreateTestOptions): readonly import("../ml-dom/token/token.js").MLToken<import("@markuplint/ml-ast").MLToken>[];
+export declare function createTestElement(sourceCode: string, options?: CreateTestOptions): import("../ml-dom/index.js").Element<any, any>;
 /**
  * for test suite
  */

package/lib/test/index.js

@@ -1,30 +1,22 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dummySchemas = exports.createTestElement = exports.createTestTokenList = exports.createTestNodeList = exports.createTestDocument = void 0;
-const tslib_1 = require("tslib");
-const html_parser_1 = require("@markuplint/html-parser");
-const html_spec_1 = tslib_1.__importDefault(require("@markuplint/html-spec"));
-const convert_ruleset_1 = require("../convert-ruleset");
-const ml_dom_1 = require("../ml-dom");
-function createTestDocument(sourceCode, options) {
-    var _a;
-    const ast = (options === null || options === void 0 ? void 0 : options.parser) ? options.parser.parse(sourceCode) : (0, html_parser_1.parse)(sourceCode);
-    const ruleset = (0, convert_ruleset_1.convertRuleset)(options === null || options === void 0 ? void 0 : options.config);
-    const document = new ml_dom_1.Document(ast, ruleset, [(_a = options === null || options === void 0 ? void 0 : options.specs) !== null && _a !== void 0 ? _a : {}, {}]);
+import { parse } from '@markuplint/html-parser';
+import spec from '@markuplint/html-spec';
+import { convertRuleset } from '../convert-ruleset.js';
+import { Document } from '../ml-dom/index.js';
+export function createTestDocument(sourceCode, options) {
+    const ast = options?.parser ? options.parser.parse(sourceCode) : parse(sourceCode);
+    const ruleset = convertRuleset(options?.config);
+    const document = new Document(ast, ruleset, [options?.specs ?? {}, {}]);
     return document;
 }
-exports.createTestDocument = createTestDocument;
-function createTestNodeList(sourceCode, options) {
+export function createTestNodeList(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     return document.nodeList;
 }
-exports.createTestNodeList = createTestNodeList;
-function createTestTokenList(sourceCode, options) {
+export function createTestTokenList(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     return document.getTokenList();
 }
-exports.createTestTokenList = createTestTokenList;
-function createTestElement(sourceCode, options) {
+export function createTestElement(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     const el = document.nodeList[0];
     if (el && el.is(el.ELEMENT_NODE)) {
@@ -32,11 +24,9 @@ function createTestElement(sourceCode, options) {
     }
     throw TypeError(`Could not parse it to be an element from: ${sourceCode}`);
 }
-exports.createTestElement = createTestElement;
 /**
  * for test suite
  */
-function dummySchemas() {
-    return [html_spec_1.default];
+export function dummySchemas() {
+    return [spec];
 }
-exports.dummySchemas = dummySchemas;

package/lib/types.d.ts

@@ -1,5 +1,5 @@
-import type { AnyMLRule } from './ml-rule';
-import type Ruleset from './ruleset';
+import type { AnyMLRule } from './ml-rule/index.js';
+import type Ruleset from './ruleset/index.js';
 import type { LocaleSet } from '@markuplint/i18n';
 import type { MLMarkupLanguageParser, ParserOptions } from '@markuplint/ml-ast';
 import type { Pretender } from '@markuplint/ml-config';

package/lib/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/lib/utils/get-location-from-chars.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocationFromChars = void 0;
-function getLocationFromChars(searches, text, currentLine, currentCol) {
+export function getLocationFromChars(searches, text, currentLine, currentCol) {
     const lines = text.split(/\r?\n/g);
     const foundLocations = [];
     lines.forEach((lineText, i) => {
@@ -25,4 +22,3 @@ function getLocationFromChars(searches, text, currentLine, currentCol) {
     });
     return foundLocations;
 }
-exports.getLocationFromChars = getLocationFromChars;

package/lib/utils/index.d.ts

@@ -1 +1 @@
-export { getLocationFromChars } from './get-location-from-chars';
+export { getLocationFromChars } from './get-location-from-chars.js';

package/lib/utils/index.js

@@ -1,5 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLocationFromChars = void 0;
-var get_location_from_chars_1 = require("./get-location-from-chars");
-Object.defineProperty(exports, "getLocationFromChars", { enumerable: true, get: function () { return get_location_from_chars_1.getLocationFromChars; } });
+export { getLocationFromChars } from './get-location-from-chars.js';

package/lib/utils/string-splice.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stringSplice = void 0;
-function stringSplice(str, start, count, add = '') {
+export function stringSplice(str, start, count, add = '') {
     if (start < 0) {
         start = str.length + start;
         if (start < 0) {
@@ -10,4 +7,3 @@ function stringSplice(str, start, count, add = '') {
     }
     return str.slice(0, start) + add + str.slice(start + count);
 }
-exports.stringSplice = stringSplice;

package/package.json

@@ -1,13 +1,18 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "3.12.0",
+	"version": "4.0.0-alpha.1",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
 	"license": "MIT",
 	"private": false,
-	"main": "lib/index.js",
-	"types": "lib/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"import": "./lib/index.js"
+		}
+	},
+	"types": "./lib/index.d.ts",
 	"publishConfig": {
 		"access": "public"
 	},
@@ -23,20 +28,20 @@
 		"./lib/configs.js": "./lib/configs.browser.js"
 	},
 	"dependencies": {
-		"@markuplint/config-presets": "3.8.0",
-		"@markuplint/html-parser": "3.10.0",
-		"@markuplint/html-spec": "3.11.0",
-		"@markuplint/i18n": "3.9.0",
-		"@markuplint/ml-ast": "3.2.0",
-		"@markuplint/ml-config": "3.11.0",
-		"@markuplint/ml-spec": "3.11.0",
-		"@markuplint/parser-utils": "3.10.0",
-		"@markuplint/selector": "3.11.0",
+		"@markuplint/config-presets": "4.0.0-alpha.1",
+		"@markuplint/html-parser": "4.0.0-alpha.1",
+		"@markuplint/html-spec": "4.0.0-alpha.1",
+		"@markuplint/i18n": "4.0.0-alpha.1",
+		"@markuplint/ml-ast": "4.0.0-alpha.1",
+		"@markuplint/ml-config": "4.0.0-alpha.1",
+		"@markuplint/ml-spec": "4.0.0-alpha.1",
+		"@markuplint/parser-utils": "4.0.0-alpha.1",
+		"@markuplint/selector": "4.0.0-alpha.1",
 		"@types/debug": "^4.1.8",
 		"debug": "^4.3.4",
 		"is-plain-object": "^5.0.0",
-		"tslib": "^2.6.0",
-		"type-fest": "^3.12.0"
+		"tslib": "^2.6.1",
+		"type-fest": "^4.1.0"
 	},
-	"gitHead": "4ab20276db48a6acb29a923ea8666890ca853442"
+	"gitHead": "22502ee22a378ae766033d687dbc0443e5ed35dc"
 }

package/test/ml-dom/helper/accname.spec.js

@@ -1,85 +0,0 @@
-const { parse } = require('@markuplint/html-parser');
-
-const { convertRuleset } = require('../../../');
-const { getAccname } = require('../../../lib/ml-dom/helper/accname');
-const { createNode } = require('../../../lib/ml-dom/helper/create-node');
-const { MLDocument } = require('../../../lib/ml-dom/node/document');
-const { dummySchemas } = require('../../../lib/test');
-
-function c(sourceCode) {
-	const ast = parse(sourceCode);
-	const astNode = ast.nodeList[0];
-	const ruleset = convertRuleset({});
-	const document = new MLDocument(ast, ruleset, dummySchemas());
-	const node = createNode(astNode, document);
-	if (node.is(node.ELEMENT_NODE)) {
-		return node;
-	}
-	throw new Error();
-}
-
-test('Get accessible name', () => {
-	expect(getAccname(c('<button>label</button>'), '1.2')).toBe('label');
-	expect(getAccname(c('<div>text</div>'), '1.2')).toBe('');
-	expect(getAccname(c('<div aria-label="label">text</div>'), '1.2')).toBe('label');
-	expect(getAccname(c('<span aria-label="label">text</span>'), '1.2')).toBe('label');
-	expect(getAccname(c('<img alt="alternative-text" />'), '1.2')).toBe('alternative-text');
-	expect(getAccname(c('<img title="title" />'), '1.2')).toBe('title');
-	expect(getAccname(c('<div><label for="a">label</label><input id="a" /></div>').children[1], '1.2')).toBe('label');
-});
-
-test('Invisible element', () => {
-	expect(getAccname(c('<button>label</button>'), '1.2')).toBe('label');
-	expect(getAccname(c('<button aria-disabled="true">label</button>'), '1.2')).toBe('label');
-	expect(getAccname(c('<button aria-hidden="true">label</button>'), '1.2')).toBe('');
-	expect(getAccname(c('<button hidden>label</button>'), '1.2')).toBe('');
-	expect(getAccname(c('<button style="display: none">label</button>'), '1.2')).toBe('label'); // Do not support the style attribute yet.
-});
-
-/**
- * @see https://www.w3.org/TR/accname-1.1/#ex-1-example-1-element1-id-el1-aria-labelledby-el3-element2-id-el2-aria-labelledby-el1-element3-id-el3-hello-element3
- */
-test('accname-1.1 Example 1', () => {
-	const complex = c(`<div>
-<input id="el1" aria-labelledby="el3" />
-<input id="el2" aria-labelledby="el1" />
-<h1 id="el3"> hello </h1>
-</div>`);
-	expect(getAccname(complex.children[0], '1.2')).toBe('hello');
-	expect(getAccname(complex.children[1], '1.2')).toBe('');
-	expect(getAccname(complex.children[2], '1.2')).toBe('hello');
-});
-
-/**
- * https://www.w3.org/TR/accname-1.1/#ex-2-example-2-h1-files-h1-ul-li-a-id-file_row1-href-files-documentation-pdf-documentation-pdf-a-span-role-button-tabindex-0-id-del_row1-aria-label-delete-aria-labelledby-del_row1-file_row1-span-li-li-a-id-file_row2-href-files-holidayletter-pdf-holidayletter-pdf-a-span-role-button-tabindex-0-id-del_row2-aria-label-delete-aria-labelledby-del_row2-file_row2-span-li-ul
- */
-test('accname-1.1 Example 2', () => {
-	const complex = c(`<ul>
-	<li>
-		<a id="file_row1" href="./files/Documentation.pdf">Documentation.pdf</a>
-		<span role="button" tabindex="0" id="del_row1" aria-label="Delete" aria-labelledby="del_row1 file_row1"></span>
-	</li>
-	<li>
-		<a id="file_row2" href="./files/HolidayLetter.pdf">HolidayLetter.pdf</a>
-		<span role="button" tabindex="0" id="del_row2" aria-label="Delete" aria-labelledby="del_row2 file_row2"></span>
-	</li>
-</ul>`);
-	const spans = complex.querySelectorAll('span');
-	expect(getAccname(spans[0], '1.2')).toBe('Delete Documentation.pdf');
-	expect(getAccname(spans[1], '1.2')).toBe('Delete HolidayLetter.pdf');
-});
-
-/**
- * https://www.w3.org/TR/accname-1.1/#ex-3-example-3-div-role-checkbox-aria-checked-false-flash-the-screen-span-role-textbox-aria-multiline-false-5-span-times-div
- */
-test('accname-1.1 Example 3', () => {
-	const complex = c(
-		'<div role="checkbox" aria-checked="false">Flash the screen <span role="textbox" aria-multiline="false"> 5 </span> times</div>',
-	);
-	expect(getAccname(complex, '1.2')).toBe('Flash the screen 5 times');
-});
-
-test('with comment', () => {
-	expect(getAccname(c('<button>label</button>'), '1.2')).toBe('label');
-	expect(getAccname(c('<button>label<!-- comment --></button>'), '1.2')).toBe('label');
-});

package/test/ml-dom/helper/create-node.spec.js

@@ -1,18 +0,0 @@
-const { parse } = require('@markuplint/html-parser');
-
-const { convertRuleset } = require('../../../');
-const { Document } = require('../../../lib/ml-dom/');
-const { createNode } = require('../../../lib/ml-dom/helper/create-node');
-const { dummySchemas } = require('../../../lib/test');
-
-describe('create Node', () => {
-	it('Element', () => {
-		const sourceCode = '<div>text</div>';
-		const ast = parse(sourceCode);
-		const astNode = ast.nodeList[0];
-		const ruleset = convertRuleset({});
-		const document = new Document(ast, ruleset, dummySchemas());
-		const node = createNode(astNode, document);
-		expect(node.raw).toBe('<div>');
-	});
-});