@markuplint/config-presets 3.0.0-alpha.4 → 3.0.0-alpha.6

package/README.md

@@ -45,8 +45,8 @@ No merge cells| |✅|✅|✅|✅|✅|✅|❌|❌|❌|❌|❌|
 [`<summary>` no contains interactive contents](https://github.com/whatwg/html/issues/2272#issuecomment-1242415594)|There is a case where an assistive technology can't access contents, or contents don't propagate a mouse event to `<summary>`.|✅|✅|✅|✅|✅|✅|❌|❌|❌|❌|❌|
 [No duplicate attr](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-duplicate-attribute)|The parser ignores all such duplicate occurrences of the attribute.|✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
 Use **character reference**| |✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
-No use depreacted attr|You should not use deprecated attributes from the viewpoint of compatibility.|✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
-No use depreacted element|You should not use deprecated elements from the viewpoint of compatibility.|✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
+No use deprecated attr|You should not use deprecated attributes from the viewpoint of compatibility.|✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
+No use deprecated element|You should not use deprecated elements from the viewpoint of compatibility.|✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
 [Require `doctype`](https://html.spec.whatwg.org/multipage/syntax.html#syntax-doctype)|It has the effect of avoiding quirks mode.|✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
 No use ineffective attr| |✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|
 Allow only **permitted contents**| |✅|✅|✅|✅|✅|❌|❌|✅|❌|❌|❌|

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@markuplint/config-presets",
-	"version": "3.0.0-alpha.4",
+	"version": "3.0.0-alpha.6",
 	"description": "markuplint config presets",
 	"repository": "git@github.com:markuplint/markuplint.git",
 	"author": "Yusuke Hirao <yusukehirao@me.com>",
@@ -17,5 +17,5 @@
 		"jsonc-parser": "^3.2.0",
 		"mustache": "^4.2.0"
 	},
-	"gitHead": "04fdbb677c6893de3d16613ddcd112de25dc55db"
+	"gitHead": "b185a06d4ea09a1bf32458f7be4abe510eb57b89"
 }

package/preset.recommended-react.json

