@markuplint/types 3.0.0-alpha.0 → 3.0.0-alpha.2

package/src/types.ts

@@ -20,7 +20,7 @@ export type UnmatchedResultOptions = {
 	partName?: string;
 	expects?: Expect[];
 	extra?: Expect;
-	candicate?: string;
+	candidate?: string;
 };
 
 export type UnmatchedResultReason =
@@ -64,7 +64,7 @@ export type MatchedResult = {
 };
 
 export type Expect = {
-	type: 'const' | 'format' | 'syntax' | 'regxp' | 'common';
+	type: 'const' | 'format' | 'syntax' | 'regexp' | 'common';
 	value: string;
 };
 

package/src/whatwg/check-autocomplete.spec.ts

@@ -2,28 +2,37 @@ import { checkAutoComplete } from './check-autocomplete';
 
 const check = checkAutoComplete();
 
-test('valid', () => {
+test('basic', () => {
 	expect(check('on').matched).toBe(true);
+	expect(check('on webauthn').matched).toBe(false);
 	expect(check('off').matched).toBe(true);
+	expect(check('off webauthn').matched).toBe(false);
 	expect(check('name').matched).toBe(true);
 	expect(check('given-name').matched).toBe(true);
+	expect(check('given-name webauthn').matched).toBe(true);
+	expect(check('given-name webauthun').matched).toBe(false);
 	expect(check('section-').matched).toBe(true);
 	expect(check('section-foo').matched).toBe(true);
+	expect(check('section-foo webauthn').matched).toBe(true);
 	expect(check('section-foo name').matched).toBe(true);
+	expect(check('section-foo name webauthn').matched).toBe(true);
 	expect(check('section-foo shipping name').matched).toBe(true);
 	expect(check('section-foo billing name').matched).toBe(true);
 	expect(check('section-foo billing home').matched).toBe(true);
 	expect(check('section-foo billing work').matched).toBe(true);
 	expect(check('section-foo billing home tel').matched).toBe(true);
 	expect(check('section-foo billing work email').matched).toBe(true);
+	expect(check('section-foo billing work email webauthn').matched).toBe(true);
 	expect(check('shipping name').matched).toBe(true);
 	expect(check('billing name').matched).toBe(true);
 	expect(check('billing home').matched).toBe(true);
 	expect(check('billing work').matched).toBe(true);
 	expect(check('billing home tel').matched).toBe(true);
 	expect(check('billing work email').matched).toBe(true);
+	expect(check('billing work email webauthn').matched).toBe(true);
 	expect(check('home tel').matched).toBe(true);
 	expect(check('work email').matched).toBe(true);
+	expect(check('work email webauthn').matched).toBe(true);
 });
 
 test('unexpected-token', () => {
@@ -40,7 +49,7 @@ test('unexpected-token', () => {
 			{ type: 'const', value: 'shipping' },
 			{ type: 'common', value: 'autofill field name' },
 		],
-		candicate: undefined,
+		candidate: undefined,
 		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
 	});
 });
@@ -58,7 +67,7 @@ test('unexpected-token', () => {
 			{ type: 'common', value: 'autofill named group' },
 			{ type: 'common', value: 'autofill field name' },
 		],
-		candicate: undefined,
+		candidate: undefined,
 		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
 	});
 });
