@markuplint/rules 3.0.0-alpha.66 → 3.0.0-dev.176

package/lib/permitted-contents/recursive-branch.d.ts

@@ -0,0 +1,11 @@
+import type { SelectorResult } from './matches-selector';
+import type { ChildNode, Options, Specs } from './types';
+import type { PermittedContentPattern, Model } from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
+export declare function recursiveBranch(
+	model: ReadonlyDeep<Model | PermittedContentPattern[]>,
+	nodes: readonly ChildNode[],
+	specs: Specs,
+	options: Options,
+	depth: number,
+): SelectorResult;

package/lib/permitted-contents/recursive-branch.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.recursiveBranch = void 0;
+const matches_selector_1 = require("./matches-selector");
+const order_1 = require("./order");
+const utils_1 = require("./utils");
+function recursiveBranch(model, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes, specs, options, depth) {
+    if (!(0, utils_1.isModel)(model)) {
+        return (0, order_1.order)(model, nodes, specs, options, depth + 1);
+    }
+    if (typeof model === 'string') {
+        return (0, matches_selector_1.matchesSelector)(model, nodes[0], specs, depth);
+    }
+    const collection = new utils_1.Collection(nodes);
+    let lastUnmatched = null;
+    for (const query of model) {
+        const result = (0, matches_selector_1.matchesSelector)(query, collection.unmatched[0], specs, depth);
+        collection.addMatched(result.matched);
+        if (result.type === 'MATCHED' || result.type === 'MATCHED_ZERO') {
+            return {
+                type: result.type,
+                matched: collection.matched,
+                unmatched: collection.unmatched,
+                zeroMatch: result.zeroMatch,
+                query: result.query,
+                hint: result.hint,
+            };
+        }
+        lastUnmatched = {
+            type: result.type,
+            matched: collection.matched,
+            unmatched: collection.unmatched,
+            zeroMatch: result.zeroMatch,
+            query: result.query,
+            hint: result.hint,
+        };
+    }
+    if (!lastUnmatched) {
+        throw new Error('Unreachable code');
+    }
+    return lastUnmatched;
+}
+exports.recursiveBranch = recursiveBranch;

package/lib/permitted-contents/represent-transparent-nodes.d.ts

@@ -0,0 +1,10 @@
+import type { ChildNode, Options, Result, Specs } from './types';
+export declare const transparentMode: Map<ChildNode, true>;
+export declare function representTransparentNodes(
+	nodes: ChildNode[],
+	specs: Specs,
+	options: Options,
+): {
+	nodes: ChildNode[];
+	errors: Result[];
+};

package/lib/permitted-contents/represent-transparent-nodes.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.representTransparentNodes = exports.transparentMode = void 0;
+const ml_spec_1 = require("@markuplint/ml-spec");
+const order_1 = require("./order");
+const utils_1 = require("./utils");
+exports.transparentMode = new Map();
+function representTransparentNodes(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes, specs, options) {
+    var _a;
+    const result = [];
+    const errors = [];
+    const parent = (_a = nodes[0]) === null || _a === void 0 ? void 0 : _a.parentElement;
+    if (parent) {
+        const { errors: parentErrors } = representTransparentNodes([parent], specs, options);
+        errors.push(...parentErrors);
+    }
+    for (const node of nodes) {
+        if (!node.is(node.ELEMENT_NODE)) {
+            result.push(node);
+            continue;
+        }
+        const models = (0, ml_spec_1.getContentModel)(node, specs.specs);
+        if (models == null || typeof models === 'boolean') {
+            result.push(node);
+            continue;
+        }
+        const noTransparentModels = models.filter(m => !(0, utils_1.isTransparent)(m));
+        if (noTransparentModels.length === models.length) {
+            result.push(node);
+            continue;
+        }
+        const collection = new utils_1.Collection((0, utils_1.getChildNodesWithoutWhitespaces)(node));
+        let unmatched;
+        if (noTransparentModels.length > 0) {
+            const result = (0, order_1.order)(noTransparentModels, collection.unmatched, specs, options, Infinity);
+            unmatched = result.unmatched;
+        }
+        else {
+            unmatched = collection.unmatched;
+        }
+        const transparent = models.find(m => (0, utils_1.isTransparent)(m));
+        if (!transparent || !(0, utils_1.isTransparent)(transparent)) {
+            throw new Error('Unreachable code');
+        }
+        for (const _child of unmatched) {
+            const child = _child;
+            if (exports.transparentMode.has(child)) {
+                continue;
+            }
+            exports.transparentMode.set(child, true);
+            if (child.is(child.ELEMENT_NODE)) {
+                const transparentCondMatched = (0, utils_1.matches)(transparent.transparent, child, specs);
+                if (!transparentCondMatched.matched) {
+                    errors.push({
+                        type: 'TRANSPARENT_MODEL_DISALLOWS',
+                        matched: [],
+                        unmatched: [node],
+                        zeroMatch: false,
+                        query: transparent.transparent,
+                        hint: {
+                            not: transparentCondMatched.not,
+                            transparent: node,
+                        },
+                    });
+                    continue;
+                }
+            }
+            result.push(child);
+        }
+    }
+    return {
+        nodes: result,
+        errors,
+    };
+}
+exports.representTransparentNodes = representTransparentNodes;

