@markuplint/types 1.0.0-dev.20211213.0

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

@@ -0,0 +1,378 @@
+import { checkAutoComplete } from './check-autocomplete';
+
+const check = checkAutoComplete();
+
+test('valid', () => {
+	expect(check('on').matched).toBe(true);
+	expect(check('off').matched).toBe(true);
+	expect(check('name').matched).toBe(true);
+	expect(check('given-name').matched).toBe(true);
+	expect(check('section-').matched).toBe(true);
+	expect(check('section-foo').matched).toBe(true);
+	expect(check('section-foo name').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('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('home tel').matched).toBe(true);
+	expect(check('work email').matched).toBe(true);
+});
+
+test('unexpected-token', () => {
+	expect(check('section-foo , name')).toStrictEqual({
+		matched: false,
+		raw: ',',
+		offset: 12,
+		length: 1,
+		line: 1,
+		column: 13,
+		reason: 'unexpected-token',
+		expects: [
+			{ type: 'const', value: 'billing' },
+			{ type: 'const', value: 'shipping' },
+			{ type: 'common', value: 'autofill field name' },
+		],
+		candicate: undefined,
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+});
+
+test('unexpected-token', () => {
+	expect(check('xxx')).toStrictEqual({
+		matched: false,
+		raw: 'xxx',
+		offset: 0,
+		length: 3,
+		line: 1,
+		column: 1,
+		reason: 'unexpected-token',
+		expects: [
+			{ type: 'common', value: 'autofill named group' },
+			{ type: 'common', value: 'autofill field name' },
+		],
+		candicate: undefined,
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+});
+
+test('unexpected-token', () => {
+	expect(check('section-foo neme')).toStrictEqual({
+		matched: false,
+		raw: 'neme',
+		offset: 12,
+		length: 4,
+		line: 1,
+		column: 13,
+		reason: 'unexpected-token',
+		expects: [
+			{ type: 'const', value: 'billing' },
+			{ type: 'const', value: 'shipping' },
+			{ type: 'common', value: 'autofill field name' },
+		],
+		candicate: 'name',
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('section-foo shipping neme')).toStrictEqual({
+		matched: false,
+		raw: 'neme',
+		offset: 21,
+		length: 4,
+		line: 1,
+		column: 22,
+		reason: 'unexpected-token',
+		expects: [
+			{ type: 'common', value: 'autofill field name' },
+			{ type: 'const', value: 'home' },
+			{ type: 'const', value: 'work' },
+			{ type: 'const', value: 'mobile' },
+			{ type: 'const', value: 'fax' },
+			{ type: 'const', value: 'pager' },
+		],
+		candicate: 'name',
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('section-foo shipping home neme')).toStrictEqual({
+		matched: false,
+		raw: 'neme',
+		offset: 26,
+		length: 4,
+		line: 1,
+		column: 27,
+		reason: 'unexpected-token',
+		expects: [
+			{ type: 'const', value: 'tel' },
+			{ type: 'const', value: 'tel-country-code' },
+			{ type: 'const', value: 'tel-national' },
+			{ type: 'const', value: 'tel-area-code' },
+			{ type: 'const', value: 'tel-local' },
+			{ type: 'const', value: 'tel-local-prefix' },
+			{ type: 'const', value: 'tel-local-suffix' },
+			{ type: 'const', value: 'tel-extension' },
+			{ type: 'const', value: 'email' },
+			{ type: 'const', value: 'impp' },
+		],
+		candicate: 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({
+		matched: false,
+		raw: 'emall',
+		offset: 26,
+		length: 5,
+		line: 1,
+		column: 27,
+		reason: 'unexpected-token',
+		expects: [
+			{ type: 'const', value: 'tel' },
+			{ type: 'const', value: 'tel-country-code' },
+			{ type: 'const', value: 'tel-national' },
+			{ type: 'const', value: 'tel-area-code' },
+			{ type: 'const', value: 'tel-local' },
+			{ type: 'const', value: 'tel-local-prefix' },
+			{ type: 'const', value: 'tel-local-suffix' },
+			{ type: 'const', value: 'tel-extension' },
+			{ type: 'const', value: 'email' },
+			{ type: 'const', value: 'impp' },
+		],
+		candicate: 'email',
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-tel',
+	});
+});
+
+test('duplicated', () => {
+	expect(check('name name')).toStrictEqual({
+		matched: false,
+		raw: 'name',
+		offset: 5,
+		length: 4,
+		line: 1,
+		column: 6,
+		partName: 'the content of the list',
+		reason: 'duplicated',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete',
+	});
+	expect(check('on on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 3,
+		length: 2,
+		line: 1,
+		column: 4,
+		partName: 'the content of the list',
+		reason: 'duplicated',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete',
+	});
+});
+
+test('extra-token', () => {
+	expect(check('on off')).toStrictEqual({
+		matched: false,
+		raw: 'off',
+		offset: 3,
+		length: 3,
+		line: 1,
+		column: 4,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-on-2',
+	});
+	expect(check('off on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 4,
+		length: 2,
+		line: 1,
+		column: 5,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-on-2',
+	});
+	expect(check('on name')).toStrictEqual({
+		matched: false,
+		raw: 'name',
+		offset: 3,
+		length: 4,
+		line: 1,
+		column: 4,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-on-2',
+	});
+	expect(check('name on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 5,
+		length: 2,
+		line: 1,
+		column: 6,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('section-foo name on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 17,
+		length: 2,
+		line: 1,
+		column: 18,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('section-foo billing name on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 25,
+		length: 2,
+		line: 1,
+		column: 26,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('billing name on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 13,
+		length: 2,
+		line: 1,
+		column: 14,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('tel on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 4,
+		length: 2,
+		line: 1,
+		column: 5,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('home tel on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 9,
+		length: 2,
+		line: 1,
+		column: 10,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('billing home tel on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 17,
+		length: 2,
+		line: 1,
+		column: 18,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('billing home tel on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 17,
+		length: 2,
+		line: 1,
+		column: 18,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('section-foo billing home tel on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 29,
+		length: 2,
+		line: 1,
+		column: 30,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('section-foo home tel on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 21,
+		length: 2,
+		line: 1,
+		column: 22,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+	expect(check('section-foo tel on')).toStrictEqual({
+		matched: false,
+		raw: 'on',
+		offset: 16,
+		length: 2,
+		line: 1,
+		column: 17,
+		reason: 'extra-token',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+});
+
+test('duplicated section', () => {
+	expect(check('section-foo section-bar')).toStrictEqual({
+		matched: false,
+		raw: 'section-bar',
+		offset: 12,
+		length: 11,
+		line: 1,
+		column: 13,
+		partName: 'autofill named group',
+		reason: 'duplicated',
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-section',
+	});
+});
+
+test('duplicated part', () => {
+	expect(check('shipping billing')).toStrictEqual({
+		matched: false,
+		raw: 'billing',
+		offset: 9,
+		length: 7,
+		line: 1,
+		column: 10,
+		reason: 'duplicated',
+		expects: [{ type: 'format', value: 'autocomplete' }],
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-shipping',
+	});
+});
+
+test('typo', () => {
+	expect(check('secsion-foo name')).toStrictEqual({
+		matched: false,
+		raw: 'secsion-foo',
+		offset: 0,
+		length: 11,
+		line: 1,
+		column: 1,
+		reason: 'unexpected-token',
+		expects: [
+			{ type: 'common', value: 'autofill named group' },
+			{ type: 'common', value: 'autofill field name' },
+		],
+		candicate: 'section-foo',
+		ref: 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field',
+	});
+});

package/src/whatwg/check-autocomplete.ts

@@ -0,0 +1,324 @@
+import type { Expect } from '..';
+import type { CustomSyntaxChecker } from '../types';
+
+import { getCandicate } from '../get-candicate';
+import { matched } from '../match-result';
+import { TokenCollection } from '../token';
+
+/**
+ * https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-section
+ */
+const namedGroup = /^section-/i;
+
+/**
+ * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-shipping
+ */
+const partOfAddress = ['shipping', 'billing'];
+
+/**
+ * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field
+ */
+const autofillFieldNames = [
+	'name',
+	'honorific-prefix',
+	'given-name',
+	'additional-name',
+	'family-name',
+	'honorific-suffix',
+	'nickname',
+	'username',
+	'new-password',
+	'current-password',
+	'one-time-code',
+	'organization-title',
+	'organization',
+	'street-address',
+	'address-line1',
+	'address-line2',
+	'address-line3',
+	'address-level4',
+	'address-level3',
+	'address-level2',
+	'address-level1',
+	'country',
+	'country-name',
+	'postal-code',
+	'cc-name',
+	'cc-given-name',
+	'cc-additional-name',
+	'cc-family-name',
+	'cc-number',
+	'cc-exp',
+	'cc-exp-month',
+	'cc-exp-year',
+	'cc-csc',
+	'cc-type',
+	'transaction-currency',
+	'transaction-amount',
+	'language',
+	'bday',
+	'bday-day',
+	'bday-month',
+	'bday-year',
+	'sex',
+	'url',
+	'photo',
+];
+
+/**
+ * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-home
+ */
+const contactingTokens = ['home', 'work', 'mobile', 'fax', 'pager'];
+
+/**
+ * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:ascii-case-insensitive-7
+ */
+const contactableFieldNames = [
+	'tel',
+	'tel-country-code',
+	'tel-national',
+	'tel-area-code',
+	'tel-local',
+	'tel-local-prefix',
+	'tel-local-suffix',
+	'tel-extension',
+	'email',
+	'impp',
+];
+
+const URL_AUTOCOMPLET = '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 =
+	'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-section';
+const URL_PART_OF_ADDRESS =
+	'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete-shipping';
+const URL_AUTOFILL_FIELD = 'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-field';
+const URL_CONTACTABLE_FIELD =
+	'https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofilling-form-controls:-the-autocomplete-attribute:attr-fe-autocomplete-tel';
+
+/**
+ * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#attr-fe-autocomplete
+ */
+export const checkAutoComplete: CustomSyntaxChecker = () => value => {
+	let hasNamedGroup = false;
+	let hasPartOfAddress = false;
+	let hasContactingToken = false;
+
+	const tokens = new TokenCollection(value, {
+		disallowToSurroundBySpaces: false,
+		allowEmpty: false,
+		ordered: true,
+		unique: true,
+		caseInsensitive: true,
+	});
+
+	const listingChecked = tokens.check({
+		expects: [
+			{
+				type: 'format',
+				value: 'autocomplete',
+			},
+		],
+		ref: URL_AUTOCOMPLET,
+	});
+	if (!listingChecked.matched) {
+		return listingChecked;
+	}
+
+	const idents = tokens.getIdentTokens();
+	const headAndTail1 = idents.headAndTail();
+	let { head, tail } = headAndTail1;
+	if (!head) {
+		// Never
+		throw new Error('TokenCollection is empty');
+	}
+
+	// > When wearing the autofill anchor mantle, the autocomplete attribute,
+	// > if specified, must have a value that is
+	// > an ordered set of space-separated tokens consisting of
+	// > just autofill detail tokens
+	// > (i.e. the "on" and "off" keywords are not allowed).
+	if (head.match(['on', 'off'], true)) {
+		if (tail.length) {
+			return tail[0].unmatched({
+				reason: 'extra-token',
+				expects: [
+					{
+						type: 'format',
+						value: 'autocomplete',
+					},
+				],
+				ref: URL_ON_OFF,
+			});
+		}
+
+		return matched();
+	}
+
+	// > Optionally, a token whose first eight characters are
+	// > an ASCII case-insensitive match for the string "section-",
+	// > meaning that the field belongs to the named group.
+	if (head.match(namedGroup, true)) {
+		hasNamedGroup = true;
+		const sectionToken = tail.search(namedGroup);
+		if (sectionToken) {
+			return sectionToken.unmatched({
+				partName: 'autofill named group',
+				reason: 'duplicated',
+				ref: URL_NAMED_GROUP,
+			});
+		}
+
+		const headAndTail2 = tail.headAndTail();
+		head = headAndTail2.head;
+		tail = headAndTail2.tail;
+
+		if (!head) {
+			// Missing autofill field name but it is valid
+			return matched();
+		}
+	}
+
+	// > Optionally, a token that is an ASCII case-insensitive match for
+	// > one of the following strings:
+	// > - "shipping", meaning the field is part of the shipping address or contact information
+	// > - "billing", meaning the field is part of the billing address or contact information
+	if (head.match(partOfAddress, true)) {
+		hasPartOfAddress = true;
+		const partToken = tail.search(partOfAddress);
+		if (partToken) {
+			return partToken.unmatched({
+				reason: 'duplicated',
+				expects: [
+					{
+						type: 'format',
+						value: 'autocomplete',
+					},
+				],
+				ref: URL_PART_OF_ADDRESS,
+			});
+		}
+
+		const headAndTail3 = tail.headAndTail();
+		head = headAndTail3.head;
+		tail = headAndTail3.tail;
+
+		if (!head) {
+			// Missing autofill field name but it is valid
+			return matched();
+		}
+	}
+
+	if (head.match(contactingTokens, true)) {
+		hasContactingToken = true;
+		const contactableFiledToken = tail[0];
+		if (!contactableFiledToken) {
+			// Missing autofill field name but it is valid
+			return matched();
+		}
+
+		if (!contactableFiledToken.match(contactableFieldNames, true)) {
+			const candicate = getCandicate(contactableFiledToken.value, contactableFieldNames);
+			return contactableFiledToken.unmatched({
+				reason: 'unexpected-token',
+				expects: contactableFieldNames.slice().map(token => ({
+					type: 'const' as const,
+					value: token,
+				})),
+				candicate,
+				ref: URL_CONTACTABLE_FIELD,
+			});
+		}
+
+		if (tail[1]) {
+			return tail[1].unmatched({
+				reason: 'extra-token',
+				expects: [
+					{
+						type: 'format',
+						value: 'autocomplete',
+					},
+				],
+				ref: URL_AUTOFILL_FIELD,
+			});
+		}
+
+		return matched();
+	}
+
+	if (head.match([...autofillFieldNames, ...contactableFieldNames], true)) {
+		if (tail.length) {
+			return tail[0].unmatched({
+				reason: 'extra-token',
+				expects: [
+					{
+						type: 'format',
+						value: 'autocomplete',
+					},
+				],
+				ref: URL_AUTOFILL_FIELD,
+			});
+		}
+
+		return matched();
+	}
+
+	const expects: Expect[] = [
+		{
+			type: 'common',
+			value: 'autofill field name',
+		},
+	];
+	let candicate: string | undefined;
+
+	if (!hasNamedGroup) {
+		expects.unshift({
+			type: 'common',
+			value: 'autofill named group',
+		});
+
+		// Potentially typo a named group
+		const [prefix, namedGroupStr] = head.value.split('-');
+		const candicatePrefix = getCandicate(prefix, 'section');
+		if (candicatePrefix) {
+			candicate = `${candicatePrefix}-${namedGroupStr || ''}`;
+		}
+	} else if (!hasPartOfAddress) {
+		expects.unshift(
+			...partOfAddress
+				.slice()
+				.reverse()
+				.map(token => ({
+					type: 'const' as const,
+					value: token,
+				})),
+		);
+
+		candicate = getCandicate(
+			head.value,
+			partOfAddress,
+			autofillFieldNames,
+			contactingTokens,
+			contactableFieldNames,
+		);
+	} else if (!hasContactingToken) {
+		expects.push(
+			...contactingTokens.slice().map(token => ({
+				type: 'const' as const,
+				value: token,
+			})),
+		);
+
+		candicate = getCandicate(head.value, autofillFieldNames, contactingTokens, contactableFieldNames);
+	}
+
+	candicate = candicate || getCandicate(head.value, autofillFieldNames);
+
+	return head.unmatched({
+		reason: 'unexpected-token',
+		expects,
+		candicate,
+		ref: URL_AUTOFILL_FIELD,
+	});
+};