@markuplint/ml-spec 3.0.0-rc.4 → 3.0.0

package/src/specs/get-spec-by-tag-name.spec.ts

@@ -1,68 +0,0 @@
-import { specs } from '@markuplint/html-spec';
-
-import { getSpecByTagName } from './get-spec-by-tag-name';
-
-const divSpec = {
-	conditional: [
-		{
-			condition: 'dl > div',
-			contents: [
-				{
-					zeroOrMore: ':model(script-supporting)',
-				},
-				{
-					oneOrMore: 'dt',
-				},
-				{
-					zeroOrMore: ':model(script-supporting)',
-				},
-				{
-					oneOrMore: 'dd',
-				},
-				{
-					zeroOrMore: ':model(script-supporting)',
-				},
-			],
-		},
-	],
-	contents: [
-		{
-			oneOrMore: ':model(flow)',
-		},
-	],
-};
-
-test('html:div', () => {
-	expect(getSpecByTagName(specs, 'div', null)?.contentModel).toStrictEqual(divSpec);
-	expect(getSpecByTagName(specs, 'div', 'unknown-namespace')?.contentModel).toStrictEqual(divSpec);
-	expect(getSpecByTagName(specs, 'div', 'http://www.w3.org/1999/xhtml')?.contentModel).toStrictEqual(divSpec);
-});
-
-test('svg:svg', () => {
-	expect(getSpecByTagName(specs, 'svg', 'http://www.w3.org/2000/svg')?.contentModel).toStrictEqual({
-		contents: [
-			{
-				zeroOrMore: [
-					':model(SVGAnimation)',
-					':model(SVGDescriptive)',
-					':model(SVGPaintServer)',
-					':model(SVGShape)',
-					':model(SVGStructural)',
-					'svg|a',
-					'svg|clipPath',
-					'svg|filter',
-					'svg|foreignObject',
-					'svg|image',
-					'svg|marker',
-					'svg|mask',
-					'svg|script',
-					'svg|style',
-					'svg|switch',
-					'svg|text',
-					'svg|view',
-				],
-			},
-		],
-	});
-	expect(getSpecByTagName(specs, 'svg', null)).toBe(null);
-});

package/src/specs/get-spec-by-tag-name.ts

@@ -1,20 +0,0 @@
-import type { ElementSpec } from '../types';
-
-import { resolveNamespace } from '../utils/resolve-namespace';
-
-const cache = new Map<string, any>();
-
-export function getSpecByTagName<K extends keyof ElementSpec = keyof ElementSpec>(
-	specs: Readonly<Pick<ElementSpec, 'name' | K>[]>,
-	localName: string,
-	namespace: string | null,
-) {
-	const { localNameWithNS } = resolveNamespace(localName, namespace || undefined);
-	let spec: Pick<ElementSpec, 'name' | K> | null | undefined = cache.get(localNameWithNS);
-	if (spec !== undefined) {
-		return spec;
-	}
-	spec = specs.find(spec => spec.name === localNameWithNS) || null;
-	cache.set(localNameWithNS, spec);
-	return spec;
-}

package/src/specs/is-nothing-content-model.ts

@@ -1,9 +0,0 @@
-import { isVoidElement } from './is-void-element';
-
-/**
- * @see https://html.spec.whatwg.org/multipage/dom.html#the-nothing-content-model
- * @see https://html.spec.whatwg.org/multipage/indices.html#elements-3
- */
-export function isNothingContentModel(el: Element) {
-	return isVoidElement(el) || ['iframe', 'template'].includes(el.localName);
-}

package/src/specs/is-palpable-elements.ts

