@markuplint/rules 2.0.0-rc.6 → 2.0.0

package/README.md

@@ -8,86 +8,54 @@
 
 ### Conformance checking
 
-| Avaiable | Docs | Docs(ja) | Rule                                              | Fixable |
-| -------- | ---- | -------- | ------------------------------------------------- | ------- |
-| ✅       | ✅   | ✅       | [attr-duplication](./src/attr-duplication/)       | 🚧      |
-| ✅       | ✅   | ✅       | [character-reference](./src/character-reference/) | 🚧      |
-| 🚧       | 🚧   | 🚧       | [comment](./src/comment/)                         |         |
-| ✅       | ✅   | ✅       | [deprecated-attr](./src/deprecated-attr/)         |         |
-| ✅       | ✅   | ✅       | [deprecated-element](./src/deprecated-element/)   |         |
-| ✅       | ✅   | ✅       | [doctype](./src/doctype/)                         | 🚧      |
-| ✅       | ✅   | ✅       | [id-duplication](./src/id-duplication/)           |         |
-| ✅       | ✅   | ✅       | [permitted-contents](./src/permitted-contents/)   |         |
-| ✅       | ✅   | ✅       | [required-attr](./src/required-attr/)             |         |
-| ✅       | ✅   | ✅       | [invalid-attr](./src/invalid-attr/)               |         |
+- [`attr-duplication`](./src/attr-duplication)
+- [`character-reference`](./src/character-reference)
+- [`deprecated-attr`](./src/deprecated-attr)
+- [`deprecated-element`](./src/deprecated-element)
+- [`disallowed-element`](./src/disallowed-element)
+- [`doctype`](./src/doctype)
+- [`id-duplication`](./src/id-duplication)
+- [`ineffective-attr`](./src/ineffective-attr)
+- [`invalid-attr`](./src/invalid-attr)
+- [`permitted-contents`](./src/permitted-contents)
+- [`required-attr`](./src/required-attr)
+- [`required-element`](./src/required-element)
 
 ### Accessibility
 
-| Avaiable | Docs | Docs(ja) | Rule                                                                  | Fixable |
-| -------- | ---- | -------- | --------------------------------------------------------------------- | ------- |
-| 🚧       | 🚧   | 🚧       | [accessible-text](./src/accessible-text/)                             |         |
-| 🚧       | 🚧   | 🚧       | [attr-role](./src/permitted-role/)                                    |         |
-| 🚧       | 🚧   | 🚧       | [heading-in-sectioning-content](./src/heading-in-sectioning-content/) |         |
-| 🚧       | 🚧   | 🚧       | [heading-in-sectioning-root](./src/heading-in-sectioning-root/)       |         |
-| 🚧       | 🚧   | 🚧       | [heading-levels-skipping](./src/heading-levels-skipping/)             |         |
-| 🚧       | 🚧   | 🚧       | [labeling-controls](./src/labeling-controls/)                         |         |
-| ✅       | ✅   | ✅       | [landmark-roles](./src/landmark-roles/)                               |         |
-| ✅       | ✅   | ✅       | [required-h1](./src/required-h1/)                                     |         |
+- [`landmark-roles`](./src/landmark-roles)
+- [`no-refer-to-non-existent-id`](./src/no-refer-to-non-existent-id)
+- [`required-h1`](./src/required-h1)
+- [`wai-aria`](./src/wai-aria)
 
-### Usability
+### Naming Convention
 
-| Avaiable | Docs | Docs(ja) | Rule                                  | Fixable |
-| -------- | ---- | -------- | ------------------------------------- | ------- |
-| 🚧       | 🚧   | 🚧       | [external-link](./src/external-link/) | 🚧      |
+- [`class-naming`](./src/class-naming)
 
-### Structure Design and Naming Convention
+### Maintenability
 
