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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/ml-spec",
-	"version": "2.0.1",
+	"version": "3.0.0-alpha.0",
 	"description": "Types and schema that specs of the Markup languages for markuplint",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -16,16 +16,20 @@
 		"dev": "tsc --build --watch",
 		"clean": "tsc --build --clean",
 		"schema:gen": "ts-node ./gen/gen.ts; prettier --write './schemas/*.json';",
-		"schema:structures": "json2ts ./schemas/permitted-structures.schema.json > ./src/permitted-structres.ts; prettier --write ./src/permitted-structres.ts; eslint --fix --config ../../../.eslintrc ./src/permitted-structres.ts",
-		"schema:attributes": "json2ts ./schemas/attributes.schema.json --cwd ./schemas > ./src/attributes.ts; prettier --write ./src/attributes.ts; eslint --fix --config ../../../.eslintrc ./src/attributes.ts",
-		"schema": "yarn schema:gen; yarn schema:structures; yarn schema:attributes; tsc;"
+		"schema:content-models": "json2ts ./schemas/content-models.schema.json > ./src/types/permitted-structres.ts; prettier --write ./src/types/permitted-structres.ts; eslint --fix --config ../../../.eslintrc ./src/types/permitted-structres.ts",
+		"schema:attributes": "json2ts ./schemas/attributes.schema.json --cwd ./schemas > ./src/types/attributes.ts; prettier --write ./src/types/attributes.ts; eslint --fix --config ../../../.eslintrc ./src/types/attributes.ts",
+		"schema:aria": "json2ts ./schemas/aria.schema.json --cwd ./schemas > ./src/types/aria.ts; prettier --write ./src/types/aria.ts; eslint --fix --config ../../../.eslintrc ./src/types/aria.ts",
+		"schema": "run-s schema:*"
 	},
 	"dependencies": {
+		"@markuplint/ml-ast": "3.0.0-alpha.0",
+		"dom-accessibility-api": "^0.5.14",
 		"tslib": "^2.3.1"
 	},
 	"devDependencies": {
-		"@markuplint/types": "2.0.1-dev.20220307.0",
+		"@markuplint/test-tools": "3.0.0-alpha.0",
+		"@markuplint/types": "3.0.0-alpha.0",
 		"json-schema-to-typescript": "^10.1.5"
 	},
-	"gitHead": "9ea66f99f9c14ee53099c306636b76617f12ad7a"
+	"gitHead": "d32c522e016888e20bcbb5f09352c006b964f193"
 }

package/schemas/aria.schema.json

