testaro-issues 0.1.0 → 0.2.1

package/dist/index.cjs

@@ -4709,7 +4709,7 @@ const rulesData = {
 				"what": "font element is obsolete"
 			}
 		},
-		"variable": { "E-^AAA.4_1_2.H91.Input[-a-zA-Z]+.Name": {
+		"variable": { "E-AAA\\.4_1_2\\.H91\\.Input[-a-zA-Z]+\\.Name": {
 			"issueID": "inputNoText",
 			"quality": 1,
 			"what": "input element has no accessible name"
@@ -6384,7 +6384,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "script-src content attribute blocks a script"
 			},
-			"Discarding unrecognized token .+ from value of attribute role. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
+			"Discarding unrecognized token .+ from value of attribute role\\. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
 				"issueID": "roleBad",
 				"quality": 1,
 				"what": "Invalid role"
@@ -6444,7 +6444,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Attribute has an empty value"
 			},
-			"Potentially bad value .+ for attribute .+ on element .+Typo for .+?.*": {
+			"Potentially bad value .+ for attribute .+ on element .+Typo for .+\\?.*": {
 				"issueID": "attributeValueRisk",
 				"quality": 1,
 				"what": "Attribute value may be a typographical error"
@@ -6699,7 +6699,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Invalid closing tag"
 			},
-			"End tag [a-z]+.": {
+			"End tag [a-z]+\\.": {
 				"issueID": "elementClosure",
 				"quality": 1,
 				"what": "Closing tag of an ineligible element"
@@ -7930,7 +7930,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "script-src content attribute blocks a script"
 			},
-			"Discarding unrecognized token .+ from value of attribute role. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
+			"Discarding unrecognized token .+ from value of attribute role\\. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
 				"issueID": "roleBad",
 				"quality": 1,
 				"what": "Invalid role"
@@ -7990,7 +7990,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Attribute has an empty value"
 			},
-			"Potentially bad value .+ for attribute .+ on element .+Typo for .+?.*": {
+			"Potentially bad value .+ for attribute .+ on element .+Typo for .+\\?.*": {
 				"issueID": "attributeValueRisk",
 				"quality": 1,
 				"what": "Attribute value may be a typographical error"
@@ -8245,7 +8245,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Invalid closing tag"
 			},
-			"End tag [a-z]+.": {
+			"End tag [a-z]+\\.": {
 				"issueID": "elementClosure",
 				"quality": 1,
 				"what": "Closing tag of an ineligible element"
@@ -9678,33 +9678,42 @@ const issues = deepFreeze(issuesData);
 const rules = deepFreeze(rulesData);
 const makeIssueRules = (ruleTable, issueTable = issues) => {
 	const errors = [];
-	const checkEntry = (toolID, groupName, ruleID, entry) => {
+	const checkEntry = (engineID, variabilityName, ruleID, entry) => {
 		const { issueID, quality, what } = entry;
-		if (typeof issueID !== "string" || !(issueID in issueTable)) errors.push(`${toolID}.${groupName}.${ruleID} has an invalid issueID (${JSON.stringify(issueID)})`);
-		if (typeof quality !== "number") errors.push(`${toolID}.${groupName}.${ruleID} has a non-numeric quality (${JSON.stringify(quality)})`);
-		if (typeof what !== "string") errors.push(`${toolID}.${groupName}.${ruleID} has a non-string what (${JSON.stringify(what)})`);
+		if (!ruleID.length) errors.push(`${engineID}.${variabilityName} has a rule with an empty ruleID`);
+		if (typeof issueID !== "string" || !issueID.length || !(issueID in issueTable)) errors.push(`${engineID}.${variabilityName}.${ruleID} has an invalid issueID (${JSON.stringify(issueID)})`);
+		if (typeof quality !== "number") errors.push(`${engineID}.${variabilityName}.${ruleID} has a non-numeric quality (${JSON.stringify(quality)})`);
+		if (typeof what !== "string" || !what.length) errors.push(`${engineID}.${variabilityName}.${ruleID} has a non-string or empty what (${JSON.stringify(what)})`);
+		if (variabilityName === "variable") {
+			if (!/[.*+?^${}()|[\]\\]/.test(ruleID)) errors.push(`${engineID}.${variabilityName}.${ruleID} has no regex metacharacters, so it should be an invariant rule`);
+			else try {
+				new RegExp(ruleID);
+			} catch (error) {
+				errors.push(`${engineID}.${variabilityName}.${ruleID} is not a valid regular expression (${error.message})`);
+			}
+		}
 	};
 	const issueRules = {};
-	Object.entries(ruleTable).forEach(([toolID, { invariant, variable }]) => {
+	Object.entries(ruleTable).forEach(([engineID, { invariant, variable }]) => {
 		Object.entries(invariant).forEach(([ruleID, entry]) => {
-			checkEntry(toolID, "invariant", ruleID, entry);
+			checkEntry(engineID, "invariant", ruleID, entry);
 			const { issueID } = entry;
 			issueRules[issueID] ??= {};
-			issueRules[issueID][toolID] ??= {
+			issueRules[issueID][engineID] ??= {
 				invariant: [],
 				variable: []
 			};
-			issueRules[issueID][toolID].invariant.push(ruleID);
+			issueRules[issueID][engineID].invariant.push(ruleID);
 		});
 		Object.entries(variable).forEach(([ruleID, entry]) => {
-			checkEntry(toolID, "variable", ruleID, entry);
+			checkEntry(engineID, "variable", ruleID, entry);
 			const { issueID } = entry;
 			issueRules[issueID] ??= {};
-			issueRules[issueID][toolID] ??= {
+			issueRules[issueID][engineID] ??= {
 				invariant: [],
 				variable: []
 			};
-			issueRules[issueID][toolID].variable.push(ruleID);
+			issueRules[issueID][engineID].variable.push(ruleID);
 		});
 	});
 	if (errors.length) throw new Error(`${errors[0]} (1 of ${errors.length} problems found)`);

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 //#region src/index.d.ts
+type IssueID = keyof typeof issuesData;
 interface Issue {
   summary: string;
   why: string;
@@ -15,11 +16,10 @@ interface RuleEntry {
   quality: number;
   what: string;
 }
-interface ToolRules {
+interface EngineRules {
   invariant: Record<string, RuleEntry>;
   variable: Record<string, RuleEntry>;
 }
-type IssueID = keyof typeof issuesData;
 declare const issuesData: {
   readonly ignorable: {
     readonly summary: 'ignorable';
@@ -2236,11 +2236,11 @@ declare const issuesData: {
   };
 };
 declare const issues: Readonly<Record<string, Issue>>;
-declare const rules: Readonly<Record<string, ToolRules>>;
-declare const makeIssueRules: (ruleTable: Record<string, ToolRules>, issueTable?: Record<string, Issue>) => Record<string, Record<string, IssueRuleGroup>>;
+declare const rules: Readonly<Record<string, EngineRules>>;
+declare const makeIssueRules: (ruleTable: Record<string, EngineRules>, issueTable?: Record<string, Issue>) => Record<string, Record<string, IssueRuleGroup>>;
 declare const getEditableData: () => {
   issues: Readonly<Record<string, Issue>>;
-  rules: Readonly<Record<string, ToolRules>>;
+  rules: Readonly<Record<string, EngineRules>>;
   issueRules: Record<string, Record<string, IssueRuleGroup>>;
 };
 declare const issueRules: Record<string, Record<string, IssueRuleGroup>>;

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 //#region src/index.d.ts
+type IssueID = keyof typeof issuesData;
 interface Issue {
   summary: string;
   why: string;
@@ -15,11 +16,10 @@ interface RuleEntry {
   quality: number;
   what: string;
 }
-interface ToolRules {
+interface EngineRules {
   invariant: Record<string, RuleEntry>;
   variable: Record<string, RuleEntry>;
 }
-type IssueID = keyof typeof issuesData;
 declare const issuesData: {
   readonly ignorable: {
     readonly summary: 'ignorable';
@@ -2236,11 +2236,11 @@ declare const issuesData: {
   };
 };
 declare const issues: Readonly<Record<string, Issue>>;
-declare const rules: Readonly<Record<string, ToolRules>>;
-declare const makeIssueRules: (ruleTable: Record<string, ToolRules>, issueTable?: Record<string, Issue>) => Record<string, Record<string, IssueRuleGroup>>;
+declare const rules: Readonly<Record<string, EngineRules>>;
+declare const makeIssueRules: (ruleTable: Record<string, EngineRules>, issueTable?: Record<string, Issue>) => Record<string, Record<string, IssueRuleGroup>>;
 declare const getEditableData: () => {
   issues: Readonly<Record<string, Issue>>;
-  rules: Readonly<Record<string, ToolRules>>;
+  rules: Readonly<Record<string, EngineRules>>;
   issueRules: Record<string, Record<string, IssueRuleGroup>>;
 };
 declare const issueRules: Record<string, Record<string, IssueRuleGroup>>;

package/dist/index.mjs

@@ -4708,7 +4708,7 @@ const rulesData = {
 				"what": "font element is obsolete"
 			}
 		},
-		"variable": { "E-^AAA.4_1_2.H91.Input[-a-zA-Z]+.Name": {
+		"variable": { "E-AAA\\.4_1_2\\.H91\\.Input[-a-zA-Z]+\\.Name": {
 			"issueID": "inputNoText",
 			"quality": 1,
 			"what": "input element has no accessible name"
@@ -6383,7 +6383,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "script-src content attribute blocks a script"
 			},
-			"Discarding unrecognized token .+ from value of attribute role. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
+			"Discarding unrecognized token .+ from value of attribute role\\. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
 				"issueID": "roleBad",
 				"quality": 1,
 				"what": "Invalid role"
@@ -6443,7 +6443,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Attribute has an empty value"
 			},
-			"Potentially bad value .+ for attribute .+ on element .+Typo for .+?.*": {
+			"Potentially bad value .+ for attribute .+ on element .+Typo for .+\\?.*": {
 				"issueID": "attributeValueRisk",
 				"quality": 1,
 				"what": "Attribute value may be a typographical error"
@@ -6698,7 +6698,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Invalid closing tag"
 			},
-			"End tag [a-z]+.": {
+			"End tag [a-z]+\\.": {
 				"issueID": "elementClosure",
 				"quality": 1,
 				"what": "Closing tag of an ineligible element"
@@ -7929,7 +7929,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "script-src content attribute blocks a script"
 			},
-			"Discarding unrecognized token .+ from value of attribute role. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
+			"Discarding unrecognized token .+ from value of attribute role\\. Browsers ignore any token that is not a defined ARIA non-abstract role.*": {
 				"issueID": "roleBad",
 				"quality": 1,
 				"what": "Invalid role"
@@ -7989,7 +7989,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Attribute has an empty value"
 			},
-			"Potentially bad value .+ for attribute .+ on element .+Typo for .+?.*": {
+			"Potentially bad value .+ for attribute .+ on element .+Typo for .+\\?.*": {
 				"issueID": "attributeValueRisk",
 				"quality": 1,
 				"what": "Attribute value may be a typographical error"
@@ -8244,7 +8244,7 @@ const rulesData = {
 				"quality": 1,
 				"what": "Invalid closing tag"
 			},
-			"End tag [a-z]+.": {
+			"End tag [a-z]+\\.": {
 				"issueID": "elementClosure",
 				"quality": 1,
 				"what": "Closing tag of an ineligible element"
@@ -9677,33 +9677,42 @@ const issues = deepFreeze(issuesData);
 const rules = deepFreeze(rulesData);
 const makeIssueRules = (ruleTable, issueTable = issues) => {
 	const errors = [];
-	const checkEntry = (toolID, groupName, ruleID, entry) => {
+	const checkEntry = (engineID, variabilityName, ruleID, entry) => {
 		const { issueID, quality, what } = entry;
-		if (typeof issueID !== "string" || !(issueID in issueTable)) errors.push(`${toolID}.${groupName}.${ruleID} has an invalid issueID (${JSON.stringify(issueID)})`);
-		if (typeof quality !== "number") errors.push(`${toolID}.${groupName}.${ruleID} has a non-numeric quality (${JSON.stringify(quality)})`);
-		if (typeof what !== "string") errors.push(`${toolID}.${groupName}.${ruleID} has a non-string what (${JSON.stringify(what)})`);
+		if (!ruleID.length) errors.push(`${engineID}.${variabilityName} has a rule with an empty ruleID`);
+		if (typeof issueID !== "string" || !issueID.length || !(issueID in issueTable)) errors.push(`${engineID}.${variabilityName}.${ruleID} has an invalid issueID (${JSON.stringify(issueID)})`);
+		if (typeof quality !== "number") errors.push(`${engineID}.${variabilityName}.${ruleID} has a non-numeric quality (${JSON.stringify(quality)})`);
+		if (typeof what !== "string" || !what.length) errors.push(`${engineID}.${variabilityName}.${ruleID} has a non-string or empty what (${JSON.stringify(what)})`);
+		if (variabilityName === "variable") {
+			if (!/[.*+?^${}()|[\]\\]/.test(ruleID)) errors.push(`${engineID}.${variabilityName}.${ruleID} has no regex metacharacters, so it should be an invariant rule`);
+			else try {
+				new RegExp(ruleID);
+			} catch (error) {
+				errors.push(`${engineID}.${variabilityName}.${ruleID} is not a valid regular expression (${error.message})`);
+			}
+		}
 	};
 	const issueRules = {};
-	Object.entries(ruleTable).forEach(([toolID, { invariant, variable }]) => {
+	Object.entries(ruleTable).forEach(([engineID, { invariant, variable }]) => {
 		Object.entries(invariant).forEach(([ruleID, entry]) => {
-			checkEntry(toolID, "invariant", ruleID, entry);
+			checkEntry(engineID, "invariant", ruleID, entry);
 			const { issueID } = entry;
 			issueRules[issueID] ??= {};
-			issueRules[issueID][toolID] ??= {
+			issueRules[issueID][engineID] ??= {
 				invariant: [],
 				variable: []
 			};
-			issueRules[issueID][toolID].invariant.push(ruleID);
+			issueRules[issueID][engineID].invariant.push(ruleID);
 		});
 		Object.entries(variable).forEach(([ruleID, entry]) => {
-			checkEntry(toolID, "variable", ruleID, entry);
+			checkEntry(engineID, "variable", ruleID, entry);
 			const { issueID } = entry;
 			issueRules[issueID] ??= {};
-			issueRules[issueID][toolID] ??= {
+			issueRules[issueID][engineID] ??= {
 				invariant: [],
 				variable: []
 			};
-			issueRules[issueID][toolID].variable.push(ruleID);
+			issueRules[issueID][engineID].variable.push(ruleID);
 		});
 	});
 	if (errors.length) throw new Error(`${errors[0]} (1 of ${errors.length} problems found)`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro-issues",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "A classification of about 1300 rules of 10 rule engines into about 300 issues. The rule engines are those in the ensemble of Testaro, which tests web pages for front-end quality (accessibility, usability, and standards conformance).",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -15,7 +15,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsdown src/index.ts --format cjs,esm --dts",
+    "build": "npm run typecheck && tsdown src/index.ts --format cjs,esm --dts",
+    "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build"
   },
   "keywords": [