package/lib/permitted-contents/start.d.ts

@@ -0,0 +1,18 @@
+import type { ContentModelResult, Element, Options, Specs } from './types';
+import type { ContentModel } from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
+/**
+ * Check start
+ *
+ * @param contents
+ * @param el
+ * @param specs
+ * @param options
+ * @returns
+ */
+export declare function start(
+	contents: ReadonlyDeep<ContentModel['contents']>,
+	el: Element,
+	specs: Specs,
+	options: Options,
+): ContentModelResult[];

package/lib/permitted-contents/start.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.start = void 0;
+const order_1 = require("./order");
+const represent_transparent_nodes_1 = require("./represent-transparent-nodes");
+const utils_1 = require("./utils");
+/**
+ * Check start
+ *
+ * @param contents
+ * @param el
+ * @param specs
+ * @param options
+ * @returns
+ */
+function start(contents, 
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+el, specs, options) {
+    var _a;
+    if (contents === false) {
+        if (el.childNodes.length > 0) {
+            return [
+                {
+                    type: 'NOTHING',
+                    scope: el,
+                    query: ':not(*)',
+                    hint: {},
+                },
+            ];
+        }
+        return [
+            {
+                type: 'MATCHED',
+                scope: el,
+                query: '*',
+                hint: {},
+            },
+        ];
+    }
+    if (contents === true) {
+        // Allows all elements
+        return [
+            {
+                type: 'MATCHED',
+                scope: el,
+                query: '*',
+                hint: {},
+            },
+        ];
+    }
+    const { nodes, errors } = (0, represent_transparent_nodes_1.representTransparentNodes)((0, utils_1.getChildNodesWithoutWhitespaces)(el), specs, options);
+    const result = (0, order_1.order)(contents, nodes, specs, options, 0);
+    return [
+        {
+            type: result.type,
+            scope: result.type === 'MISSING_NODE_REQUIRED' || result.type === 'MISSING_NODE_ONE_OR_MORE'
+                ? el
+                : (_a = result.unmatched[0]) !== null && _a !== void 0 ? _a : el,
+            query: result.query,
+            hint: result.hint,
+        },
+        ...errors.map(error => {
+            var _a;
+            return ({
+                type: error.type,
+                scope: (_a = error.unmatched[0]) !== null && _a !== void 0 ? _a : el,
+                query: error.query,
+                hint: error.hint,
+            });
+        }),
+    ];
+}
+exports.start = start;

package/lib/permitted-contents/transparent.d.ts

@@ -0,0 +1,2 @@
+import type { ChildNode, Result } from './types';
+export declare function transparent(nodes: readonly ChildNode[]): Result;

package/lib/permitted-contents/transparent.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transparent = void 0;
+const debug_1 = require("./debug");
+const transparentLog = debug_1.cmLog.extend('transparent');
+function transparent(
+// eslint-disable-next-line @typescript-eslint/prefer-readonly-parameter-types
+nodes) {
+    var _a, _b;
+    if (nodes.length === 0 || ((_b = (_a = nodes[0]) === null || _a === void 0 ? void 0 : _a.parentElement) === null || _b === void 0 ? void 0 : _b.parentElement)) {
+        transparentLog('Skipped');
+        return {
+            type: nodes.length === 0 ? 'MATCHED_ZERO' : 'MATCHED',
+            matched: nodes.slice(),
+            unmatched: [],
+            zeroMatch: nodes.length === 0,
+            query: 'transparent',
+            hint: {},
+        };
+    }
+    transparentLog('Transparent model element is component root');
+    return {
+        type: 'MATCHED',
+        matched: nodes.slice(),
+        unmatched: [],
+        zeroMatch: false,
+        query: 'transparent',
+        hint: {},
+    };
+}
+exports.transparent = transparent;

package/lib/permitted-contents/types.d.ts