-| Avaiable | Docs | Docs(ja) | Rule                                                  | Fixable |
-| -------- | ---- | -------- | ----------------------------------------------------- | ------- |
-| ✅       | ✅   | ✅       | [class-naming](./src/class-naming/)                   |         |
-| 🚧       | 🚧   | 🚧       | [custom-element-naming](./src/custom-element-naming/) |         |
-| 🚧       | 🚧   | 🚧       | [data-attr-naming](./src/data-attr-naming/)           |         |
-| 🚧       | 🚧   | 🚧       | [required-element](./src/required-element/)           |         |
+- [`no-hard-code-id`](./src/no-hard-code-id)
+- [`no-use-event-handler-attr`](./src/no-use-event-handler-attr)
 
 ### Style
 
-| Avaiable | Docs | Docs(ja) | Rule                                                        | Fixable |
-| -------- | ---- | -------- | ----------------------------------------------------------- | ------- |
-| ✅       | ✅   | ✅       | [attr-equal-space-after](./src/attr-equal-space-after/)     | ✅      |
-| ✅       | ✅   | ✅       | [attr-equal-space-before](./src/attr-equal-space-before/)   | ✅      |
-| ✅       | ✅   | ✅       | [attr-spacing](./src/attr-spacing/)                         | ✅      |
-| ✅       | ✅   | ✅       | [attr-value-quotes](./src/attr-value-quotes/)               | ✅      |
-| ✅       | ✅   | ✅       | [case-sensitive-attr-name](./src/case-sensitive-attr-name/) | ✅      |
-| ✅       | ✅   | ✅       | [case-sensitive-tag-name](./src/case-sensitive-tag-name/)   | ✅      |
-| 🚧       | 🚧   | 🚧       | [comment-spasing](./src/comment-spasing/)                   | 🚧      |
-| 🚧       | 🚧   | 🚧       | [event-attr](./src/event-attr/)                             |         |
-| ✅       | ✅   | ✅       | [indentation](./src/indentation/)                           | ✅      |
-| 🚧       | 🚧   | 🚧       | [indentation-attr](./src/indentation-attr/)                 | 🚧      |
-| 🚧       | 🚧   | 🚧       | [path](./src/path/)                                         |         |
-| 🚧       | 🚧   | ✅       | [self-closing-tag](./src/self-closing-tag/)                 | 🚧      |
-| 🚧       | 🚧   | 🚧       | [tag-omission](./src/tag-omission/)                         | 🚧      |
+- [`attr-equal-space-after`](./src/attr-equal-space-after)
+- [`attr-equal-space-before`](./src/attr-equal-space-before)
+- [`attr-spacing`](./src/attr-spacing)
+- [`attr-value-quotes`](./src/attr-value-quotes)
+- [`case-sensitive-attr-name`](./src/case-sensitive-attr-name)
+- [`case-sensitive-tag-name`](./src/case-sensitive-tag-name)
+- [`end-tag`](./src/end-tag)
+- [`indentation`](./src/indentation)
+- [`no-boolean-attr-value`](./src/no-boolean-attr-value)
+- [`no-default-value`](./src/no-default-value)
 
 ## Install
 