@@ -1,55 +0,0 @@
-import type { MLMLSpec } from '../types';
-
-/**
- * Exposable content models and elements
- *
- * **WARNING**:
- * This implementation is through the author's interpretation.
- * Want a issue request.
- * https://github.com/markuplint/markuplint/issues/new
- *
- * @see https://html.spec.whatwg.org/multipage/indices.html#elements-3
- */
-const exposableElementsThatAreNoBelongingAModel: string[] = [
-	'body',
-	'dd',
-	'dt',
-	'figcaption',
-	'html',
-	'legend',
-	'li',
-	'optgroup',
-	'option',
-	'rp',
-	'rt',
-	'summary',
-	'tbody',
-	'td',
-	'tfoot',
-	'th',
-	'thead',
-	'tr',
-];
-
-export function isPalpableElement(
-	el: Element,
-	specs: Readonly<MLMLSpec>,
-	options?: {
-		extendsSvg?: boolean;
-		extendsExposableElements?: boolean;
-	},
-) {
-	const conditions = [specs.def['#contentModels']['#palpable']?.join(',') || ''];
-
-	if (options?.extendsSvg !== false /* default true */) {
-		conditions.push(specs.def['#contentModels']['#SVGRenderable']?.join(',') || '');
-	}
-
-	if (options?.extendsExposableElements /* default false */) {
-		conditions.push(exposableElementsThatAreNoBelongingAModel.join(','));
-	}
-
-	return conditions.some(condition => {
-		return el.matches(condition);
-	});
-}

package/src/specs/is-presentational.ts

@@ -1,6 +0,0 @@
-export function isPresentational(roleName?: string) {
-	if (!roleName) {
-		return false;
-	}
-	return ['presentation', 'none'].includes(roleName);
-}

package/src/specs/is-void-element.ts

@@ -1,22 +0,0 @@
-/**
- * @see https://html.spec.whatwg.org/multipage/syntax.html#void-elements
- */
-const voidElements = [
-	'area',
-	'base',
-	'br',
-	'col',
-	'embed',
-	'hr',
-	'img',
-	'input',
-	'link',
-	'meta',
-	'source',
-	'track',
-	'wbr',
-];
-
-export function isVoidElement(el: Element) {
-	return voidElements.includes(el.localName);
-}

package/src/specs/resolve-version.ts

@@ -1,20 +0,0 @@
-import type { ARIAVersion } from '../types';
-import type { ARIA } from '../types/aria';
-
-export function resolveVersion(aria: ARIA, version: ARIAVersion): Omit<ARIA, ARIAVersion> {
-	const implicitRole = aria[version]?.implicitRole ?? aria.implicitRole;
-	const permittedRoles = aria[version]?.permittedRoles ?? aria.permittedRoles;
-	const implicitProperties = aria[version]?.implicitProperties ?? aria.implicitProperties;
-	const properties = aria[version]?.properties ?? aria.properties;
-	const namingProhibited =
-		version === '1.2' ? aria[version]?.namingProhibited ?? aria.namingProhibited : aria.namingProhibited;
-	const conditions = aria[version]?.conditions ?? aria.conditions;
-	return {
-		implicitRole,
-		permittedRoles,
-		implicitProperties,
-		properties,
-		namingProhibited,
-		conditions,
-	};
-}

package/src/specs/schema-to-spec.spec.ts

@@ -1,39 +0,0 @@
-import htmlSpec from '@markuplint/html-spec';
-
-import { schemaToSpec } from './schema-to-spec';
-
-describe('getSpec', () => {
-	test('Overriding', () => {
-		const exAttr = {
-			ref: 'N/A',
-			type: 'Boolean',
-			description: 'For the unit test.',
-		} as const;
-		const exAttr2 = {
-			ref: 'N/A',
-			type: 'Boolean',
-			description: 'For the unit test. Override.',
-		} as const;
-		const mergedSpec = schemaToSpec([
-			htmlSpec,
-			{
-				specs: [
-					{
-						name: 'a',
-						attributes: { 'extended-attr': exAttr },
-					},
-				],
-			},
-			{
-				specs: [
-					{
-						name: 'a',
-						attributes: { 'extended-attr': exAttr2 },
-					},
-				],
-			},
-		]);
-		const aElAttrs = mergedSpec.specs.find(el => el.name === 'a')!.attributes;
-		expect(aElAttrs['extended-attr']).toStrictEqual(exAttr2);
-	});
-});

package/src/specs/schema-to-spec.ts