@@ -77,7 +86,7 @@ test('unexpected-token', () => {
 			{ type: 'const', value: 'shipping' },
 			{ type: 'common', value: 'autofill field name' },
 		],
-		candicate: 'name',
+		candidate: 'name',
 		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
 	});
 	expect(check('section-foo shipping neme')).toStrictEqual({
@@ -96,12 +105,12 @@ test('unexpected-token', () => {
 			{ type: 'const', value: 'fax' },
 			{ type: 'const', value: 'pager' },
 		],
-		candicate: 'name',
+		candidate: 'name',
 		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
 	});
-	expect(check('section-foo shipping home neme')).toStrictEqual({
+	expect(check('section-foo shipping home name')).toStrictEqual({
 		matched: false,
-		raw: 'neme',
+		raw: 'name',
 		offset: 26,
 		length: 4,
 		line: 1,
@@ -119,7 +128,7 @@ test('unexpected-token', () => {
 			{ type: 'const', value: 'email' },
 			{ type: 'const', value: 'impp' },
 		],
-		candicate: undefined,
+		candidate: undefined,
 		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-tel',
 	});
 	expect(check('section-foo shipping home emall')).toStrictEqual({
@@ -142,7 +151,7 @@ test('unexpected-token', () => {
 			{ type: 'const', value: 'email' },
 			{ type: 'const', value: 'impp' },
 		],
-		candicate: 'email',
+		candidate: 'email',
 		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-tel',
 	});
 });
@@ -372,7 +381,7 @@ test('typo', () => {
 			{ type: 'common', value: 'autofill named group' },
 			{ type: 'common', value: 'autofill field name' },
 		],
-		candicate: 'section-foo',
+		candidate: 'section-foo',
 		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
 	});
 });

package/src/whatwg/check-autocomplete.ts

@@ -1,10 +1,13 @@
 import type { Expect } from '..';
 import type { CustomSyntaxChecker } from '../types';
 
-import { getCandicate } from '../get-candicate';
+import { log } from '../debug';
+import { getCandidate } from '../get-candidate';
 import { matched } from '../match-result';
 import { TokenCollection } from '../token';
 
+const acLog = log.extend('autocomplete');
+
 /**
  * https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-section
  */
@@ -86,7 +89,12 @@ const contactableFieldNames = [
 	'impp',
 ];
 
-const URL_AUTOCOMPLET = 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete';
+/**
+ * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-webauthn
+ */
+const webauthnFieldNames = ['webauthn'];
+
+const URL_AUTOCOMPLETE = 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete';
 const URL_ON_OFF =
 	'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-on-2';
 const URL_NAMED_GROUP =
@@ -120,14 +128,15 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 				value: 'autocomplete',
 			},
 		],
-		ref: URL_AUTOCOMPLET,
+		ref: URL_AUTOCOMPLETE,
 	});
 	if (!listingChecked.matched) {
+		acLog('Unmatch: %s', listingChecked.reason);
 		return listingChecked;
 	}
 