@@ -1 +1 @@
-{"extends":["markuplint:code-style","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"no-hard-code-id":true}}
+{"extends":["markuplint:code-styles","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"no-hard-code-id":true}}

package/preset.recommended-static-html.json

@@ -1 +1 @@
-{"extends":["markuplint:code-style","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"end-tag":true}}
+{"extends":["markuplint:code-styles","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"end-tag":true}}

package/preset.recommended-svelte.json

@@ -1 +1 @@
-{"extends":["markuplint:code-style","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"no-hard-code-id":true}}
+{"extends":["markuplint:code-styles","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"no-hard-code-id":true}}

package/preset.recommended-vue.json

@@ -1 +1 @@
-{"extends":["markuplint:code-style","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"no-hard-code-id":true}}
+{"extends":["markuplint:code-styles","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"],"rules":{"no-hard-code-id":true}}

package/preset.recommended.json

@@ -1 +1 @@
-{"extends":["markuplint:code-style","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"]}
+{"extends":["markuplint:code-styles","markuplint:html-standard","markuplint:a11y","markuplint:performance","markuplint:security","markuplint:rdfa"]}

package/build.mjs

@@ -1,107 +0,0 @@
-import { readFile, rm, writeFile } from 'fs/promises';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import glob from 'glob';
-import { promisify } from 'util';
-import { stripComments, visit } from 'jsonc-parser';
-import mustache from 'mustache';
-
-const asyncGlob = promisify(glob);
-
-const dirname = path.dirname(fileURLToPath(import.meta.url));
-const srcDir = path.resolve(dirname, 'src');
-
-const currents = await asyncGlob('preset.*.json,!preset.___json');
-await Promise.all(currents.map(current => rm(current)));
-
-const files = await asyncGlob(path.resolve(srcDir, '*.json'));
-const md = await readFile(path.resolve(srcDir, 'README.md'), { encoding: 'utf-8' });
-
-const presets = [];
-const rules = {};
-const extended = {};
-
-for (const file of files) {
-	const filename = path.basename(file);
-	const code = await readFile(path.resolve(dirname, 'src', filename), { encoding: 'utf-8' });
-	const json = JSON.parse(stripComments(code));
-	const compressed = JSON.stringify(json);
-	await writeFile(path.resolve(dirname, filename), compressed, { encoding: 'utf-8' });
-
-	const name = filename.replace(/^preset\.|\.json/g, '');
-	presets.push(name);
-	extended[name] = (json['extends'] || []).map(name => name.replace('markuplint:', ''));
-
-	visit(
-		code,
-		{
-			onComment(offset, length) {
-				const comment = code.substring(offset, offset + length);
-				const line = comment.split('\n');
-				const [heading = '', desc = ''] = comment
-					.split(/\n\s*\*\s*\n/g)
-					.map(section => cleanComment(section))
-					.filter(s => !/^@see\s/.test(s));
-				const text = line.map(line => cleanComment(line)).filter(s => s);
-				const url = (text.find(t => /^@see\s/i.test(t)) || '').replace(/^@see\s/i, '');
-
-				if (!heading) {
-					return;
-				}
-
-				if (rules[heading]?.config) {
-					rules[heading].config.push(name);
-				} else {
-					rules[heading] = {
-						desc,
-						url,
-						config: [name],
-					};
-				}
-			},
-		},
-		{ disallowComments: false },
-	);
-}
-
-presets.sort((a, b) => {
-	if (a.includes('recommended')) {
-		return -1;
-	}
-	return a - b;
-});
-
-const renderMd = mustache.render(md, {
-	presets: () => {
-		const line = [];
-		line.push(`Ruleset|Description|${presets.map(p => `\`${p}\``).join('|')}|`);
-		line.push(`---|---|${'---|'.repeat(presets.length)}`);
-
-		Object.entries(rules).forEach(([name, context]) => {
-			const title = context.url ? `[${name}](${context.url})` : name;
-			const checks = presets.map(preset => {
-				const configs = [preset, ...extended[preset]];
-				const has = configs.some(config => context.config?.includes(config));
-				return has ? '✅' : '❌';
-			});
-			line.push(`${title}|${context.desc || ' '}|${checks.join('|')}|`);
-		});
-
-		return line.join('\n');
-	},
-});
-
-/**
- *
- * @param {string} text
- * @returns
- */
-function cleanComment(text) {
-	const t1 = text.trim();
-	const t2 = t1.replace(/^\/\*\*(?:[\n\s]*\*[\n\s]*)?|^\*\/|^\*|^\*[\s\n]*|[\s\n]*\*\/$/g, '');
-	const t3 = t2.replace(/\s*\n\s*(?:\*\s*)?/g, ' ');
-	const t4 = t3.trim();
-	return t4;
-}
-
-await writeFile('README.md', renderMd, { encoding: 'utf-8' });

package/preset.___test.json

@@ -1,3 +0,0 @@
-{
-	"___configs": "test"
-}

package/src/README.md

@@ -1,39 +0,0 @@
-# @markuplint/config-presets
-
-[![npm version](https://badge.fury.io/js/%40markuplint%2Fconfig-presets.svg)](https://www.npmjs.com/package/@markuplint/config-presets)
-[![Build Status](https://travis-ci.org/markuplint/markuplint.svg?branch=main)](https://travis-ci.org/markuplint/markuplint)
-[![Coverage Status](https://coveralls.io/repos/github/markuplint/markuplint/badge.svg?branch=main)](https://coveralls.io/github/markuplint/markuplint?branch=main)
-
-## Usage
-
-To the `extends` property of the configuration, specify like below:
-
-```json
-{
-  "extends": ["markuplint:recommended"]
-}
-```
-
-You can choose some presets appropriately for your preference.
-
-```json
-{
-  "extends": ["markuplint:html-standard", "markuplint:a11y"]
-}
-```
-
-## Presets
-
-{{{ presets }}}
-
-## Install
-
-`markuplint` package includes this package.
-
-If you are installing purposely, how below:
-
-```sh
-$ npm install @markuplint/config-presets
-
-$ yarn add @markuplint/config-presets
-```

package/src/preset.a11y.json

@@ -1,178 +0,0 @@
-{
-	"rules": {
-		"disallowed-element": [
-			/**
-			 * Disallow `<hgroup>`
-			 *
-			 * The hgroup element should not be used because no assistive technology supports it.
-			 *
-			 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hgroup
-			 */
-			"hgroup"
-		],
-
-		/**
-		 * Must not duplicate **ID**
-		 *
-		 * Be able to avoid problems in assistive technologies from the viewpoint of machine readability.
-		 *
-		 * @see https://www.w3.org/WAI/WCAG21/Techniques/html/H93.html
-		 */
-		"id-duplication": true,
-
-		"invalid-attr": {
-			"option": {
-				"attrs": {
-					/**
-					 * Disallow `autofocus` attr
-					 *
-					 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus#accessibility_considerations
-					 */
-					"autofocus": {
-						"disallowed": true
-					},
-
-					/**
-					 * Disallow `autofocus` attr
-					 *
-					 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey#accessibility_concerns
-					 */
-					"accesskey": {
-						"disallowed": true
-					},
-
-					/**
-					 * `tabindex` attr only `-1` or `0`
-					 *
-					 * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex#accessibility_concerns
-					 */
-					"tabindex": {
-						"enum": ["-1", "0"]
-					}
-				}
-			}
-		},
-
-		/**
-		 * `<label>` should have control
-		 *
-		 */
-		"label-has-control": true,
-
-		/**
-		 * Use **landmark**
-		 *
-		 * @see https://www.w3.org/TR/wai-aria-practices/examples/landmarks/
-		 */
-		"landmark-roles": true,
-
-		/**
-		 * No refer to no existent **ID**
-		 */
-		"no-refer-to-non-existent-id": true,
-
-		/**
-		 * Require **accessible name**
-		 */
-		"require-accessible-name": true,
-
-		/**
-		 * Require `<h1>`
-		 *
-		 */
-		"required-h1": true,
-
-		/**
-		 * Use `<ul>`
-		 *
-		 */
-		"use-list": true,
-
-		/**
-		 * Conform to **WAI-ARIA**
-		 *
-		 */
-		"wai-aria": true
-	},
-	"nodeRules": [
-		{
-			"selector": ":where(html)",
-			"rules": {
-				/**
-				 * Require `<html lang>`
-				 *
-				 */
-				"required-attr": ["lang"]
-			}
-		},
-		{
-			"selector": ":where(abbr)",
-			"rules": {
-				/**
-				 * Require `<abbr title>`
-				 */
-				"required-attr": ["title"]
-			}
-		},
-		{
-			"selector": ":where(video, audio)",
-			"rules": {
-				/**
-				 * Require `<track>`
-				 *
-				 */
-				"required-element": ["track"]
-			}
-		},
-		{
-			"selector": ":where(video[autoplay])",
-			"rules": {
-				/**
-				 * Require `<video muted>`
-				 *
-				 */
-				"required-attr": ["muted"]
-			}
-		},
-		{
-			/**
-			 * No merge cells
-			 *
-			 */
-			"selector": ":where(th, td)",
-			"rules": {
-				"invalid-attr": {
-					"option": {
-						"attrs": {
-							"colspan": {
-								"disallowed": true
-							},
-							"rowspan": {
-								"disallowed": true
-							}
-						}
-					}
-				}
-			}
-		},
-		{
-			"selector": ":where(summary)",
-			"rules": {
-				/**
-				 * `<summary>` no contains interactive contents
-				 *
-				 * There is a case where an assistive technology can't access contents, or contents don't propagate a mouse event to `<summary>`.
-				 *
-				 * > The link is not discoverable at all to JAWS when navigating with its virtual cursor.
-				 * > If navigating to the summary element via the Tab key,
-				 * > JAWS announces "example text, button" as the name and role of the element.
-				 * > If hitting Tab key again, JAWS again announces "example text,
-				 * > button" even though keyboard focus is on the link.
-				 *
-				 * @see https://github.com/whatwg/html/issues/2272#issuecomment-1242415594
-				 */
-				"disallowed-element": [":model(interactive)"]
-			}
-		}
-	]
-}

package/src/preset.code-styles.json

@@ -1,3 +0,0 @@
-{
-	"rules": {}
-}

package/src/preset.html-standard.json

@@ -1,116 +0,0 @@
-{
-	"rules": {
-		/**
-		 * No duplicate attr
-		 *
-		 * The parser ignores all such duplicate occurrences of the attribute.
-		 *
-		 * @see https://html.spec.whatwg.org/multipage/parsing.html#parse-error-duplicate-attribute
-		 */
-		"attr-duplication": true,
-
-		/**
-		 * Use **character reference**
-		 *
-		 */
-		"character-reference": true,
-
-		/**
-		 * No use depreacted attr
-		 *
-		 * You should not use deprecated attributes from the viewpoint of compatibility.
-		 */
-		"deprecated-attr": true,
-
-		/**
-		 * No use depreacted element
-		 *
-		 * You should not use deprecated elements from the viewpoint of compatibility.
-		 */
-		"deprecated-element": true,
-
-		/**
-		 * Require `doctype`
-		 *
-		 * It has the effect of avoiding quirks mode.
-		 *
-		 * @see https://html.spec.whatwg.org/multipage/syntax.html#syntax-doctype
-		 */
-		"doctype": true,
-
-		/**
-		 * Must not duplicate **ID**
-		 *
-		 */
-		"id-duplication": true,
-
-		/**
-		 * No use ineffective attr
-		 *
-		 */
-		"ineffective-attr": true,
-
-		/**
-		 * No refer to no existent **ID**
-		 */
-		"no-refer-to-non-existent-id": true,
-
-		/**
-		 * Allow only **permitted contents**
-		 *
-		 */
-		"permitted-contents": true,
-
-		/**
-		 * Specify required attr
-		 *
-		 */
-		"required-attr": true
-	},
-	"nodeRules": [
-		{
-			/**
-			 * Specify `charset=UTF-8`
-			 *
-			 * @see https://html.spec.whatwg.org/multipage/semantics.html#charset
-			 */
-			"selector": ":where(head)",
-			"rules": {
-				"required-element": ["meta[charset=\"UTF-8\" i]"]
-			}
-		},
-		{
-			/**
-			 * No use `<small>` as **subheadings**
-			 *
-			 * Should not use it in `<h1>`, `<h2>`, `<h3>`, `<h4>`, `<h5>`, and `<h6>`.
-			 *
-			 * @see https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-small-element
-			 */
-			"selector": "h1, h2, h3, h4, h5, h6",
-			"rules": {
-				"disallowed-element": {
-					"value": ["small"],
-					"reason": "The small element must not be used for subheadings. https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-small-element"
-				}
-			}
-		},
-		{
-			/**
-			 * No use `<caption>` within `<figure>`
-			 *
-			 * When `<table>` is the only content in `<figure>` other than `<figcaption>`, `<caption>` should be omitted in favor of `<figcaption>`.
-			 *
-			 * @see https://html.spec.whatwg.org/multipage/tables.html#the-caption-element
-			 */
-			"selector": ":where(figcaption ~ table, table:has(~ figcaption))",
-			"rules": {
-				"disallowed-element": {
-					"value": ["caption"],
-					"reason": "When a table element is the only content in a figure element other than the figcaption, the caption element should be omitted in favor of the figcaption. (https://html.spec.whatwg.org/multipage/tables.html#the-caption-element)"
-				},
-				"require-accessible-name": false
-			}
-		}
-	]
-}

package/src/preset.performance.json

@@ -1,70 +0,0 @@
-{
-	"nodeRules": [
-		{
-			/**
-			 * Require `charset=UTF-8`
-			 *
-			 * @see https://html.spec.whatwg.org/multipage/semantics.html#charset
-			 */
-			"selector": ":where(head)",
-			"rules": {
-				"required-element": ["meta[charset=\"UTF-8\" i]"]
-			}
-		},
-		{
-			/**
-			 * Require `defer` attr
-			 *
-			 * Should load and parse scripts lazily to avoid render-blocking.
-			 */
-			"selector": ":where(script[src]:not([type=module]))",
-			"rules": {
-				"required-attr": ["defer"]
-			}
-		},
-		{
-			/**
-			 * Require **aspect-ratio**
-			 *
-			 * Require `width` and `height` attr with `<img>` to avoid **Cumulative Layout Shift**
-			 */
-			"selector": ":where(img[src])",
-			"rules": {
-				"required-attr": ["width", "height"]
-			}
-		},
-		{
-			/**
-			 * Require async decoding image
-			 *
-			 * Require `decoding=async` with `<img>` to avoid render-blocking.
-			 */
-			"selector": ":where(img[src][width][height])",
-			"rules": {
-				"required-attr": [
-					{
-						"name": "decoding",
-						"value": "async"
-					}
-				]
-			}
-		},
-		{
-			/**
-			 * Require loading `<iframe>` lazily
-			 *
-			 * Require `loading=lazy` with `<iframe>` to avoid render-blocking that causes loading if its element is out of the viewport.
-			 */
-			"selector": ":where(iframe)",
-			"rules": {
-				"required-attr": [
-					"title",
-					{
-						"name": "loading",
-						"value": "lazy"
-					}
-				]
-			}
-		}
-	]
-}

package/src/preset.rdfa.json

@@ -1,27 +0,0 @@
-{
-	"nodeRules": [
-		{
-			/**
-			 * Allow `property` attr with `<meta>`
-			 *
-			 * Be able to use **Open-Graph** etc.
-			 */
-			"selector": ":where(meta[property])",
-			"rules": {
-				"invalid-attr": {
-					"option": {
-						"attrs": {
-							"property": {
-								"type": "NoEmptyAny"
-							},
-							"content": {
-								"type": "NoEmptyAny"
-							}
-						}
-					}
-				},
-				"required-attr": false
-			}
-		}
-	]
-}

package/src/preset.recommended-react.json

@@ -1,19 +0,0 @@
-{
-	"extends": [
-		"markuplint:code-style",
-		"markuplint:html-standard",
-		"markuplint:a11y",
-		"markuplint:performance",
-		"markuplint:security",
-		"markuplint:rdfa"
-	],
-	"rules": {
-		/**
-		 * No hard coding **ID**
-		 *
-		 * The component that hard-coded ID cannot mount to an app duplicated because the IDs must be unique in a document.
-		 * Recommend to specify dynamic IDs to avoid doing that.
-		 */
-		"no-hard-code-id": true
-	}
-}

package/src/preset.recommended-static-html.json

@@ -1,19 +0,0 @@
-{
-	"extends": [
-		"markuplint:code-style",
-		"markuplint:html-standard",
-		"markuplint:a11y",
-		"markuplint:performance",
-		"markuplint:security",
-		"markuplint:rdfa"
-	],
-	"rules": {
-		/**
-		 * No omit **end-tag**
-		 *
-		 * Recommend to write an end-tag always because it is too difficult
-		 * for a human decide an element is end-tag omittable.
-		 */
-		"end-tag": true
-	}
-}

package/src/preset.recommended-svelte.json

@@ -1,19 +0,0 @@
-{
-	"extends": [
-		"markuplint:code-style",
-		"markuplint:html-standard",
-		"markuplint:a11y",
-		"markuplint:performance",
-		"markuplint:security",
-		"markuplint:rdfa"
-	],
-	"rules": {
-		/**
-		 * No hard coding **ID**
-		 *
-		 * The component that hard-coded ID cannot mount to an app duplicated because the IDs must be unique in a document.
-		 * Recommend to specify dynamic IDs to avoid doing that.
-		 */
-		"no-hard-code-id": true
-	}
-}

package/src/preset.recommended-vue.json

@@ -1,19 +0,0 @@
-{
-	"extends": [
-		"markuplint:code-style",
-		"markuplint:html-standard",
-		"markuplint:a11y",
-		"markuplint:performance",
-		"markuplint:security",
-		"markuplint:rdfa"
-	],
-	"rules": {
-		/**
-		 * No hard coding **ID**
-		 *
-		 * The component that hard-coded ID cannot mount to an app duplicated because the IDs must be unique in a document.
-		 * Recommend to specify dynamic IDs to avoid doing that.
-		 */
-		"no-hard-code-id": true
-	}
-}

package/src/preset.recommended.json

@@ -1,10 +0,0 @@
-{
-	"extends": [
-		"markuplint:code-style",
-		"markuplint:html-standard",
-		"markuplint:a11y",
-		"markuplint:performance",
-		"markuplint:security",
-		"markuplint:rdfa"
-	]
-}

package/src/preset.security.json

@@ -1,23 +0,0 @@
-{
-	"nodeRules": [
-		{
-			/**
-			 * Require `noreferrer` with `target=_blank`
-			 *
-			 * Require `rel=noreferrer` with an element that has `target=_blank` to prevent leaking referrer information and to block operating referrer documents.
-			 */
-			"selector": ":where(a[target=_blank], area[target=_blank])",
-			"rules": {
-				"required-attr": {
-					"value": [
-						{
-							"name": "rel",
-							"value": "/(?<![^\\s]+)noreferrer(?![^\\s]+)/"
-						}
-					],
-					"reason": "The \"rel\" attribute should be required with \"noreferrer\" if the \"a\" element has the \"target=_blank\""
-				}
-			}
-		}
-	]
-}