@markuplint/rules 2.0.0-dev.2021117.3 → 2.0.0-dev.20211213.2

package/lib/attr-check.d.ts

@@ -1,8 +1,14 @@
 import type { Translator } from '@markuplint/i18n';
-import type { Attribute as AttrSpec } from '@markuplint/ml-spec';
+import type { Attribute as AttrSpec, AttributeType } from '@markuplint/ml-spec';
 declare type Invalid = {
     invalidType: 'non-existent' | 'invalid-value';
     message: string;
+    loc?: Loc;
+};
+declare type Loc = {
+    raw: string;
+    line: number;
+    col: number;
 };
 /**
  * Use in rules `invalid-attr` and `wai-aria`
@@ -13,4 +19,5 @@ declare type Invalid = {
  * @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 {};

package/lib/attr-check.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attrCheck = void 0;
-const primitive_check_1 = require("./primitive-check");
+exports.valueCheck = exports.attrCheck = void 0;
+const types_1 = require("@markuplint/types");
+const create_message_1 = require("./create-message");
+const debug_1 = require("./debug");
 /**
  * Use in rules `invalid-attr` and `wai-aria`
  *
@@ -23,476 +25,70 @@ function attrCheck(t, name, value, isCustomRule, spec) {
     }
     // Existance
     if (!spec) {
+        (0, debug_1.log)('The "%s" attribute DOES\'NT EXIST in the spec', name);
         return {
             invalidType: 'non-existent',
             message: t('{0} is {1:c}', t('the "{0}" {1}', name, 'attribute'), 'disallowed'),
         };
     }
-    const invalid = valueCheck(t, name, value, spec);
-    if (invalid) {
+    const nameCaseSensitive = /[A-Z]/.test(spec.name);
+    if (nameCaseSensitive && name !== spec.name) {
+        (0, debug_1.log)('The "%s" attribute name is unmatched in case-sensitive', name);
         return {
-            invalidType: 'invalid-value',
-            message: invalid,
+            invalidType: 'non-existent',
+            message: t('{0} is {1:c}', t('the "{0}" {1}', name, 'attribute'), 'disallowed') +
+                t('. ') +
+                t('Did you mean "{0*}"?', spec.name),
         };
     }
-    return false;
-}
-exports.attrCheck = attrCheck;
-function valueCheck(t, name, value, spec) {
-    // Valid because any string value is acceptable
-    if (typeof spec.type !== 'string' && 'enum' in spec.type) {
-        // has "enum"
-        return includesEnum(t, name, value, spec.type.enum);
-    }
-    const t_theNameAttribute = t('the "{0}" {1}', name, 'attribute');
-    if (spec.type === 'NonEmptyString' && value === '') {
-        return t('{0} must not be {1}', t('{0} of {1}', t('the {0}', 'value'), t_theNameAttribute), 'empty string');
-    }
-    if (spec.type === 'Boolean') {
-        // Valid because an attribute is exist
-        return false;
-    }
-    if (spec.type === 'Function') {
-        // TODO: To eval function-body string
-        return false;
-    }
-    if (spec.type === 'Date') {
-        // TODO: https://html.spec.whatwg.org/multipage/text-level-semantics.html#datetime-value
-        return false;
-    }
-    if (spec.type === 'Int') {
-        if ((0, primitive_check_1.intCheck)(value)) {
-            return false;
-        }
-        return t('{0} expects {1}', t_theNameAttribute, 'integer');
-    }
-    if (spec.type === 'Uint') {
-        if ((0, primitive_check_1.uintCheck)(value)) {
-            return false;
-        }
-        return t('{0} expects {1}', t_theNameAttribute, 'non-negative integer');
-    }
-    if (spec.type === 'Float') {
-        if ((0, primitive_check_1.floatCheck)(value)) {
-            return false;
-        }
-        return t('{0} expects {1}', t_theNameAttribute, 'floating-point number');
-    }
-    if (spec.type === 'NonZeroUint') {
-        if ((0, primitive_check_1.nonZeroUintCheck)(value)) {
-            return false;
-        }
-        return t('{0} expects {1}', t_theNameAttribute, t('{0} greater than {1}', 'floating-point number', 'zero'));
-    }
-    if (spec.type === 'ZeroToOne') {
-        if ((0, primitive_check_1.range)(value, 0, 1)) {
-            return false;
-        }
-        return t('{0} expects {1:c}', t_theNameAttribute, t('in the range between {0} and {1}', 'zero', 'one'));
-    }
-    if (spec.type === 'AcceptList') {
-        // TODO: https://html.spec.whatwg.org/multipage/input.html#attr-input-accept
-        return false;
-    }
-    if (spec.type === 'AutoComplete') {
-        // TODO: https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens
-        return false;
-    }
-    if (spec.type === 'BCP47') {
-        // TODO: https://tools.ietf.org/html/bcp47
-        return false;
-    }
-    if (spec.type === 'Color') {
-        // TODO: https://drafts.csswg.org/css-color/#typedef-color
-        return false;
-    }
-    if (spec.type === 'ColSpan') {
-        /**
-         * > value must be a valid non-negative integer greater than zero and less than or equal to 1000.
-         *
-         * @see https://html.spec.whatwg.org/multipage/tables.html#attr-tdth-colspan
-         */
-        if ((0, primitive_check_1.intCheck)(value) && (0, primitive_check_1.range)(value, 0, 1000)) {
-            return false;
+    const types = Array.isArray(spec.type) ? spec.type : [spec.type];
+    const invalidList = types.map(type => {
+        if (!type) {
+            (0, debug_1.log)('attrCheck: %o', arguments);
+            throw new Error('type is empty in spec');
         }
-        return t('{0} expects {1:c}', t_theNameAttribute, t('{0:c} and {1:c}', t('{0} greater than {1}', 'non-negative integer', 'zero'), t('less than or equal to {0}', 1000)));
-    }
-    if (spec.type === 'Coords') {
-        // TODO: https://html.spec.whatwg.org/multipage/image-maps.html#attr-area-coords
-        return false;
-    }
-    if (spec.type === 'Crossorigin') {
-        // TODO: https://html.spec.whatwg.org/multipage/urls-and-fetching.html#cors-settings-attributes
-        return false;
-    }
-    if (spec.type === 'DateTime') {
-        // TODO: https://html.spec.whatwg.org/multipage/text-level-semantics.html#datetime-value
-        return false;
-    }
-    if (spec.type === 'Destination') {
-        // TODO: https://html.spec.whatwg.org/multipage/semantics.html#attr-link-as
-        return false;
-    }
-    if (spec.type === 'DOMID') {
-        // TODO: Searching ID in Document
-        return false;
-    }
-    if (spec.type === 'DOMIDList') {
-        // TODO: Searching ID in Document
-        return false;
-    }
-    if (spec.type === 'IRI') {
-        // TODO: https://developer.mozilla.org/ja/docs/Web/SVG/Content_type#iri
-        return false;
-    }
-    if (spec.type === 'ItemType') {
-        // TODO: https://html.spec.whatwg.org/multipage/microdata.html#attr-itemtype
-        return false;
-    }
-    if (spec.type === 'LinkSizes') {
-        // TODO: https://html.spec.whatwg.org/multipage/semantics.html#attr-link-sizes
-        return false;
-    }
-    if (spec.type === 'LinkType') {
-        // TODO: https://html.spec.whatwg.org/multipage/links.html#linkTypes
-        return false;
-    }
-    if (spec.type === 'LinkTypeList') {
-        // TODO: https://html.spec.whatwg.org/multipage/links.html#linkTypes
-        return false;
-    }
-    if (spec.type === 'MediaQuery') {
-        // TODO: https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-media-query-list
-        return false;
-    }
-    if (spec.type === 'MediaQueryList') {
-        // TODO: https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-media-query-list
-        return false;
-    }
-    if (spec.type === 'MIMEType') {
-        // TODO: https://mimesniff.spec.whatwg.org/#valid-mime-type
-        return false;
-    }
-    if (spec.type === 'ReferrerPolicy') {
-        /**
-         * @see https://html.spec.whatwg.org/multipage/urls-and-fetching.html#referrer-policy-attributes
-         */
-        return includesEnum(t, name, value, [
-            '',
-            'no-referrer',
-            'no-referrer-when-downgrade',
-            'same-origin',
-            'origin',
-            'strict-origin',
-            'origin-when-cross-origin',
-            'strict-origin-when-cross-origin',
-            'unsafe-url',
-        ]);
-    }
-    if (spec.type === 'RowSpan') {
-        /**
-         * > value must be a valid non-negative integer less than or equal to 65534.
-         *
-         * @see https://html.spec.whatwg.org/multipage/tables.html#attr-tdth-rowspan
-         */
-        if ((0, primitive_check_1.intCheck)(value) && (0, primitive_check_1.range)(value, 0, 65534)) {
-            return false;
-        }
-        return t('{0} expects {1:c}', t_theNameAttribute, t('{0:c} and {1:c}', t('{0} greater than {1}', 'non-negative integer', 'zero'), t('less than or equal to {0}', 65534)));
-    }
-    if (spec.type === 'SourceSizeList') {
-        // TODO: https://html.spec.whatwg.org/multipage/images.html#sizes-attributes
-        return false;
-    }
-    if (spec.type === 'SrcSet') {
-        // TODO: https://html.spec.whatwg.org/multipage/images.html#srcset-attribute
-        return false;
-    }
-    if (spec.type === 'TabIndex') {
-        /**
-         * > ## omitted (or non-integer values)
-         * >
-         * > The user agent will decide whether the element is focusable, and if it is, whether it is sequentially focusable or click focusable (or both).
-         * >
-         * > ## −1 (or other negative integer values)
-         * >
-         * > Causes the element to be focusable, and indicates that the author would prefer the element to be click focusable but not sequentially focusable. The user agent might ignore this preference for click and sequential focusability, e.g., for specific element types according to platform conventions, or for keyboard-only users.
-         * >
-         * > ## 0
-         * >
-         * > Causes the element to be focusable, and indicates that the author would prefer the element to be both click focusable and sequentially focusable. The user agent might ignore this preference for click and sequential focusabiity.
-         * >
-         * > ## positive integer values
-         * >
-         * > Behaves the same as 0, but in addition creates a relative ordering within a tabindex-ordered focus navigation scope, so that elements with higher tabindex attribute value come later.
-         *
-         * @see https://html.spec.whatwg.org/multipage/interaction.html#attr-tabindex
-         */
-        if ((0, primitive_check_1.intCheck)(value)) {
-            const i = parseInt(value);
-            if (-1 <= i) {
-                return false;
+        const invalid = valueCheck(t, name, value, type);
+        if (invalid) {
+            if (typeof invalid === 'string') {
+                return {
+                    invalidType: 'invalid-value',
+                    message: invalid,
+                };
             }
-            if (-1 > i) {
-                return t('{0} behaves the same as {1} if {2}', t_theNameAttribute, '-1', t('less than {0}', '-1'));
+            else {
+                return {
+                    invalidType: 'invalid-value',
+                    message: invalid[0],
+                    loc: invalid[1],
+                };
             }
         }
-        return t('{0} expects {1:c}', t_theNameAttribute, t('either {0}', t(['-1', 'zero', 'non-negative integer'])));
-    }
-    if (spec.type === 'Target') {
-        // TODO: https://html.spec.whatwg.org/multipage/links.html#attr-hyperlink-target
-        return false;
-    }
-    if (spec.type === 'URL') {
-        // TODO: https://html.spec.whatwg.org/multipage/urls-and-fetching.html#valid-url-potentially-surrounded-by-spaces
         return false;
-    }
-    if (spec.type === 'URLHash') {
-        /**
-         * https://html.spec.whatwg.org/multipage/common-microsyntaxes.html#valid-hash-name-reference
-         */
-        const valid = value[0] === '#';
-        if (valid) {
-            return false;
-        }
-        return t('{0} expects {1:c}', t_theNameAttribute, t('valid {0}', 'hash-name reference'));
-    }
-    if (spec.type === 'URLList') {
-        // TODO: https://html.spec.whatwg.org/multipage/urls-and-fetching.html#valid-url-potentially-surrounded-by-spaces
-        return false;
-    }
-    if (spec.type === 'CSSAngle') {
-        /**
-         * @see https://drafts.csswg.org/css-values/#angles
-         */
-        const valid = (0, primitive_check_1.numberCheckWithUnit)(value, ['deg', 'grad', 'rad', 'turn']);
-        if (valid) {
-            return false;
-        }
-        return t('{0} expects {1}', t_theNameAttribute, 'angle');
-    }
-    if (spec.type === 'CSSBlendMode') {
-        /**
-         * @see https://drafts.fxtf.org/compositing/#ltblendmodegt
-         */
-        return includesEnum(t, name, value, [
-            'normal',
-            'multiply',
-            'screen',
-            'overlay',
-            'darken',
-            'lighten',
-            'color-dodge',
-            'color-burn',
-            'hard-light',
-            'soft-light',
-            'difference',
-            'exclusion',
-            'hue',
-            'saturation',
-            'color',
-            'luminosity',
-        ]);
-    }
-    if (spec.type === 'CSSClipPath') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/clip-path
+    });
+    if (invalidList.some(i => !i)) {
         return false;
     }
-    if (spec.type === 'CSSCustomIdent') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/custom-ident
-        return false;
-    }
-    if (spec.type === 'CSSDisplay') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/display
-        return false;
-    }
-    if (spec.type === 'CSSFilter') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/filter
-        return false;
-    }
-    if (spec.type === 'CSSFontFamily') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/font-family
-        return false;
-    }
-    if (spec.type === 'CSSFontSize') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/font-size
-        return false;
-    }
-    if (spec.type === 'CSSFontVariant') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant
-        return false;
-    }
-    if (spec.type === 'CSSFontWeight') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight
-        return false;
-    }
-    if (spec.type === 'CSSMask') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/mask
-        return false;
-    }
-    if (spec.type === 'CSSOpacity') {
-        /**
-         * @see https://drafts.csswg.org/css-color/#typedef-alpha-value
-         */
-        const { num, unit } = (0, primitive_check_1.splitUnit)(value);
-        if (unit === '%') {
-            const vaild = (0, primitive_check_1.range)(num, 0, 100);
-            if (vaild) {
-                return false;
-            }
-            return t('{0} expects {1:c}', t_theNameAttribute, t('{0} as {1}', t('{0} to {1}', '0%', '100%'), 'alpha channel value'));
-        }
-        const vaild = (0, primitive_check_1.range)(num, 0, 1);
-        if (vaild) {
-            return false;
-        }
-        return t('{0} expects {1:c}', t_theNameAttribute, t('{0} as {1}', t('{0} to {1}', '0', '1'), 'alpha channel value'));
-    }
-    if (spec.type === 'CSSTextDecoration') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/text-decoration
-        return false;
-    }
-    if (spec.type === 'CSSTransformList') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/transform-function
-        return false;
-    }
-    if (spec.type === 'CSSTransformOrigin') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin
-        return false;
-    }
-    if (spec.type === 'CSSURL') {
-        // TODO: https://www.w3.org/TR/css3-values/#url-value
-        return false;
-    }
-    if (spec.type === 'SVGAnimatableValue') {
-        // TODO
-        /**
-         * The exact value type for this attribute depends on the value of the attribute
-         * that will be animated.
-         *
-         * ```svg
-         * <rect x="10" y="10" height="100">
-         *   <animate attributeName="width" fill="freeze" from="100" to="150" dur="3s"/>
-         * </rect>
-         * ```
-         *
-         * The `from` and `to` attributes of the `animate` element are SVGAnimatableValue.
-         */
-        return false;
-    }
-    if (spec.type === 'SVGBeginValueList') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/begin
-        return false;
-    }
-    if (spec.type === 'SVGClockValue') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#clock-value
-        return false;
-    }
-    if (spec.type === 'SVGColorMatrix') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/feColorMatrix
-        return false;
-    }
-    if (spec.type === 'SVGDashArray') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray
-        return false;
-    }
-    if (spec.type === 'SVGEndValueList') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/end
-        return false;
-    }
-    if (spec.type === 'SVGFilterPrimitiveReference') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/result#usage_notes
-        return false;
-    }
-    if (spec.type === 'SVGKernelMatrix') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/kernelMatrix
-        return false;
-    }
-    if (spec.type === 'SVGKeyPoints') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/keyPoints
-        return false;
-    }
-    if (spec.type === 'SVGKeySplines') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/keySplines
-        return false;
-    }
-    if (spec.type === 'SVGKeyTimes') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/keyTimes
-        return false;
-    }
-    if (spec.type === 'SVGLanguageTags') {
-        /**
-         * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/systemLanguage
-         */
-        // TODO: List of BCP47
-        return false;
-    }
-    if (spec.type === 'SVGLength') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#length
-        return false;
-    }
-    if (spec.type === 'SVGLengthList') {
-        /**
-         * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#length
-         */
-        // TODO: List of SVGLength
-        return false;
-    }
-    if (spec.type === 'SVGNumberList') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/tableValues#usage_notes
-        return false;
-    }
-    if (spec.type === 'SVGNumberOptionalNumber') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#number-optional-number
-        return false;
-    }
-    if (spec.type === 'SVGOrigin') {
-        // TODO: https://www.w3.org/TR/2001/REC-smil-animation-20010904/#MotionOriginAttribute
-        return false;
-    }
-    if (spec.type === 'SVGPaint') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#paint
-        return false;
-    }
-    if (spec.type === 'SVGPathCommands') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d#path_commands
-        return false;
-    }
-    if (spec.type === 'SVGPercentage') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#percentage
-        return false;
-    }
-    if (spec.type === 'SVGPercentageList') {
-        /**
-         * @see https://developer.mozilla.org/en-US/docs/Web/SVG/Content_type#percentage
-         */
-        // TODO: List of SVGPercentage
-        return false;
-    }
-    if (spec.type === 'SVGPoints') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/points
-        return false;
-    }
-    if (spec.type === 'SVGPreserveAspectRatio') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio
+    const invalid = invalidList.find(i => i);
+    return invalid || false;
+}
+exports.attrCheck = attrCheck;
+function valueCheck(t, name, value, type) {
+    if (type === 'Boolean') {
+        // Valid because an attribute is exist
         return false;
     }
-    if (spec.type === 'SVGViewBox') {
-        // TODO: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox
-        return false;
+    const matches = (0, types_1.check)(value, type);
+    (0, debug_1.log)(`Result ([${name}="${value}"]): %O`, { ...matches, type });
+    if (!matches.matched) {
+        const location = {
+            raw: matches.raw,
+            line: matches.line - 1,
+            col: matches.column - 1,
+        };
+        const base = t('the "{0*}" {1}', name, 'attribute');
+        const message = (0, create_message_1.createMessageValueExpected)(t, base, type, matches);
+        return [message, location];
     }
     return false;
 }
-/**
- *
- * @param name
- * @param value
- * @param enumValues
- */
-function includesEnum(t, name, value, enumValues) {
-    const valid = enumValues.includes(value.toLowerCase());
-    if (valid) {
-        return false;
-    }
-    return t('{0} expects {1:c}', t('the "{0}" {1}', name, 'attribute'), t('either {0}', t(enumValues)));
-}
+exports.valueCheck = valueCheck;

package/lib/case-sensitive-attr-name/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const ml_core_1 = require("@markuplint/ml-core");
-const helpers_1 = require("../helpers");
 exports.default = (0, ml_core_1.createRule)({
     defaultServerity: 'warning',
     defaultValue: 'no-upper',
@@ -15,7 +14,7 @@ exports.default = (0, ml_core_1.createRule)({
             const deny = node.rule.value === 'no-upper' ? /[A-Z]/ : /[a-z]/;
             const cases = node.rule.value === 'no-upper' ? 'lower' : 'upper';
             const message = t(`{0} ${ms} be {1}`, t('{0} of {1}', 'attribute names', 'HTML elements'), `${cases}case`);
-            const attrSpecs = (0, helpers_1.getAttrSpecs)(node.nameWithNS, document.specs);
+            const attrSpecs = (0, ml_core_1.getAttrSpecs)(node.nameWithNS, document.specs);
             for (const attr of node.attributes) {
                 if (attr.attrType === 'ps-attr') {
                     continue;
@@ -51,7 +50,7 @@ exports.default = (0, ml_core_1.createRule)({
             if (node.isForeignElement || node.isCustomElement) {
                 return;
             }
-            const attrSpecs = (0, helpers_1.getAttrSpecs)(node.nameWithNS, document.specs);
+            const attrSpecs = (0, ml_core_1.getAttrSpecs)(node.nameWithNS, document.specs);
             if (node.attributes) {
                 for (const attr of node.attributes) {
                     if (attr.attrType === 'ps-attr') {

package/lib/create-message.d.ts

@@ -0,0 +1,5 @@
+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;