-	const idents = tokens.getIdentTokens();
-	const headAndTail1 = idents.headAndTail();
+	const identTokens = tokens.getIdentTokens();
+	const headAndTail1 = identTokens.headAndTail();
 	let { head, tail } = headAndTail1;
 	if (!head) {
 		// Never
@@ -141,6 +150,7 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 	// > (i.e. the "on" and "off" keywords are not allowed).
 	if (head.match(['on', 'off'], true)) {
 		if (tail.length) {
+			acLog('[Unmatched ("%s")] Unexpected pair with "on" or "off": "%s"', value, tail.value);
 			return tail[0].unmatched({
 				reason: 'extra-token',
 				expects: [
@@ -163,6 +173,7 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 		hasNamedGroup = true;
 		const sectionToken = tail.search(namedGroup);
 		if (sectionToken) {
+			acLog('[Unmatched ("%s")] Deprecated in autofill named group: "%s"', value, sectionToken.value);
 			return sectionToken.unmatched({
 				partName: 'autofill named group',
 				reason: 'duplicated',
@@ -188,6 +199,7 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 		hasPartOfAddress = true;
 		const partToken = tail.search(partOfAddress);
 		if (partToken) {
+			acLog('[Unmatched ("%s")] Duplicated values: "%s"', value, partToken.value);
 			return partToken.unmatched({
 				reason: 'duplicated',
 				expects: [
@@ -219,19 +231,37 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 		}
 
 		if (!contactableFiledToken.match(contactableFieldNames, true)) {
-			const candicate = getCandicate(contactableFiledToken.value, contactableFieldNames);
+			const candidate = getCandidate(contactableFiledToken.value, contactableFieldNames);
+			acLog('[Unmatched ("%s")] Unexpected token: "%s"', value, contactableFiledToken.value);
 			return contactableFiledToken.unmatched({
 				reason: 'unexpected-token',
 				expects: contactableFieldNames.slice().map(token => ({
 					type: 'const' as const,
 					value: token,
 				})),
-				candicate,
+				candidate,
 				ref: URL_CONTACTABLE_FIELD,
 			});
 		}
 
 		if (tail[1]) {
+			if (tail[1].match(webauthnFieldNames)) {
+				return matched();
+			}
+
+			const candidate = getCandidate(tail[1].value, webauthnFieldNames);
+
+			if (candidate) {
+				acLog(
+					'[Unmatched ("%s")] Unnecessarily token: "%s", Do you mean "%s"? ',
+					value,
+					tail[1].value,
+					candidate,
+				);
+			} else {
+				acLog('[Unmatched ("%s")] Unnecessarily token: "%s"', value, tail[1].value);
+			}
+
 			return tail[1].unmatched({
 				reason: 'extra-token',
 				expects: [
@@ -249,6 +279,23 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 
 	if (head.match([...autofillFieldNames, ...contactableFieldNames], true)) {
 		if (tail.length) {
+			if (tail[0].match(webauthnFieldNames)) {
+				return matched();
+			}
+
+			const candidate = getCandidate(tail[0].value, webauthnFieldNames);
+
+			if (candidate) {
+				acLog(
+					'[Unmatched ("%s")] Unnecessarily token: "%s", Do you mean "%s"? ',
+					value,
+					tail[0].value,
+					candidate,
+				);
+			} else {
+				acLog('[Unmatched ("%s")] Unnecessarily token: "%s"', value, tail[0].value);
+			}
+
 			return tail[0].unmatched({
 				reason: 'extra-token',
 				expects: [
@@ -264,13 +311,17 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 		return matched();
 	}
 
+	if (head.match(webauthnFieldNames)) {
+		return matched();
+	}
+
 	const expects: Expect[] = [
 		{
 			type: 'common',
 			value: 'autofill field name',
 		},
 	];
-	let candicate: string | undefined;
+	let candidate: string | undefined;
 
 	if (!hasNamedGroup) {
 		expects.unshift({
@@ -280,9 +331,9 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 
 		// Potentially typo a named group
 		const [prefix, namedGroupStr] = head.value.split('-');
-		const candicatePrefix = getCandicate(prefix, 'section');
-		if (candicatePrefix) {
-			candicate = `${candicatePrefix}-${namedGroupStr || ''}`;
+		const candidatePrefix = getCandidate(prefix, 'section');
+		if (candidatePrefix) {
+			candidate = `${candidatePrefix}-${namedGroupStr || ''}`;
 		}
 	} else if (!hasPartOfAddress) {
 		expects.unshift(
@@ -295,7 +346,7 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 				})),
 		);
 
-		candicate = getCandicate(
+		candidate = getCandidate(
 			head.value,
 			partOfAddress,
 			autofillFieldNames,
@@ -310,15 +361,20 @@ export const checkAutoComplete: CustomSyntaxChecker = () => value => {
 			})),
 		);
 
-		candicate = getCandicate(head.value, autofillFieldNames, contactingTokens, contactableFieldNames);
+		candidate = getCandidate(head.value, autofillFieldNames, contactingTokens, contactableFieldNames);
 	}
 
-	candicate = candicate || getCandicate(head.value, autofillFieldNames);
+	candidate = candidate || getCandidate(head.value, autofillFieldNames);
 
+	if (candidate) {
+		acLog('[Unmatched ("%s")] Unexpected token: "%s", Do you mean "%s"? ', value, head.value, candidate);
+	} else {
+		acLog('[Unmatched ("%s")] Unexpected token: "%s"', value, head.value);
+	}
 	return head.unmatched({
 		reason: 'unexpected-token',
 		expects,
-		candicate,
+		candidate,
 		ref: URL_AUTOFILL_FIELD,
 	});
 };

package/src/whatwg/check-datetime/datetime-tokens.ts

@@ -13,9 +13,9 @@ export const datetimeTokenCheck: Record<
 	| 'secondFractionalPart'
 	| 'week'
 	| 'hyphen'
-	| 'coron'
+	| 'colon'
 	| 'extra'
-	| 'coronOrEnd'
+	| 'colonOrEnd'
 	| 'decimalPointOrEnd'
 	| 'localDateTimeSeparator'
 	| 'normalizedlocalDateTimeSeparator'
@@ -391,19 +391,19 @@ export const datetimeTokenCheck: Record<
 	/**
 	 * > A U+003A COLON character (:)
 	 */
-	coron(coron) {
-		log('Parsing Datetime coron: "%s"', coron?.value);
+	colon(colon) {
+		log('Parsing Datetime colon: "%s"', colon?.value);
 
-		if (!coron || !coron.value) {
+		if (!colon || !colon.value) {
 			return unmatched('', 'missing-token', {
-				expects: [{ type: 'common', value: 'coron' }],
+				expects: [{ type: 'common', value: 'colon' }],
 				partName: 'time',
 			});
 		}
-		if (!coron.match(':')) {
-			return coron.unmatched({
+		if (!colon.match(':')) {
+			return colon.unmatched({
 				reason: 'unexpected-token',
-				expects: [{ type: 'common', value: 'coron' }],
+				expects: [{ type: 'common', value: 'colon' }],
 				partName: 'time',
 			});
 		}
@@ -414,15 +414,15 @@ export const datetimeTokenCheck: Record<
 	 * or
 	 * End of token
 	 */
-	coronOrEnd(coron) {
-		if (!coron || !coron.value) {
+	colonOrEnd(colon) {
+		if (!colon || !colon.value) {
 			return matched();
 		}
 
-		if (!coron.match(':')) {
-			return coron.unmatched({
+		if (!colon.match(':')) {
+			return colon.unmatched({
 				reason: 'unexpected-token',
-				expects: [{ type: 'common', value: 'coron' }],
+				expects: [{ type: 'common', value: 'colon' }],
 				partName: 'time',
 			});
 		}
@@ -498,8 +498,8 @@ export const datetimeTokenCheck: Record<
 	 * > a U+002D HYPHEN-MINUS character (-),
 	 * > representing the sign of the time-zone offset
 	 */
-	plusOrMinusSign(coron) {
-		if (!coron) {
+	plusOrMinusSign(colon) {
+		if (!colon) {
 			return unmatched('', 'missing-token', {
 				expects: [
 					{ type: 'const', value: '+' },
@@ -508,8 +508,8 @@ export const datetimeTokenCheck: Record<
 				partName: 'time-zone',
 			});
 		}
-		if (!coron.match(['+', '-'])) {
-			return coron.unmatched({
+		if (!colon.match(['+', '-'])) {
+			return colon.unmatched({
 				reason: 'unexpected-token',
 				expects: [
 					{ type: 'const', value: '+' },

package/src/whatwg/check-datetime/global-date-and-time-string.ts

@@ -49,7 +49,7 @@ export const checkGlobalDateAndTimeString: CustomSyntaxChecker = () =>
 			datetimeTokenCheck.date,
 			datetimeTokenCheck.localDateTimeSeparator,
 			datetimeTokenCheck.hour,
-			datetimeTokenCheck.coron,
+			datetimeTokenCheck.colon,
 			datetimeTokenCheck.minute,
 			second => {
 				if (!second || !second.value) {
@@ -58,10 +58,10 @@ export const checkGlobalDateAndTimeString: CustomSyntaxChecker = () =>
 
 				const secondTokens = TokenCollection.fromPatterns(second, [/:?/, /[0-9]*/, /\.?/, /[0-9]*/]);
 
-				log('Scond Part: "%s" => %O', secondTokens.value, secondTokens);
+				log('Second Part: "%s" => %O', secondTokens.value, secondTokens);
 
 				const res = secondTokens.eachCheck(
-					datetimeTokenCheck.coron,
+					datetimeTokenCheck.colon,
 					datetimeTokenCheck.second,
 					datetimeTokenCheck.decimalPointOrEnd,
 					datetimeTokenCheck.secondFractionalPart,

package/src/whatwg/check-datetime/local-date-and-time-string.ts

@@ -51,9 +51,9 @@ export const checkLocalDateAndTimeString: CustomSyntaxChecker = () =>
 			datetimeTokenCheck.date,
 			datetimeTokenCheck.localDateTimeSeparator,
 			datetimeTokenCheck.hour,
-			datetimeTokenCheck.coron,
+			datetimeTokenCheck.colon,
 			datetimeTokenCheck.minute,
-			datetimeTokenCheck.coronOrEnd,
+			datetimeTokenCheck.colonOrEnd,
 			datetimeTokenCheck.second,
 			datetimeTokenCheck.decimalPointOrEnd,
 			datetimeTokenCheck.secondFractionalPart,
@@ -113,9 +113,9 @@ export const checkNormalizedLocalDateAndTimeString: CustomSyntaxChecker = () =>
 			datetimeTokenCheck.date,
 			datetimeTokenCheck.normalizedlocalDateTimeSeparator,
 			datetimeTokenCheck.hour,
-			datetimeTokenCheck.coron,
+			datetimeTokenCheck.colon,
 			datetimeTokenCheck.minute,
-			datetimeTokenCheck.coronOrEnd,
+			datetimeTokenCheck.colonOrEnd,
 			datetimeTokenCheck.second,
 			datetimeTokenCheck.decimalPointOrEnd,
 			datetimeTokenCheck.secondFractionalPart,

package/src/whatwg/check-datetime/time-string.ts

@@ -33,9 +33,9 @@ export const checkTimeString: CustomSyntaxChecker = () =>
 
 		const res = tokens.eachCheck(
 			datetimeTokenCheck.hour,
-			datetimeTokenCheck.coron,
+			datetimeTokenCheck.colon,
 			datetimeTokenCheck.minute,
-			datetimeTokenCheck.coronOrEnd,
+			datetimeTokenCheck.colonOrEnd,
 			datetimeTokenCheck.second,
 			datetimeTokenCheck.decimalPointOrEnd,
 			datetimeTokenCheck.secondFractionalPart,

package/src/whatwg/check-datetime/time-zone-offset-string.ts

@@ -68,13 +68,13 @@ export function parseTimeZone(zone: string | Token) {
 			}
 		},
 		datetimeTokenCheck.hour,
-		coron => {
-			if (!coron || !coron.value) {
+		colon => {
+			if (!colon || !colon.value) {
 				return;
 			}
 
-			if (!coron.match(':')) {
-				return coron.unmatched({
+			if (!colon.match(':')) {
+				return colon.unmatched({
 					reason: 'unexpected-token',
 					expects: [{ type: 'const', value: ':' }],
 					partName: 'time-zone',

package/src/whatwg/check-mime-type.spec.ts

@@ -21,7 +21,7 @@ test('excrescence-token', () => {
 		ref: null,
 	});
 	expect(check('x/y;')).toStrictEqual({
-		candicate: 'x/y',
+		candidate: 'x/y',
 		column: 4,
 		expects: [{ type: 'format', value: 'MIME Type' }],
 		length: 1,
@@ -33,7 +33,7 @@ test('excrescence-token', () => {
 		ref: null,
 	});
 	expect(checkNoParam('x/y;')).toStrictEqual({
-		candicate: 'x/y',
+		candidate: 'x/y',
 		column: 4,
 		expects: [{ type: 'format', value: 'MIME Type with no parameters' }],
 		length: 1,
@@ -45,7 +45,7 @@ test('excrescence-token', () => {
 		ref: null,
 	});
 	expect(checkNoParam('x/y;a=b;c=D;E="F"')).toStrictEqual({
-		candicate: 'x/y',
+		candidate: 'x/y',
 		column: 4,
 		expects: [{ type: 'format', value: 'MIME Type with no parameters' }],
 		length: 14,

package/src/whatwg/check-mime-type.ts

@@ -39,7 +39,7 @@ export const checkMIMEType: CustomSyntaxChecker<{
 		return new Token(extraToken, mimeType.essence.length, value).unmatched({
 			reason: 'extra-token',
 			expects: expects(withoutParameters),
-			candicate: mimeType.essence,
+			candidate: mimeType.essence,
 		});
 	}
 	return unmatched(value, 'syntax-error', { expects: expects(withoutParameters) });