-This package is **default** used that dependenced by [`markuplint`](https://www.npmjs.com/package/markuplint/).
-
-Prerequisites: [Node.js](https://nodejs.org) (Version 12.4.0 or later)
+Generally, you **don't have to install** this package because markuplint dependents it defaultly.
 
 ```sh
-$ npm install @markuplint/rules
-
-$ yarn add @markuplint/rules
-```
-
-## Contributing
+$ npm install -D @markuplint/rules
 
+$ yarn add -D @markuplint/rules
 ```
-$ git clone git@github.com:markuplint/markuplint.git -b main
-$ yarn
-$ yarn build
-$ yarn test
-```
-
----
-
-Copyright © 2021 markuplint. Under the MIT License.

package/lib/attr-check.d.ts

@@ -1,14 +1,14 @@
 import type { Translator } from '@markuplint/i18n';
 import type { Attribute as AttrSpec, AttributeType } from '@markuplint/ml-spec';
 declare type Invalid = {
-    invalidType: 'non-existent' | 'invalid-value';
-    message: string;
-    loc?: Loc;
+	invalidType: 'non-existent' | 'invalid-value';
+	message: string;
+	loc?: Loc;
 };
 declare type Loc = {
-    raw: string;
-    line: number;
-    col: number;
+	raw: string;
+	line: number;
+	col: number;
 };
 /**
  * Use in rules `invalid-attr` and `wai-aria`
@@ -18,6 +18,17 @@ declare type Loc = {
  * @param isCustomRule
  * @param spec
  */
-export declare function attrCheck(t: Translator, name: string, value: string, isCustomRule: boolean, spec?: AttrSpec): Invalid | false;
-export declare function valueCheck(t: Translator, name: string, value: string, type: AttributeType): string | [string, Loc] | false;
+export declare function attrCheck(
+	t: Translator,
+	name: string,
+	value: string,
+	isCustomRule: boolean,
+	spec?: AttrSpec,
+): Invalid | false;
+export declare function valueCheck(
+	t: Translator,
+	name: string,
+	value: string,
+	type: AttributeType,
+): string | [string, Loc] | false;
 export {};

package/lib/attr-duplication/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<import('@markuplint/ml-core').RuleConfigValue, null>;
 export default _default;

package/lib/attr-equal-space-after/index.d.ts

@@ -1,3 +1,3 @@
 declare type Value = 'always' | 'never' | 'always-single-line' | 'never-single-line';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value, null>;
 export default _default;

package/lib/attr-equal-space-before/index.d.ts

@@ -1,3 +1,3 @@
 declare type Value = 'always' | 'never' | 'always-single-line' | 'never-single-line';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value, null>;
 export default _default;

package/lib/attr-spacing/index.d.ts

@@ -1,6 +1,6 @@
 export interface AttrSpasingOptions {
-    lineBreak?: 'either' | 'always' | 'never';
-    width?: number | false;
+	lineBreak?: 'either' | 'always' | 'never';
+	width?: number | false;
 }
-declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, AttrSpasingOptions>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<boolean, AttrSpasingOptions>;
 export default _default;

package/lib/attr-value-quotes/index.d.ts

@@ -1,7 +1,7 @@
 export declare type Type = 'double' | 'single';
 export declare type Quote = '"' | "'";
 export declare type QuoteMap = {
-    [P in Type]: Quote;
+	[P in Type]: Quote;
 };
-declare const _default: import("@markuplint/ml-core").RuleSeed<Type, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Type, null>;
 export default _default;

package/lib/case-sensitive-attr-name/index.d.ts

@@ -3,5 +3,5 @@ export declare type Value = 'lower' | 'upper';
  * @deprecated
  */
 export declare type Value_v1 = 'no-upper' | 'no-lower';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value | Value_v1, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value | Value_v1, null>;
 export default _default;

package/lib/case-sensitive-tag-name/index.d.ts

@@ -1,3 +1,3 @@
 export declare type Value = 'lower' | 'upper';
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value, null>;
 export default _default;

package/lib/character-reference/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<import('@markuplint/ml-core').RuleConfigValue, null>;
 export default _default;

package/lib/class-naming/index.d.ts

@@ -1,3 +1,3 @@
 export declare type Value = string | string[] | null;
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value, null>;
 export default _default;

package/lib/create-message.d.ts

@@ -1,5 +1,15 @@
 import type { Translator } from '@markuplint/i18n';
 import type { AttributeType } from '@markuplint/ml-spec';
 import type { UnmatchedResult } from '@markuplint/types';
-export declare function createMessageValueExpected(t: Translator, baseTarget: string, type: AttributeType, matches: UnmatchedResult): string;
-export declare function __createMessageValueExpected(t: Translator, baseTarget: string, expected: string | null, matches: Pick<UnmatchedResult, 'partName' | 'reason' | 'raw' | 'candicate' | 'ref' | 'extra'>): string;
+export declare function createMessageValueExpected(
+	t: Translator,
+	baseTarget: string,
+	type: AttributeType,
+	matches: UnmatchedResult,
+): string;
+export declare function __createMessageValueExpected(
+	t: Translator,
+	baseTarget: string,
+	expected: string | null,
+	matches: Pick<UnmatchedResult, 'partName' | 'reason' | 'raw' | 'candicate' | 'ref' | 'extra'>,
+): string;

package/lib/deprecated-attr/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<import('@markuplint/ml-core').RuleConfigValue, null>;
 export default _default;

package/lib/deprecated-element/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<import('@markuplint/ml-core').RuleConfigValue, null>;
 export default _default;

package/lib/disallowed-element/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<string[], null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<string[], null>;
 export default _default;

package/lib/doctype/index.d.ts

@@ -1,5 +1,5 @@
 declare type Option = {
-    denyObsolateType: boolean;
+	denyObsolateType: boolean;
 };
-declare const _default: import("@markuplint/ml-core").RuleSeed<"always", Option>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<'always', Option>;
 export default _default;

package/lib/end-tag/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<boolean, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<boolean, null>;
 export default _default;

package/lib/helpers.d.ts

@@ -2,7 +2,10 @@ import type { Log } from './debug';
 import type { Translator } from '@markuplint/i18n';
 import type { Element, RuleConfigValue } from '@markuplint/ml-core';
 import type { ARIRRoleAttribute, Attribute, MLMLSpec, PermittedRoles } from '@markuplint/ml-spec';
-export declare function attrMatches<T extends RuleConfigValue, R>(node: Element<T, R>, condition: Attribute['condition']): boolean;
+export declare function attrMatches<T extends RuleConfigValue, R>(
+	node: Element<T, R>,
+	condition: Attribute['condition'],
+): boolean;
 export declare function match(needle: string, pattern: string): boolean;
 /**
  * PotentialCustomElementName
@@ -20,26 +23,44 @@ export declare function match(needle: string, pattern: string): boolean;
  * Originally, it is not possible to define a name including ASCII upper alphas in the custom element, but it is not treated as illegal by the HTML parser.
  */
 export declare const rePCENChar: string;
-export declare function htmlSpec(specs: Readonly<MLMLSpec>, nameWithNS: string): import("@markuplint/ml-spec").ElementSpec | null;
-export declare function isValidAttr(t: Translator, name: string, value: string, isDynamicValue: boolean, node: Element<any, any>, attrSpecs: Attribute[], log?: Log): false | {
-    invalidType: "non-existent" | "invalid-value";
-    message: string;
-    loc?: {
-        raw: string;
-        line: number;
-        col: number;
-    } | undefined;
-};
+export declare function htmlSpec(
+	specs: Readonly<MLMLSpec>,
+	nameWithNS: string,
+): import('@markuplint/ml-spec').ElementSpec | null;
+export declare function isValidAttr(
+	t: Translator,
+	name: string,
+	value: string,
+	isDynamicValue: boolean,
+	node: Element<any, any>,
+	attrSpecs: Attribute[],
+	log?: Log,
+):
+	| false
+	| {
+			invalidType: 'non-existent' | 'invalid-value';
+			message: string;
+			loc?:
+				| {
+						raw: string;
+						line: number;
+						col: number;
+				  }
+				| undefined;
+	  };
 export declare function toNormalizedValue(value: string, spec: Attribute): string;
 export declare function ariaSpec(specs: Readonly<MLMLSpec>): {
-    roles: ARIRRoleAttribute[];
-    ariaAttrs: import("@markuplint/ml-spec").ARIAAttribute[];
+	roles: ARIRRoleAttribute[];
+	ariaAttrs: import('@markuplint/ml-spec').ARIAAttribute[];
 };
-export declare function getRoleSpec(specs: Readonly<MLMLSpec>, roleName: string): {
-    name: string;
-    isAbstract: boolean;
-    statesAndProps: import("@markuplint/ml-spec").ARIARoleOwnedPropOrState[];
-    superClassRoles: ARIRRoleAttribute[];
+export declare function getRoleSpec(
+	specs: Readonly<MLMLSpec>,
+	roleName: string,
+): {
+	name: string;
+	isAbstract: boolean;
+	statesAndProps: import('@markuplint/ml-spec').ARIARoleOwnedPropOrState[];
+	superClassRoles: ARIRRoleAttribute[];
 } | null;
 /**
  * Getting permitted ARIA roles.
@@ -50,9 +71,12 @@ export declare function getRoleSpec(specs: Readonly<MLMLSpec>, roleName: string)
  */
 export declare function getPermittedRoles(specs: Readonly<MLMLSpec>, el: Element<any, any>): PermittedRoles;
 export declare function getImplicitRole(specs: Readonly<MLMLSpec>, el: Element<any, any>): string | false;
-export declare function getComputedRole(specs: Readonly<MLMLSpec>, el: Element<any, any>): {
-    name: string;
-    isImplicit: boolean;
+export declare function getComputedRole(
+	specs: Readonly<MLMLSpec>,
+	el: Element<any, any>,
+): {
+	name: string;
+	isImplicit: boolean;
 } | null;
 /**
  *
@@ -63,23 +87,32 @@ export declare function getComputedRole(specs: Readonly<MLMLSpec>, el: Element<a
  * @param tokenEnum
  */
 export declare function checkAriaValue(type: string, value: string, tokenEnum: string[]): boolean;
-export declare function checkAria(specs: Readonly<MLMLSpec>, attrName: string, currentValue: string, role?: string): {
-    currentValue: string;
-    isValid: boolean;
-} | {
-    currentValue: string;
-    isValid: boolean;
-    name: string;
-    type: "property" | "state";
-    deprecated?: true | undefined;
-    isGlobal?: true | undefined;
-    value: import("@markuplint/ml-spec").ARIAAttributeValue;
-    conditionalValue?: {
-        role: string[];
-        value: import("@markuplint/ml-spec").ARIAAttributeValue;
-    }[] | undefined;
-    enum: string[];
-    defaultValue?: string | undefined;
-    equivalentHtmlAttrs?: import("@markuplint/ml-spec").EquivalentHtmlAttr[] | undefined;
-    valueDescriptions?: Record<string, string> | undefined;
-};
+export declare function checkAria(
+	specs: Readonly<MLMLSpec>,
+	attrName: string,
+	currentValue: string,
+	role?: string,
+):
+	| {
+			currentValue: string;
+			isValid: boolean;
+	  }
+	| {
+			currentValue: string;
+			isValid: boolean;
+			name: string;
+			type: 'property' | 'state';
+			deprecated?: true | undefined;
+			isGlobal?: true | undefined;
+			value: import('@markuplint/ml-spec').ARIAAttributeValue;
+			conditionalValue?:
+				| {
+						role: string[];
+						value: import('@markuplint/ml-spec').ARIAAttributeValue;
+				  }[]
+				| undefined;
+			enum: string[];
+			defaultValue?: string | undefined;
+			equivalentHtmlAttrs?: import('@markuplint/ml-spec').EquivalentHtmlAttr[] | undefined;
+			valueDescriptions?: Record<string, string> | undefined;
+	  };

package/lib/id-duplication/index.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("@markuplint/ml-core").RuleSeed<import("@markuplint/ml-core").RuleConfigValue, null>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<import('@markuplint/ml-core').RuleConfigValue, null>;
 export default _default;

package/lib/indentation/index.d.ts

@@ -1,7 +1,7 @@
 export declare type Value = 'tab' | number;
 export interface IndentationOptions {
-    alignment?: boolean;
-    'indent-nested-nodes'?: boolean | 'always' | 'never';
+	alignment?: boolean;
+	'indent-nested-nodes'?: boolean | 'always' | 'never';
 }
-declare const _default: import("@markuplint/ml-core").RuleSeed<Value, IndentationOptions>;
+declare const _default: import('@markuplint/ml-core').RuleSeed<Value, IndentationOptions>;
 export default _default;