@markuplint/ml-spec 3.0.0-alpha.0 → 3.0.0-alpha.2

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

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

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

@@ -5,7 +5,7 @@ import { mergeArray } from '../utils/merge-array';
 /**
  * Merging HTML-spec schema and extended spec schemas
  *
- * Ex: `@markuplint/html-spec` + `{ specs: ["@markuplint/vue-spec"] }` in cofigure files.
+ * Ex: `@markuplint/html-spec` + `{ specs: ["@markuplint/vue-spec"] }` in configure files.
  *
  * @param schemas `MLDocument.schemas`
  */

package/src/types/aria.ts

@@ -38,6 +38,9 @@ export type PermittedARIAProperties =
 			 * Set true if the spec says "and any aria-* attributes applicable to the allowed roles."
 			 */
 			role?: true | string | [string, ...string[]];
+			/**
+			 * @minItems 1
+			 */
 			only?: [
 				(
 					| string
@@ -54,7 +57,10 @@ export type PermittedARIAProperties =
 					  }
 				)[],
 			];
-			whithout?: [
+			/**
+			 * @minItems 1
+			 */
+			without?: [
 				{
 					type: 'not-recommended' | 'should-not' | 'must-not';
 					name: string;

package/src/types/attributes.ts

@@ -1013,111 +1013,9 @@ export type AttributeType =
 			  )
 			| 'Boolean'
 	  )
-	| {
-			token:
-				| (
-						| 'Any'
-						| 'NoEmptyAny'
-						| 'OneLineAny'
-						| 'Zero'
-						| 'Number'
-						| 'Int'
-						| 'Uint'
-						| 'XMLName'
-						| 'DOMID'
-						| 'FunctionBody'
-						| 'Pattern'
-						| 'DateTime'
-						| 'TabIndex'
-						| 'BCP47'
-						| 'URL'
-						| 'AbsoluteURL'
-						| 'HashName'
-						| 'OneCodePointChar'
-						| 'CustomElementName'
-						| 'BrowsingContextName'
-						| 'BrowsingContextNameOrKeyword'
-						| 'HTTPSchemaURL'
-						| 'MIMEType'
-						| 'ItemProp'
-						| 'Srcset'
-						| 'SourceSizeList'
-						| 'IconSize'
-						| 'AutoComplete'
-						| 'Accept'
-						| 'SerializedPermissionsPolicy'
-						| '<css-declaration-list>'
-						| '<class-list>'
-						| '<svg-font-size>'
-						| '<svg-font-size-adjust>'
-						| "<'color-profile'>"
-						| "<'color-rendering'>"
-						| "<'enable-background'>"
-						| '<list-of-svg-feature-string>'
-						| '<animatable-value>'
-						| '<begin-value-list>'
-						| '<end-value-list>'
-						| '<list-of-value>'
-						| '<clock-value>'
-						| '<color-matrix>'
-						| '<dasharray>'
-						| '<key-points>'
-						| '<key-splines>'
-						| '<key-times>'
-						| '<system-language>'
-						| '<origin>'
-						| '<svg-path>'
-						| '<points>'
-						| '<preserve-aspect-ratio>'
-						| '<view-box>'
-						| '<rotate>'
-						| '<text-coordinate>'
-						| '<list-of-lengths>'
-						| '<list-of-numbers>'
-						| '<list-of-percentages>'
-						| '<number-optional-number>'
-				  )
-				| {
-						enum: [string, ...string[]];
-						disallowToSurroundBySpaces?: boolean;
-						caseInsensitive?: boolean;
-						invalidValueDefault?: string;
-						missingValueDefault?: string;
-						sameStates?: {
-							[k: string]: unknown;
-						};
-				  };
-			disallowToSurroundBySpaces?: boolean;
-			allowEmpty?: boolean;
-			ordered?: boolean;
-			unique?: boolean;
-			caseInsensitive?: boolean;
-			number?:
-				| ('zeroOrMore' | 'oneOrMore')
-				| {
-						min: number;
-						max: number;
-				  };
-			separator: 'space' | 'comma';
-	  }
-	| {
-			enum: [string, ...string[]];
-			disallowToSurroundBySpaces?: boolean;
-			caseInsensitive?: boolean;
-			invalidValueDefault?: string;
-			missingValueDefault?: string;
-			sameStates?: {
-				[k: string]: unknown;
-			};
-	  }
-	| {
-			type: 'float' | 'integer';
-			gt?: number;
-			gte?: number;
-			lt?: number;
-			lte?: number;
-			clampable?: boolean;
-	  };
+	| List
+	| Enum
+	| Number;
 export type AttributeCondition = string | [string, string, ...string[]];
 
 export interface AttributesSchema {
@@ -1208,6 +1106,9 @@ export interface GlobalAttributes {
 				| 'onwheel'
 		  )[];
 	'#DocumentElementEventAttrs'?: boolean | ('oncopy' | 'oncut' | 'onpaste')[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLLinkAndFetchingAttrs'?: (
 		| 'crossorigin'
 		| 'download'
@@ -1223,6 +1124,9 @@ export interface GlobalAttributes {
 		| 'type'
 		| 'fetchpriority'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLEmbededAndMediaContentAttrs'?: (
 		| 'autoplay'
 		| 'controls'
@@ -1235,6 +1139,9 @@ export interface GlobalAttributes {
 		| 'srcset'
 		| 'width'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLFormControlElementAttrs'?: (
 		| 'autocomplete'
 		| 'dirname'
@@ -1251,12 +1158,30 @@ export interface GlobalAttributes {
 		| 'readonly'
 		| 'required'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#HTMLTableCellElementAttrs'?: ('colspan' | 'headers' | 'rowspan')[];
 	'#ARIAAttrs'?: boolean;
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationAdditionAttrs'?: ('additive' | 'accumulate')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationAttributeTargetAttrs'?: ('attributeName' | 'attributeType')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationEventAttrs'?: ('onbegin' | 'onend' | 'onrepeat')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationTargetElementAttrs'?: ('href' | 'xlink:href')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationTimingAttrs'?: (
 		| 'begin'
 		| 'dur'
@@ -1268,6 +1193,9 @@ export interface GlobalAttributes {
 		| 'repeatDur'
 		| 'fill'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGAnimationValueAttrs'?: (
 		| 'calcMode'
 		| 'values'
@@ -1281,7 +1209,13 @@ export interface GlobalAttributes {
 		| 'autoReverse'
 		| 'speed'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGConditionalProcessingAttrs'?: ('requiredExtensions' | 'systemLanguage' | 'requiredFeatures')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGCoreAttrs'?: (
 		| 'id'
 		| 'tabindex'
@@ -1294,7 +1228,13 @@ export interface GlobalAttributes {
 		| 'xml:lang'
 		| 'xml:base'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGFilterPrimitiveAttrs'?: ('x' | 'y' | 'width' | 'height' | 'result' | 'in')[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGPresentationAttrs'?: (
 		| 'cx'
 		| 'cy'
@@ -1378,6 +1318,9 @@ export interface GlobalAttributes {
 		| 'enable-background'
 		| 'kerning'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#SVGTransferFunctionAttrs'?: (
 		| 'type'
 		| 'tableValues'
@@ -1387,6 +1330,9 @@ export interface GlobalAttributes {
 		| 'exponent'
 		| 'offset'
 	)[];
+	/**
+	 * @minItems 0
+	 */
 	'#XLinkAttrs'?: (
 		| 'xlink:href'
 		| 'xlink:title'
@@ -1416,3 +1362,112 @@ export interface AttributeJSON {
 	animatable?: boolean;
 	experimental?: boolean;
 }
+/**
+ * - [Space-separated tokens](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#space-separated-tokens)
+ * - [Comma-separated tokens](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#comma-separated-tokens)
+ */
+export interface List {
+	token:
+		| (
+				| 'Any'
+				| 'NoEmptyAny'
+				| 'OneLineAny'
+				| 'Zero'
+				| 'Number'
+				| 'Int'
+				| 'Uint'
+				| 'XMLName'
+				| 'DOMID'
+				| 'FunctionBody'
+				| 'Pattern'
+				| 'DateTime'
+				| 'TabIndex'
+				| 'BCP47'
+				| 'URL'
+				| 'AbsoluteURL'
+				| 'HashName'
+				| 'OneCodePointChar'
+				| 'CustomElementName'
+				| 'BrowsingContextName'
+				| 'BrowsingContextNameOrKeyword'
+				| 'HTTPSchemaURL'
+				| 'MIMEType'
+				| 'ItemProp'
+				| 'Srcset'
+				| 'SourceSizeList'
+				| 'IconSize'
+				| 'AutoComplete'
+				| 'Accept'
+				| 'SerializedPermissionsPolicy'
+				| '<css-declaration-list>'
+				| '<class-list>'
+				| '<svg-font-size>'
+				| '<svg-font-size-adjust>'
+				| "<'color-profile'>"
+				| "<'color-rendering'>"
+				| "<'enable-background'>"
+				| '<list-of-svg-feature-string>'
+				| '<animatable-value>'
+				| '<begin-value-list>'
+				| '<end-value-list>'
+				| '<list-of-value>'
+				| '<clock-value>'
+				| '<color-matrix>'
+				| '<dasharray>'
+				| '<key-points>'
+				| '<key-splines>'
+				| '<key-times>'
+				| '<system-language>'
+				| '<origin>'
+				| '<svg-path>'
+				| '<points>'
+				| '<preserve-aspect-ratio>'
+				| '<view-box>'
+				| '<rotate>'
+				| '<text-coordinate>'
+				| '<list-of-lengths>'
+				| '<list-of-numbers>'
+				| '<list-of-percentages>'
+				| '<number-optional-number>'
+		  )
+		| Enum;
+	disallowToSurroundBySpaces?: boolean;
+	allowEmpty?: boolean;
+	ordered?: boolean;
+	unique?: boolean;
+	caseInsensitive?: boolean;
+	number?:
+		| ('zeroOrMore' | 'oneOrMore')
+		| {
+				min: number;
+				max: number;
+		  };
+	separator: 'space' | 'comma';
+}
+/**
+ * [Enumerated attributes](https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#enumerated-attribute)
+ */
+export interface Enum {
+	/**
+	 * @minItems 1
+	 */
+	enum: [string, ...string[]];
+	disallowToSurroundBySpaces?: boolean;
+	caseInsensitive?: boolean;
+	invalidValueDefault?: string;
+	missingValueDefault?: string;
+	sameStates?: {
+		[k: string]: unknown;
+	};
+}
+/**
+ * [Numbers](https://html.spec.whatwg.org/dev/common-microsyntaxes.html#numbers)
+ */
+export interface Number {
+	type: 'float' | 'integer';
+	gt?: number;
+	gte?: number;
+	lt?: number;
+	lte?: number;
+	clampable?: boolean;
+}

package/src/types/index.ts

@@ -1,10 +1,10 @@
 import type { ARIA } from './aria';
 import type { AttributeJSON, AttributeType, GlobalAttributes } from './attributes';
-import type { ContentModel, Category } from './permitted-structres';
+import type { ContentModel, Category } from './permitted-structures';
 import type { NamespaceURI } from '@markuplint/ml-ast';
 
 /**
- * markuplit Markup-language spec
+ * markuplint Markup-language spec
  */
 export interface MLMLSpec {
 	cites: Cites;
@@ -97,7 +97,7 @@ export type ElementSpec = {
 	nonStandard?: true;
 
 	/**
-	 * Element cateogries
+	 * Element categories
 	 */
 	categories: Category[];
 
@@ -107,9 +107,9 @@ export type ElementSpec = {
 	contentModel: ContentModel;
 
 	/**
-	 * Tag omittion
+	 * Tag omission
 	 */
-	omittion: ElementSpecOmittion;
+	omission: ElementSpecOmission;
 
 	/**
 	 * Global Attributes
@@ -122,7 +122,7 @@ export type ElementSpec = {
 	attributes: Record<string, Attribute>;
 
 	/**
-	 * WAI-ARIA role and properies
+	 * WAI-ARIA role and properties
 	 */
 	aria: ARIA;
 
@@ -137,9 +137,9 @@ export type ElementSpec = {
 	possibleToAddProperties?: true;
 };
 
-type ElementSpecOmittion = false | ElementSpecOmittionTags;
+type ElementSpecOmission = false | ElementSpecOmissionTags;
 
-type ElementSpecOmittionTags = {
+type ElementSpecOmissionTags = {
 	startTag: boolean | ElementCondition;
 	endTag: boolean | ElementCondition;
 };

package/src/types/permitted-structres.ts

@@ -5,14 +5,14 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export type PermittedContent =
+export type PermittedContentPattern =
 	| PermittedContentRequire
 	| PermittedContentOptional
 	| PermittedContentOneOrMore
 	| PermittedContentZeroOrMore
 	| PermittedContentChoice
-	| PermittedContentInterleave;
-export type Target = ContentType | ContentType[];
+	| PermittedContentTransparent;
+export type Model = ContentType | ContentType[];
 export type ContentType = string | Category;
 export type Category =
 	| '#text'
@@ -22,7 +22,6 @@ export type Category =
 	| '#heading'
 	| '#sectioning'
 	| '#metadata'
-	| '#transparent'
 	| '#embedded'
 	| '#palpable'
 	| '#script-supporting'
@@ -46,63 +45,57 @@ export type Category =
 	| '#SVGTextContent'
 	| '#SVGTextContentChild'
 	| '#SVGOtherXMLNamespace';
-export type PermittedContentSpec = PermittedContent[];
 
 export interface ContentModelsSchema {
 	__contentModel?: ContentModel;
 }
 export interface ContentModel {
-	contents: PermittedContentSpec | boolean;
+	contents: PermittedContentPattern[] | boolean;
 	descendantOf?: string;
 	conditional?: {
 		condition: string;
-		contents: PermittedContentSpec | boolean;
+		contents: PermittedContentPattern[] | boolean;
 	}[];
 }
 export interface PermittedContentRequire {
-	require: Target;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	require: Model;
 	max?: number;
 	min?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentOptional {
-	optional: Target;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	optional: Model;
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentOneOrMore {
-	oneOrMore: Target | PermittedContentSpec;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	oneOrMore: Model | PermittedContentPattern[];
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentZeroOrMore {
-	zeroOrMore: Target | PermittedContentSpec;
-	ignore?: Target;
-	notAllowedDescendants?: ContentType[];
+	zeroOrMore: Model | PermittedContentPattern[];
 	max?: number;
 	_TODO_?: string;
 }
 export interface PermittedContentChoice {
+	/**
+	 * @minItems 2
+	 * @maxItems 5
+	 */
 	choice:
-		| [PermittedContentSpec, PermittedContentSpec]
-		| [PermittedContentSpec, PermittedContentSpec, PermittedContentSpec]
-		| [PermittedContentSpec, PermittedContentSpec, PermittedContentSpec, PermittedContentSpec]
+		| [PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
 		| [
-				PermittedContentSpec,
-				PermittedContentSpec,
-				PermittedContentSpec,
-				PermittedContentSpec,
-				PermittedContentSpec,
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
 		  ];
 	_TODO_?: string;
 }
-export interface PermittedContentInterleave {
-	interleave: [PermittedContentSpec, PermittedContentSpec, ...PermittedContentSpec[]];
-	_TODO_?: string;
+export interface PermittedContentTransparent {
+	transparent: string;
 }

package/src/types/permitted-structures.ts

@@ -0,0 +1,97 @@
+/* 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.
+ */
+
+export type PermittedContentPattern =
+	| PermittedContentRequire
+	| PermittedContentOptional
+	| PermittedContentOneOrMore
+	| PermittedContentZeroOrMore
+	| PermittedContentChoice
+	| PermittedContentTransparent;
+export type Model = ContentType | ContentType[];
+export type ContentType = string | Category;
+export type Category =
+	| '#text'
+	| '#phrasing'
+	| '#flow'
+	| '#interactive'
+	| '#heading'
+	| '#sectioning'
+	| '#metadata'
+	| '#embedded'
+	| '#palpable'
+	| '#script-supporting'
+	| '#SVGAnimation'
+	| '#SVGBasicShapes'
+	| '#SVGContainer'
+	| '#SVGDescriptive'
+	| '#SVGFilterPrimitive'
+	| '#SVGFont'
+	| '#SVGGradient'
+	| '#SVGGraphics'
+	| '#SVGGraphicsReferencing'
+	| '#SVGLightSource'
+	| '#SVGNeverRendered'
+	| '#SVGNone'
+	| '#SVGPaintServer'
+	| '#SVGRenderable'
+	| '#SVGShape'
+	| '#SVGStructural'
+	| '#SVGStructurallyExternal'
+	| '#SVGTextContent'
+	| '#SVGTextContentChild'
+	| '#SVGOtherXMLNamespace';
+
+export interface ContentModelsSchema {
+	__contentModel?: ContentModel;
+}
+export interface ContentModel {
+	contents: PermittedContentPattern[] | boolean;
+	descendantOf?: string;
+	conditional?: {
+		condition: string;
+		contents: PermittedContentPattern[] | boolean;
+	}[];
+}
+export interface PermittedContentRequire {
+	require: Model;
+	max?: number;
+	min?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentOptional {
+	optional: Model;
+	max?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentOneOrMore {
+	oneOrMore: Model | PermittedContentPattern[];
+	max?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentZeroOrMore {
+	zeroOrMore: Model | PermittedContentPattern[];
+	max?: number;
+	_TODO_?: string;
+}
+export interface PermittedContentChoice {
+	choice:
+		| [PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[], PermittedContentPattern[]]
+		| [
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+				PermittedContentPattern[],
+		  ];
+	_TODO_?: string;
+}
+export interface PermittedContentTransparent {
+	transparent: string;
+}