@markuplint/ml-core 3.0.0-alpha.66 → 3.0.0-dev.176

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

@@ -1,20 +1,38 @@
-import type { Attr, Element } from '../ml-dom';
 import type { MLRuleContext } from './ml-rule-context';
+import type { Attr, Element } from '../ml-dom';
 import type { Translator } from '@markuplint/i18n';
-import type { Report, RuleConfigValue, Severity } from '@markuplint/ml-config';
-export declare type RuleSeed<T extends RuleConfigValue = boolean, O = null> = {
-    defaultServerity?: Severity;
-    defaultValue?: T;
-    defaultOptions?: O;
-    verify(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
-    fix?(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
+import type { PlainData, Report, RuleConfigValue, Severity } from '@markuplint/ml-config';
+export type RuleSeed<T extends RuleConfigValue = boolean, O extends PlainData = undefined> = {
+	readonly defaultSeverity?: Severity;
+	readonly defaultValue?: T;
+	readonly defaultOptions?: O;
+	verify(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
+	fix?(context: ReturnType<MLRuleContext<T, O>['provide']>): void | Promise<void>;
 };
-export declare type Checker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P) => CheckerReport<T, O>;
-export declare type ElementChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P & {
-    el: Element<T, O>;
-}) => CheckerReport<T, O>;
-export declare type AttrChecker<T extends RuleConfigValue, O = null, P extends Record<string, unknown> = {}> = (params: P & {
-    attr: Attr<T, O>;
-}) => CheckerReport<T, O>;
-export declare type CheckerReport<T extends RuleConfigValue, O = null> = (t: Translator) => Report<T, O> | undefined | null;
-export declare type AnyRuleSeed = RuleSeed<any, any>;
+export type Checker<
+	T extends RuleConfigValue,
+	O extends PlainData = undefined,
+	P extends Record<string, unknown> = {},
+> = (params: P) => CheckerReport<T, O>;
+export type ElementChecker<
+	T extends RuleConfigValue,
+	O extends PlainData = undefined,
+	P extends Record<string, unknown> = {},
+> = (
+	params: P & {
+		el: Element<T, O>;
+	},
+) => CheckerReport<T, O>;
+export type AttrChecker<
+	T extends RuleConfigValue,
+	O extends PlainData = undefined,
+	P extends Record<string, unknown> = {},
+> = (
+	params: P & {
+		attr: Attr<T, O>;
+	},
+) => CheckerReport<T, O>;
+export type CheckerReport<T extends RuleConfigValue, O extends PlainData = undefined> = (
+	t: Translator,
+) => Report<T, O> | undefined | null;
+export type AnyRuleSeed<T extends RuleConfigValue = RuleConfigValue, O extends PlainData = PlainData> = RuleSeed<T, O>;

package/lib/plugin/plugin.d.ts

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

package/lib/plugin/types.d.ts

@@ -1,12 +1,12 @@
-import type { AnyRuleSeed } from '../ml-rule';
+import type { RuleSeed } from '../ml-rule';
 import type { Config } from '@markuplint/ml-config';
-export declare type Plugin = {
-    name: string;
-    rules?: Record<string, AnyRuleSeed>;
-    configs?: Record<string, Config>;
+export type Plugin = {
+	readonly name: string;
+	readonly rules?: Readonly<Record<string, Readonly<RuleSeed<any, any>>>>;
+	readonly configs?: Readonly<Record<string, Config>>;
 };
-export declare type PluginCreator<S extends CreatePluginSettings> = {
-    name: string;
-    create(setting: S): Omit<Plugin, 'name'>;
+export type PluginCreator<S extends CreatePluginSettings> = {
+	readonly name: string;
+	create(setting: S): Omit<Plugin, 'name'>;
 };
-export declare type CreatePluginSettings = Record<string, unknown>;
+export type CreatePluginSettings = Readonly<Record<string, unknown>>;

package/lib/ruleset/index.d.ts

@@ -1,7 +1,7 @@
 import type { ChildNodeRule, Config, NodeRule, Rules } from '@markuplint/ml-config';
 export default class Ruleset {
-    readonly childNodeRules: ReadonlyArray<ChildNodeRule>;
-    readonly nodeRules: ReadonlyArray<NodeRule>;
-    readonly rules: Readonly<Rules>;
-    constructor(config: Config);
+	readonly childNodeRules: readonly ChildNodeRule[];
+	readonly nodeRules: readonly NodeRule[];
+	readonly rules: Rules;
+	constructor(config: Config);
 }

package/lib/ruleset/index.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 class Ruleset {
     constructor(config) {
-        // TODO: deep freeze
-        this.rules = Object.freeze(config.rules || {});
-        this.nodeRules = Object.freeze(config.nodeRules || []);
-        this.childNodeRules = Object.freeze(config.childNodeRules || []);
+        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 : [];
     }
 }
 exports.default = Ruleset;

package/lib/test/index.d.ts

@@ -1,15 +1,28 @@
 import type { MLMarkupLanguageParser } from '@markuplint/ml-ast';
-import type { Config, RuleConfigValue } from '@markuplint/ml-config';
+import type { Config, PlainData, RuleConfigValue } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
 import { Document } from '../ml-dom';
-export declare type CreateTestOptions = {
-    config?: Config;
-    parser?: MLMarkupLanguageParser;
+export type CreateTestOptions = {
+	readonly config?: Config;
+	readonly parser?: Readonly<MLMarkupLanguageParser>;
+	readonly specs?: MLMLSpec;
 };
-export declare function createTestDocument<T extends RuleConfigValue = any, O = 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").MLASTAbstructNode>[];
-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 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>;
 /**
  * for test suite
  */

package/lib/test/index.js

@@ -1,13 +1,16 @@
 "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, [{}, {}]);
+    const document = new ml_dom_1.Document(ast, ruleset, [(_a = options === null || options === void 0 ? void 0 : options.specs) !== null && _a !== void 0 ? _a : {}, {}]);
     return document;
 }
 exports.createTestDocument = createTestDocument;
@@ -24,7 +27,7 @@ exports.createTestTokenList = createTestTokenList;
 function createTestElement(sourceCode, options) {
     const document = createTestDocument(sourceCode, options);
     const el = document.nodeList[0];
-    if (el.is(el.ELEMENT_NODE)) {
+    if (el && el.is(el.ELEMENT_NODE)) {
         return el;
     }
     throw TypeError(`Could not parse it to be an element from: ${sourceCode}`);
@@ -34,7 +37,6 @@ exports.createTestElement = createTestElement;
  * for test suite
  */
 function dummySchemas() {
-    // @ts-ignore
-    return [{}, {}];
+    return [html_spec_1.default];
 }
 exports.dummySchemas = dummySchemas;

package/lib/types.d.ts

@@ -1,15 +1,17 @@
 import type { AnyMLRule } from './ml-rule';
 import type Ruleset from './ruleset';
 import type { LocaleSet } from '@markuplint/i18n';
-import type { MLMarkupLanguageParser } from '@markuplint/ml-ast';
-import type { ParserOptions } from '@markuplint/ml-config';
+import type { MLMarkupLanguageParser, ParserOptions } from '@markuplint/ml-ast';
+import type { Pretender } from '@markuplint/ml-config';
 import type { ExtendedSpec, MLMLSpec } from '@markuplint/ml-spec';
-export declare type MLSchema = Readonly<[MLMLSpec, ...ExtendedSpec[]]>;
-export declare type MLFabric = {
-    parser: MLMarkupLanguageParser;
-    ruleset: Partial<Ruleset>;
-    rules: AnyMLRule[];
-    locale: LocaleSet;
-    schemas: MLSchema;
-    parserOptions: ParserOptions;
+export type MLSchema = readonly [MLMLSpec, ...ExtendedSpec[]];
+export type MLFabric = {
+	readonly parser: Readonly<MLMarkupLanguageParser>;
+	readonly ruleset: Partial<Readonly<Ruleset>>;
+	readonly rules: readonly Readonly<AnyMLRule>[];
+	readonly locale: LocaleSet;
+	readonly schemas: MLSchema;
+	readonly parserOptions: ParserOptions;
+	readonly pretenders: readonly Pretender[];
+	readonly configErrors?: readonly Readonly<Error>[];
 };

package/lib/utils/get-location-from-chars.d.ts

@@ -1,7 +1,12 @@
 interface Location {
-    line: number;
-    col: number;
-    raw: string;
+	line: number;
+	col: number;
+	raw: string;
 }
-export declare function getLocationFromChars(searches: string[], text: string, currentLine: number, currentCol: number): Location[];
+export declare function getLocationFromChars(
+	searches: readonly string[],
+	text: string,
+	currentLine: number,
+	currentCol: number,
+): Location[];
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-core",
-	"version": "3.0.0-alpha.66+6cde1134",
+	"version": "3.0.0-dev.176+f6ad62e9",
 	"description": "The core module of markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -11,26 +11,32 @@
 	"publishConfig": {
 		"access": "public"
 	},
+	"typedoc": {
+		"entryPoint": "./src/index.ts"
+	},
 	"scripts": {
 		"build": "tsc",
 		"dev": "tsc --build --watch",
 		"clean": "tsc --build --clean"
 	},
+	"browser": {
+		"./lib/configs.js": "./lib/configs.browser.js"
+	},
 	"dependencies": {
-		"@markuplint/config-presets": "3.0.0-alpha",
-		"@markuplint/i18n": "2.1.1",
-		"@markuplint/ml-ast": "2.0.1-dev.20220307.0",
-		"@markuplint/ml-config": "3.0.0-alpha.66+6cde1134",
-		"@markuplint/ml-spec": "3.0.0-alpha.82+6cde1134",
-		"@markuplint/parser-utils": "2.2.0",
-		"@markuplint/selector": "3.0.0-alpha.2105+6cde1134",
+		"@markuplint/config-presets": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/html-parser": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/html-spec": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/i18n": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/ml-ast": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/ml-config": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/ml-spec": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/parser-utils": "3.0.0-dev.176+f6ad62e9",
+		"@markuplint/selector": "3.0.0-dev.176+f6ad62e9",
+		"@types/debug": "^4.1.7",
 		"debug": "^4.3.4",
-		"postcss-selector-parser": "^6.0.10",
-		"tslib": "^2.3.1"
-	},
-	"devDependencies": {
-		"@markuplint/html-parser": "2.2.1",
-		"@types/debug": "^4.1.7"
+		"is-plain-object": "^5.0.0",
+		"tslib": "^2.4.1",
+		"type-fest": "^3.8.0"
 	},
-	"gitHead": "6cde113402758a8fdbd6a0fcf98e78efd2cdb778"
+	"gitHead": "f6ad62e992e1569be4067f1e90d2d6017a658f57"
 }

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

@@ -0,0 +1,85 @@
+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

@@ -0,0 +1,18 @@
+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>');
+	});
+});