@@ -0,0 +1,52 @@
+import type { Element as _Element, ChildNode as _ChildNode } from '@markuplint/ml-core';
+import type { ContentModel, MLMLSpec } from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
+export type Element = _Element<TagRule[], Options>;
+export type ChildNode = _ChildNode<TagRule[], Options>;
+export type Specs = {
+	readonly cites: MLMLSpec['cites'];
+	readonly def: MLMLSpec['def'];
+	readonly specs: readonly {
+		readonly name: string;
+		readonly contentModel: {
+			readonly contents: MLMLSpec['specs'][0]['contentModel']['contents'];
+		};
+	}[];
+};
+export type ContentModelResult = {
+	type: MatchedReason | UnmatchedReason;
+	scope: ChildNode;
+	query: Result['query'];
+	hint: Result['hint'];
+};
+export type Result<T extends string = MatchedReason> = {
+	type: MatchedReason | UnmatchedReason | T;
+	matched: ChildNode[];
+	unmatched: ChildNode[];
+	zeroMatch: boolean;
+	query: string;
+	hint: Hints;
+};
+export type Hints = {
+	max?: number;
+	not?: ChildNode;
+	transparent?: Element;
+	missing?: {
+		barelyMatchedElements?: number;
+		need?: string;
+	};
+};
+export type MatchedReason = 'MATCHED' | 'MATCHED_ZERO';
+export type UnmatchedReason = 'NOTHING' | 'UNEXPECTED_EXTRA_NODE' | 'TRANSPARENT_MODEL_DISALLOWS' | MissingNodeReason;
+export type MissingNodeReason = 'MISSING_NODE_REQUIRED' | 'MISSING_NODE_ONE_OR_MORE';
+export type RepeatSign = '' | '?' | '+' | '*' | `{${number},${number}}`;
+export type TransparentModel = {
+	el: Element;
+	additionalCondition: string;
+};
+export type TagRule = {
+	readonly tag: string;
+} & ReadonlyDeep<ContentModel>;
+export type Options = {
+	readonly ignoreHasMutableChildren: boolean;
+};

package/lib/permitted-contents/types.js

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

package/lib/permitted-contents/utils.d.ts

@@ -0,0 +1,100 @@
+import type { ChildNode, Element, Hints, MissingNodeReason, RepeatSign, Specs } from './types';
+import type {
+	PermittedContentPattern,
+	PermittedContentChoice,
+	PermittedContentOneOrMore,
+	PermittedContentOptional,
+	PermittedContentRequire,
+	PermittedContentTransparent,
+	PermittedContentZeroOrMore,
+	Model,
+} from '@markuplint/ml-spec';
+import type { ReadonlyDeep } from 'type-fest';
+export declare function getChildNodesWithoutWhitespaces(el: Element): ChildNode[];
+export declare function isModel(model: ReadonlyDeep<Model | PermittedContentPattern[]>): model is ReadonlyDeep<Model>;
+export declare function matches(
+	selector: string,
+	node: ChildNode,
+	specs: Specs,
+):
+	| {
+			matched: boolean;
+			not?: undefined;
+	  }
+	| {
+			matched: boolean;
+			not: ChildNode | undefined;
+	  };
+export declare function isRequire(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentRequire>;
+export declare function isOptional(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentOptional>;
+export declare function isOneOrMore(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentOneOrMore>;
+export declare function isZeroOrMore(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentZeroOrMore>;
+export declare function isChoice(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentChoice>;
+export declare function isTransparent(
+	content: ReadonlyDeep<PermittedContentPattern>,
+): content is ReadonlyDeep<PermittedContentTransparent>;
+export declare function normalizeModel(
+	pattern:
+		| ReadonlyDeep<PermittedContentRequire>
+		| ReadonlyDeep<PermittedContentOptional>
+		| ReadonlyDeep<PermittedContentOneOrMore>
+		| ReadonlyDeep<PermittedContentZeroOrMore>,
+): {
+	model: ReadonlyDeep<PermittedContentPattern[] | Model>;
+	min: number;
+	max: number;
+	repeat: RepeatSign;
+	missingType: MissingNodeReason | undefined;
+};
+export declare function mergeHints(
+	a: Readonly<Hints>,
+	b: Readonly<Hints>,
+): Partial<{
+	missing:
+		| Partial<{
+				barelyMatchedElements?: number | undefined;
+				need?: string | undefined;
+		  }>
+		| undefined;
+	max?: number | undefined;
+	not?:
+		| import('packages/@markuplint/ml-core/lib').DocumentType<
+				import('./types').TagRule[],
+				import('./types').Options
+		  >
+		| import('packages/@markuplint/ml-core/lib/ml-dom/node/character-data').MLCharacterData<
+				import('./types').TagRule[],
+				import('./types').Options,
+				import('packages/@markuplint/ml-ast/lib').MLASTAbstractNode
+		  >
+		| import('packages/@markuplint/ml-core/lib').Element<import('./types').TagRule[], import('./types').Options>
+		| import('packages/@markuplint/ml-core/lib').Block<import('./types').TagRule[], import('./types').Options>
+		| undefined;
+	transparent?: Element | undefined;
+}>;
+export declare function cleanObject<T extends Object>(object: T): Partial<T>;
+export declare class Collection {
+	#private;
+	constructor(origin: readonly ChildNode[]);
+	get matched(): ChildNode[];
+	get matchedCount(): number;
+	get nodes(): ChildNode[];
+	get unmatched(): ChildNode[];
+	addMatched(nodes: ChildNode[]): boolean;
+	back(): void;
+	lock(): void;
+	max(max: number): void;
+	toString(highlightExtraNodes?: boolean): string;
+}
+export declare class UnsupportedError extends Error {}
+export declare function modelLog(model: ReadonlyDeep<Model | PermittedContentPattern[]>, repeat: RepeatSign): string;