@@ -1,103 +0,0 @@
-import type { ElementSpec, ExtendedSpec, MLMLSpec, Attribute } from '../types';
-
-import { mergeArray } from '../utils/merge-array';
-
-/**
- * Merging HTML-spec schema and extended spec schemas
- *
- * Ex: `@markuplint/html-spec` + `{ specs: { "\\.vue$": "@markuplint/vue-spec" } }` in configure files.
- *
- * @param schemas `MLDocument.schemas`
- */
-export function schemaToSpec(schemas: readonly [MLMLSpec, ...ExtendedSpec[]]) {
-	const [main, ...extendedSpecs] = schemas;
-	const result = { ...main };
-	for (const extendedSpec of extendedSpecs) {
-		if (extendedSpec.cites) {
-			result.cites = [...result.cites, ...extendedSpec.cites];
-		}
-		if (extendedSpec.def) {
-			if (extendedSpec.def['#globalAttrs']?.['#extends']) {
-				result.def['#globalAttrs']['#HTMLGlobalAttrs'] = {
-					...(result.def['#globalAttrs']?.['#HTMLGlobalAttrs'] || {}),
-					...(extendedSpec.def['#globalAttrs']?.['#extends'] || {}),
-				};
-			}
-			if (extendedSpec.def['#aria']) {
-				result.def['#aria'] = {
-					'1.1': {
-						roles: mergeArray(result.def['#aria']['1.1'].roles, extendedSpec.def['#aria']['1.1'].roles),
-						props: mergeArray(result.def['#aria']['1.1'].props, extendedSpec.def['#aria']['1.1'].props),
-						graphicsRoles: mergeArray(
-							result.def['#aria']['1.1'].graphicsRoles,
-							extendedSpec.def['#aria']['1.1'].graphicsRoles,
-						),
-					},
-					'1.2': {
-						roles: mergeArray(result.def['#aria']['1.2'].roles, extendedSpec.def['#aria']['1.2'].roles),
-						props: mergeArray(result.def['#aria']['1.2'].props, extendedSpec.def['#aria']['1.2'].props),
-						graphicsRoles: mergeArray(
-							result.def['#aria']['1.2'].graphicsRoles,
-							extendedSpec.def['#aria']['1.2'].graphicsRoles,
-						),
-					},
-				};
-			}
-			if (extendedSpec.def['#contentModels']) {
-				const keys = new Set([
-					...Object.keys(result.def['#contentModels']),
-					...Object.keys(extendedSpec.def['#contentModels']),
-				]) as Set<keyof typeof result.def['#contentModels']>;
-				for (const modelName of keys) {
-					const mainModel = result.def['#contentModels'][modelName];
-					const exModel = extendedSpec.def['#contentModels'][modelName];
-					result.def['#contentModels'][modelName] = [...(mainModel || []), ...(exModel || [])];
-				}
-			}
-		}
-		if (extendedSpec.specs) {
-			const exSpecs = extendedSpec.specs.slice();
-			const specs: ElementSpec[] = [];
-			for (const elSpec of result.specs) {
-				const tagName = elSpec.name.toLowerCase();
-				const index = exSpecs.findIndex(spec => spec.name.toLowerCase() === tagName);
-				if (index === -1) {
-					specs.push(elSpec);
-					continue;
-				}
-				const exSpec = exSpecs.splice(index, 1)[0];
-				specs.push({
-					...elSpec,
-					...exSpec,
-					globalAttrs: {
-						...elSpec.globalAttrs,
-						...exSpec.globalAttrs,
-					},
-					attributes: mergeAttrSpec(elSpec.attributes, exSpec.attributes),
-					categories: mergeArray(elSpec.categories, exSpec.categories),
-				});
-			}
-
-			result.specs = specs;
-		}
-	}
-
-	return result;
-}
-
-function mergeAttrSpec(
-	std: Record<string, Attribute>,
-	ex: Record<string, Partial<Attribute>> = {},
-): Record<string, Attribute> {
-	const result: Record<string, Attribute> = {};
-	const keys = Array.from(new Set([...Object.keys(std), ...Object.keys(ex)]));
-	for (const key of keys) {
-		const _std = std[key];
-		const _ex = ex[key];
-		result[key] = {
-			..._std,
-			..._ex,
-		};
-	}
-	return result;
-}