@@ -0,0 +1,258 @@
+{
+	"definitions": {
+		"PermittedRoles": {
+			"description": "If `true`, this mean is \"Any\". If `false`, this mean is \"No\".",
+			"oneOf": [
+				{
+					"type": "boolean"
+				},
+				{
+					"type": "array",
+					"items": {
+						"oneOf": [
+							{
+								"type": "string"
+							},
+							{
+								"type": "object",
+								"required": ["name"],
+								"minProperties": 2,
+								"properties": {
+									"name": { "type": "string" },
+									"deprecated": { "type": "boolean", "enum": [true] }
+								}
+							}
+						]
+					}
+				},
+				{
+					"type": "object",
+					"minProperties": 1,
+					"additionalProperties": false,
+					"properties": {
+						"core-aam": {
+							"type": "boolean",
+							"enum": [true]
+						},
+						"graphics-aam": {
+							"type": "boolean",
+							"enum": [true]
+						}
+					}
+				}
+			]
+		},
+		"PermittedARIAProperties": {
+			"description": "If set false:\n> No role or aria-* attributes",
+			"oneOf": [
+				{
+					"type": "boolean",
+					"enum": [false]
+				},
+				{
+					"type": "object",
+					"minProperties": 1,
+					"additionalProperties": false,
+					"properties": {
+						"global": {
+							"type": "boolean",
+							"enum": [true]
+						},
+						"role": {
+							"description": "Set true if the spec says \"and any aria-* attributes applicable to the allowed roles.\"",
+							"oneOf": [
+								{
+									"type": "boolean",
+									"enum": [true]
+								},
+								{
+									"type": "string"
+								},
+								{
+									"type": "array",
+									"minItems": 1,
+									"items": { "type": "string" }
+								}
+							]
+						},
+						"only": {
+							"type": "array",
+							"minItems": 1,
+							"items": {
+								"oneOf": [
+									{
+										"type": "string",
+										"pattern": "^aria-.+"
+									},
+									{
+										"type": "object",
+										"required": ["name"],
+										"additionalProperties": false,
+										"properties": {
+											"name": {
+												"type": "string",
+												"pattern": "^aria-.+"
+											},
+											"value": {
+												"type": "string"
+											}
+										}
+									}
+								]
+							}
+						},
+						"whithout": {
+							"type": "array",
+							"minItems": 1,
+							"items": {
+								"type": "object",
+								"required": ["type", "name"],
+								"additionalProperties": false,
+								"properties": {
+									"type": {
+										"type": "string",
+										"enum": ["not-recommended", "should-not", "must-not"]
+									},
+									"name": {
+										"type": "string",
+										"pattern": "^aria-.+"
+									},
+									"value": {
+										"type": "string"
+									},
+									"alt": {
+										"type": "object",
+										"required": ["method", "target"],
+										"additionalProperties": false,
+										"properties": {
+											"method": {
+												"type": "string",
+												"enum": ["remove-attr", "set-attr"]
+											},
+											"target": {
+												"type": "string"
+											}
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			]
+		},
+		"ImplicitRole": {
+			"description": "If `false`, this mean is \"No corresponding role\".",
+			"oneOf": [
+				{
+					"type": "boolean",
+					"enum": [false]
+				},
+				{
+					"type": "string"
+				}
+			]
+		},
+		"ImplicitProperties": {
+			"type": "object",
+			"minProperties": 1,
+			"patternProperties": {
+				"^aria-.+": {
+					"type": "string"
+				}
+			}
+		},
+		"ARIA": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["implicitRole", "permittedRoles"],
+			"properties": {
+				"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+				"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+				"namingProhibited": { "type": "boolean", "enum": [true] },
+				"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+				"properties": { "$ref": "#/definitions/PermittedARIAProperties" },
+				"conditions": {
+					"type": "object",
+					"minProperties": 1,
+					"patternProperties": {
+						".+": {
+							"type": "object",
+							"minProperties": 1,
+							"additionalProperties": false,
+							"properties": {
+								"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+								"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+								"namingProhibited": { "type": "boolean", "enum": [true] },
+								"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+								"properties": { "$ref": "#/definitions/PermittedARIAProperties" }
+							}
+						}
+					}
+				},
+				"1.2": {
+					"type": "object",
+					"additionalProperties": false,
+					"minProperties": 1,
+					"properties": {
+						"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+						"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+						"namingProhibited": { "type": "boolean", "enum": [true] },
+						"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+						"properties": { "$ref": "#/definitions/PermittedARIAProperties" },
+						"conditions": {
+							"type": "object",
+							"minProperties": 1,
+							"patternProperties": {
+								".+": {
+									"type": "object",
+									"minProperties": 1,
+									"additionalProperties": false,
+									"properties": {
+										"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+										"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+										"namingProhibited": { "type": "boolean", "enum": [true] },
+										"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+										"properties": { "$ref": "#/definitions/PermittedARIAProperties" }
+									}
+								}
+							}
+						}
+					}
+				},
+				"1.1": {
+					"type": "object",
+					"additionalProperties": false,
+					"minProperties": 1,
+					"properties": {
+						"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+						"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+						"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+						"properties": { "$ref": "#/definitions/PermittedARIAProperties" },
+						"conditions": {
+							"type": "object",
+							"minProperties": 1,
+							"patternProperties": {
+								".+": {
+									"type": "object",
+									"minProperties": 1,
+									"additionalProperties": false,
+									"properties": {
+										"implicitRole": { "$ref": "#/definitions/ImplicitRole" },
+										"permittedRoles": { "$ref": "#/definitions/PermittedRoles" },
+										"implicitProperties": { "$ref": "#/definitions/ImplicitProperties" },
+										"properties": { "$ref": "#/definitions/PermittedARIAProperties" }
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"type": "object",
+	"properties": {
+		"_": { "$ref": "#/definitions/ARIA" }
+	}
+}

package/schemas/attributes.schema.json

@@ -1,22 +1,7 @@
 {
 	"definitions": {
 		"AttributeName": { "type": "string", "pattern": "^(?:(xml|xlink):)?[a-z][a-zA-Z0-9-]*$" },
-		"AttributeCondition": {
-			"oneOf": [
-				{
-					"type": "object",
-					"additionalProperties": false,
-					"required": ["ancestor"],
-					"properties": { "ancestor": { "$ref": "#/definitions/Selectors" } }
-				},
-				{
-					"type": "object",
-					"additionalProperties": false,
-					"required": ["self"],
-					"properties": { "self": { "$ref": "#/definitions/Selectors" } }
-				}
-			]
-		},
+		"AttributeCondition": { "$ref": "#/definitions/Selectors" },
 		"Selectors": {
 			"oneOf": [{ "type": "string" }, { "type": "array", "minItems": 2, "items": { "type": "string" } }]
 		},
@@ -24,11 +9,8 @@
 		"AttributeJSON": {
 			"type": "object",
 			"additionalProperties": false,
-			"required": ["ref"],
-			"minProperties": 2,
+			"minProperties": 1,
 			"properties": {
-				"_TODO_": { "type": "string" },
-				"ref": { "type": "string", "format": "uri" },
 				"type": {
 					"oneOf": [
 						{ "$ref": "#/definitions/AttributeType" },
@@ -47,7 +29,8 @@
 				"noUse": { "type": "boolean" },
 				"condition": { "$ref": "#/definitions/AttributeCondition" },
 				"ineffective": { "$ref": "#/definitions/Selectors" },
-				"animatable": { "type": "boolean" }
+				"animatable": { "type": "boolean" },
+				"experimental": { "type": "boolean" }
 			}
 		},
 		"GlobalAttributes": {
@@ -212,10 +195,9 @@
 	},
 	"type": "object",
 	"additionalProperties": false,
-	"required": ["tag", "ref", "attributes"],
+	"required": ["tag", "attributes"],
 	"properties": {
 		"tag": { "type": "string" },
-		"ref": { "type": "string", "format": "uri" },
 		"global": { "$ref": "#/definitions/GlobalAttributes" },
 		"attributes": { "$ref": "#/definitions/Attributes" }
 	}

package/schemas/{permitted-structures.schema.json → content-models.schema.json}

@@ -1,33 +1,56 @@
 {
 	"definitions": {
-		"Node": {
-			"oneOf": [
-				{
-					"description": "HTML Element",
-					"type": "string",
-					"pattern": "^[a-z][a-z0-9]*$"
-				},
-				{
-					"description": "Namespaced HTML Element",
-					"type": "string",
-					"pattern": "^html:[a-z][a-z0-9]*$"
-				},
-				{
-					"description": "SVG Element",
-					"type": "string",
-					"pattern": "^svg:(?:[a-z][a-zA-Z0-9]*|[a-z][a-z0-9]*-[a-z][a-z0-9]*)$"
+		"ContentModel": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["contents"],
+			"properties": {
+				"contents": {
+					"oneOf": [
+						{
+							"$ref": "#/definitions/PermittedContentSpec"
+						},
+						{ "type": "boolean" }
+					]
 				},
+				"descendantOf": { "type": "string" },
+				"conditional": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"additionalProperties": false,
+						"required": ["condition", "contents"],
+						"properties": {
+							"condition": {
+								"type": "string"
+							},
+							"contents": {
+								"oneOf": [
+									{
+										"$ref": "#/definitions/PermittedContentSpec"
+									},
+									{ "type": "boolean" }
+								]
+							}
+						}
+					}
+				}
+			}
+		},
+		"ContentType": {
+			"oneOf": [
 				{
-					"description": "Text Node",
+					"description": "Element",
 					"type": "string",
-					"enum": ["#text"]
+					"pattern": "^[^#]+$"
 				},
-				{ "$ref": "#/definitions/ContentModel" }
+				{ "$ref": "#/definitions/Category" }
 			]
 		},
-		"ContentModel": {
+		"Category": {
 			"type": "string",
 			"enum": [
+				"#text",
 				"#phrasing",
 				"#flow",
 				"#interactive",
@@ -62,10 +85,10 @@
 		},
 		"Target": {
 			"oneOf": [
-				{ "$ref": "#/definitions/Node" },
+				{ "$ref": "#/definitions/ContentType" },
 				{
 					"type": "array",
-					"items": { "$ref": "#/definitions/Node" },
+					"items": { "$ref": "#/definitions/ContentType" },
 					"uniqueItems": true
 				}
 			]
@@ -94,7 +117,7 @@
 				"ignore": { "$ref": "#/definitions/Target" },
 				"notAllowedDescendants": {
 					"type": "array",
-					"items": { "$ref": "#/definitions/Node" },
+					"items": { "$ref": "#/definitions/ContentType" },
 					"uniqueItems": true
 				},
 				"max": { "type": "number" },
@@ -111,7 +134,7 @@
 				"ignore": { "$ref": "#/definitions/Target" },
 				"notAllowedDescendants": {
 					"type": "array",
-					"items": { "$ref": "#/definitions/Node" },
+					"items": { "$ref": "#/definitions/ContentType" },
 					"uniqueItems": true
 				},
 				"max": { "type": "number" },
@@ -129,7 +152,7 @@
 				"ignore": { "$ref": "#/definitions/Target" },
 				"notAllowedDescendants": {
 					"type": "array",
-					"items": { "$ref": "#/definitions/Node" },
+					"items": { "$ref": "#/definitions/ContentType" },
 					"uniqueItems": true
 				},
 				"max": { "type": "number" },
@@ -147,7 +170,7 @@
 				"ignore": { "$ref": "#/definitions/Target" },
 				"notAllowedDescendants": {
 					"type": "array",
-					"items": { "$ref": "#/definitions/Node" },
+					"items": { "$ref": "#/definitions/ContentType" },
 					"uniqueItems": true
 				},
 				"max": { "type": "number" },
@@ -184,61 +207,9 @@
 	},
 	"type": "object",
 	"additionalProperties": false,
-	"required": ["tag", "contents"],
 	"properties": {
-		"summary": { "type": "string" },
-		"tag": { "type": "string" },
-		"conditional": {
-			"type": "array",
-			"items": {
-				"type": "object",
-				"additionalProperties": false,
-				"required": ["condition", "contents"],
-				"properties": {
-					"condition": {
-						"type": "object",
-						"oneOf": [
-							{
-								"additionalProperties": false,
-								"required": ["hasAttr"],
-								"properties": {
-									"hasAttr": { "type": "string" }
-								}
-							},
-							{
-								"additionalProperties": false,
-								"required": ["parent"],
-								"properties": {
-									"parent": { "type": "string" },
-									"hasNotAttr": {
-										"type": "string",
-										"description": "Not support yet"
-									},
-									"_TODO_": { "type": "string" },
-									"_parent": { "type": "string" }
-								}
-							}
-						]
-					},
-					"contents": {
-						"oneOf": [
-							{
-								"$ref": "#/definitions/PermittedContentSpec"
-							},
-							{ "type": "boolean" }
-						]
-					}
-				}
-			}
-		},
-		"contents": {
-			"oneOf": [
-				{
-					"$ref": "#/definitions/PermittedContentSpec"
-				},
-				{ "type": "boolean" }
-			]
-		},
-		"ancestor": { "$ref": "#/definitions/Node" }
+		"__contentModel": {
+			"$ref": "#/definitions/ContentModel"
+		}
 	}
 }

package/schemas/element.schema.json

@@ -0,0 +1,11 @@
+{
+	"type": "object",
+	"additionalProperties": false,
+	"required": ["contentModel", "globalAttrs", "attributes", "aria"],
+	"properties": {
+		"contentModel": { "$ref": "./content-models.schema.json#/definitions/ContentModel" },
+		"globalAttrs": { "$ref": "./attributes.schema.json#/definitions/GlobalAttributes" },
+		"attributes": { "$ref": "./attributes.schema.json#/definitions/Attributes" },
+		"aria": { "$ref": "./aria.schema.json#/definitions/ARIA" }
+	}
+}

package/schemas/global-attributes.schema.json

@@ -65,6 +65,7 @@
 				"onabort",
 				"onauxclick",
 				"onbeforeinput",
+				"onbeforematch",
 				"onblur",
 				"oncancel",
 				"oncanplay",
@@ -154,7 +155,8 @@
 				"referrerpolicy",
 				"rel",
 				"target",
-				"type"
+				"type",
+				"fetchpriority"
 			]
 		},
 		"HTMLEmbededAndMediaContentAttrs": {
@@ -399,6 +401,7 @@
 				"onabort",
 				"onauxclick",
 				"onbeforeinput",
+				"onbeforematch",
 				"onblur",
 				"oncancel",
 				"oncanplay",
@@ -497,7 +500,8 @@
 				"referrerpolicy",
 				"rel",
 				"target",
-				"type"
+				"type",
+				"fetchpriority"
 			],
 			"propertyNames": { "$ref": "#/definitions/HTMLLinkAndFetchingAttrs" },
 			"patternProperties": { ".+": { "$ref": "./attributes.schema.json#/definitions/AttributeJSON" } }

package/src/dom-traverse/accname-computation.spec.ts

@@ -0,0 +1,69 @@
+import { createJSDOMElement as c } from '@markuplint/test-tools';
+
+import { getAccname } from './accname-computation';
+
+test('Get accessible name', () => {
+	expect(getAccname(c('<button>label</button>'))).toBe('label');
+	expect(getAccname(c('<div>text</div>'))).toBe('');
+	expect(getAccname(c('<div aria-label="label">text</div>'))).toBe('label');
+	expect(getAccname(c('<span aria-label="label">text</span>'))).toBe('label');
+	expect(getAccname(c('<img alt="alterative-text" />'))).toBe('alterative-text');
+	expect(getAccname(c('<img title="title" />'))).toBe('title');
+	expect(getAccname(c('<div><label for="a">label</label><input id="a" /></div>').children[1])).toBe('label');
+});
+
+test('Invisible element', () => {
+	expect(getAccname(c('<button>label</button>'))).toBe('label');
+	expect(getAccname(c('<button aria-disabled="true">label</button>'))).toBe('label');
+	expect(getAccname(c('<button aria-hidden="true">label</button>'))).toBe('');
+	expect(getAccname(c('<button hidden>label</button>'))).toBe('');
+	expect(getAccname(c('<button style="display: none">label</button>'))).toBe('');
+});
+
+/**
+ * @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 Expample 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])).toBe('hello');
+	expect(getAccname(complex.children[1])).toBe('');
+	expect(getAccname(complex.children[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 Expample 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])).toBe('Delete Documentation.pdf');
+	expect(getAccname(spans[1])).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 Expample 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)).toBe('Flash the screen 5 times');
+});
+
+test('with comment', () => {
+	expect(getAccname(c('<button>label</button>'))).toBe('label');
+	expect(getAccname(c('<button>label<!-- comment --></button>'))).toBe('label');
+});

package/src/dom-traverse/accname-computation.ts

@@ -0,0 +1,5 @@
+import { computeAccessibleName } from 'dom-accessibility-api';
+
+export function getAccname(el: Element) {
+	return computeAccessibleName(el);
+}

package/src/dom-traverse/get-attr-specs.ts

@@ -0,0 +1,8 @@
+import type { MLMLSpec } from '../types';
+import type { NamespaceURI } from '@markuplint/ml-ast';
+
+import { getAttrSpecs as _getAttrSpecs } from '../specs/get-attr-specs';
+
+export function getAttrSpecs(el: Element, schema: MLMLSpec) {
+	return _getAttrSpecs(el.localName, el.namespaceURI as NamespaceURI, schema);
+}