package/src/types/aria.ts

@@ -1,153 +0,0 @@
-/* tslint:disable */
-/**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
- */
-
-/**
- * If `false`, this mean is "No corresponding role".
- */
-export type ImplicitRole = false | string;
-/**
- * If `true`, this mean is "Any". If `false`, this mean is "No".
- */
-export type PermittedRoles =
-	| boolean
-	| (
-			| string
-			| {
-					name: string;
-					deprecated?: true;
-					[k: string]: unknown;
-			  }
-	  )[]
-	| {
-			'core-aam'?: true;
-			'graphics-aam'?: true;
-	  };
-/**
- * If set false:
- * > No role or aria-* attributes
- */
-export type PermittedARIAProperties =
-	| false
-	| {
-			global?: true;
-			/**
-			 * Set true if the spec says "and any aria-* attributes applicable to the allowed roles."
-			 */
-			role?: true | string | [string, ...string[]];
-			/**
-			 * @minItems 1
-			 */
-			only?: [
-				(
-					| string
-					| {
-							name: string;
-							value?: string;
-					  }
-				),
-				...(
-					| string
-					| {
-							name: string;
-							value?: string;
-					  }
-				)[],
-			];
-			/**
-			 * @minItems 1
-			 */
-			without?: [
-				{
-					type: 'not-recommended' | 'should-not' | 'must-not';
-					name: string;
-					value?: string;
-					alt?: {
-						method: 'remove-attr' | 'set-attr';
-						target: string;
-					};
-				},
-				...{
-					type: 'not-recommended' | 'should-not' | 'must-not';
-					name: string;
-					value?: string;
-					alt?: {
-						method: 'remove-attr' | 'set-attr';
-						target: string;
-					};
-				}[],
-			];
-	  };
-
-export interface AriaSchema {
-	_?: ARIA;
-	[k: string]: unknown;
-}
-export interface ARIA {
-	implicitRole: ImplicitRole;
-	permittedRoles: PermittedRoles;
-	namingProhibited?: true;
-	implicitProperties?: ImplicitProperties;
-	properties?: PermittedARIAProperties;
-	conditions?: {
-		/**
-		 * This interface was referenced by `undefined`'s JSON-Schema definition
-		 * via the `patternProperty` ".+".
-		 */
-		[k: string]: {
-			implicitRole?: ImplicitRole;
-			permittedRoles?: PermittedRoles;
-			namingProhibited?: true;
-			implicitProperties?: ImplicitProperties;
-			properties?: PermittedARIAProperties;
-		};
-	};
-	'1.2'?: {
-		implicitRole?: ImplicitRole;
-		permittedRoles?: PermittedRoles;
-		namingProhibited?: true;
-		implicitProperties?: ImplicitProperties;
-		properties?: PermittedARIAProperties;
-		conditions?: {
-			/**
-			 * This interface was referenced by `undefined`'s JSON-Schema definition
-			 * via the `patternProperty` ".+".
-			 */
-			[k: string]: {
-				implicitRole?: ImplicitRole;
-				permittedRoles?: PermittedRoles;
-				namingProhibited?: true;
-				implicitProperties?: ImplicitProperties;
-				properties?: PermittedARIAProperties;
-			};
-		};
-	};
-	'1.1'?: {
-		implicitRole?: ImplicitRole;
-		permittedRoles?: PermittedRoles;
-		implicitProperties?: ImplicitProperties;
-		properties?: PermittedARIAProperties;
-		conditions?: {
-			/**
-			 * This interface was referenced by `undefined`'s JSON-Schema definition
-			 * via the `patternProperty` ".+".
-			 */
-			[k: string]: {
-				implicitRole?: ImplicitRole;
-				permittedRoles?: PermittedRoles;
-				implicitProperties?: ImplicitProperties;
-				properties?: PermittedARIAProperties;
-			};
-		};
-	};
-}
-export interface ImplicitProperties {
-	/**
-	 * This interface was referenced by `ImplicitProperties`'s JSON-Schema definition
-	 * via the `patternProperty` "^aria-.+".
-	 */
-	[k: string]: string;
-}