Change 'test cases' to 'examples' as required by ACT Rules Format 1.1 (#2352)

* Changes 'test cases' to 'examples' as required by ACT Rules Format 1.1

* Tests +less obvious occurrences

* Fix const  value typo

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-authored-by: Kathy Eng <[email protected]>

* Update .github/ISSUE_TEMPLATE/ACCESSIBILITY_SUPPORT.md

Co-authored-by: Kathy Eng <[email protected]>

* Update _rules/__tests__/example-has-heading.js

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/design/rule-design.md

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/design/rule-design.md

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/implementations/earl-reports.md

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/implementations/earl-reports.md

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/implementations/examples.md

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/implementations/examples.md

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/implementations/mapping.md

Co-authored-by: Kathy Eng <[email protected]>

* Update pages/implementations/reporting.md

Co-authored-by: Kathy Eng <[email protected]>

* Apply suggestion from @kengdoj

* More missing occurrences

---------

Co-authored-by: Kathy Eng <[email protected]>

Author: daniel-montalvo

.github/ISSUE_TEMPLATE/ACCESSIBILITY_SUPPORT.md

@@ -14,19 +14,19 @@ assignees: ''
 
 - ... List the rules here, link to its acc support section
 
-## Test cases
+## Examples
 
-### Test case 1 ...
+### Example 1 ...
 
-(( Add test case here ))
+(( Add example here ))
 
 ```html
 code snippet here
 ```
 
-[Open this test case]()
+[Open this example]()
 
-(( Add a link to a code pen or other hosted test case. Keep in mind this test case needs to be accessible and persistent. ))
+(( Add a link to a code pen or other hosted example. Keep in mind this example needs to be accessible and persistent. ))
 
 #### Preconditions
 
@@ -39,12 +39,12 @@ Before running the test, check your settings. In many cases default settings are
 
 #### Test instructions
 
-(( Provide instructions on how to test the test case, this should include: ))
+(( Provide instructions on how to test the example, this should include: ))
 
 - Which technologies to use
 - Any setting changes necessary to run the test
 - Any variation in how to operate the different assistive technologies
-- Step by step instructions on how to check the test case
+- Step by step instructions on how to check the example
 - What the expected results are
 
 ### External links

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,8 +9,8 @@ Need for Call for Review:
 << check [Process Document on Call for Review](https://act-rules.github.io/pages/design/process/#call-for-review) >>
 This can be merged with 1 approval << choose reason: editorial changes to website/test code, adding new contributor, other (explain). >>
 This will not require a Call for Review << choose reason(s): editorial changes (including to the applicability, expectation or examples section), changes to assumptions, background, accessibility support, change to website/test code (not rule), other (explain). >>
-This will require a 1 week Call for Review << small changes affecting a small number of test cases, if in doubt do not use this. >>
-This will require a 2 weeks Call for Review << new rule, or substantial changes affecting a large number of test cases, if in doubt, use this. >>
+This will require a 1 week Call for Review << small changes affecting a small number of examples, if in doubt do not use this. >>
+This will require a 2 weeks Call for Review << new rule, or substantial changes affecting a large number of examples, if in doubt, use this. >>
 
 ---
 

.github/scripts/approve-rule.mjs

@@ -24,7 +24,7 @@ if (!argv['skip-clone']) {
 await createOrCheckoutBranch(config, argv.branch);
 await generateApprovedRulePages(config, argv.ruleId);
 await updateRuleVersionsYaml(config, argv.ruleId);
-await approveTestCaseJson(config, argv.ruleId);
+await approveexampleJson(config, argv.ruleId);
 await commitAndPush(config, `Set ${argv.ruleId} to approved`);
 
 async function generateApprovedRulePages({ tmpDir, rulesDir, glossaryDir, testAssetsDir }, ruleId) {
@@ -67,17 +67,17 @@ async function updateRuleVersionsYaml({ tmpDir }, ruleId) {
   console.log(`Added ${ruleId} to rule-versions.yml`);
 }
 
-async function approveTestCaseJson({ tmpDir }, ruleId) {
-  let testCaseCount = 0;
-  const testCaseJsonPath = `${tmpDir}content-assets/wcag-act-rules/testcases.json`;
-  const testCaseJson = JSON.parse(fs.readFileSync(testCaseJsonPath, 'utf8'));
-  testCaseJson.testcases.forEach((testCase, index) => {
-    if (testCase.ruleId === ruleId) {
+async function approveexampleJson({ tmpDir }, ruleId) {
+  let exampleCount = 0;
+  const exampleJsonPath = `${tmpDir}content-assets/wcag-act-rules/examples.json`;
+  const exampleJson = JSON.parse(fs.readFileSync(exampleJsonPath, 'utf8'));
+  exampleJson.examples.forEach((example, index) => {
+    if (example.ruleId === ruleId) {
       // Override rather than update so that `approved` isn't at the bottom
-      testCaseJson.testcases[index] = { ruleId, approved: true, ...testCase }
-      testCaseCount++
+      exampleJson.examples[index] = { ruleId, approved: true, ...example }
+      exampleCount++
     }
   });
-  console.log(`Set ${testCaseCount} test cases of rule ${ruleId} to be approved in testcases.json`);
-  fs.writeFileSync(testCaseJsonPath, JSON.stringify(testCaseJson, null, 2), 'utf8');
+  console.log(`Set ${exampleCount} examples of rule ${ruleId} to be approved in examples.json`);
+  fs.writeFileSync(exampleJsonPath, JSON.stringify(exampleJson, null, 2), 'utf8');
 }

.github/scripts/pr-preview.mjs

@@ -4,7 +4,7 @@ import { config, cloneWcagActRules, commitAndPush } from './commons.mjs'
 
 await cloneWcagActRules(config);
 await generateProposedRulePages(config);
-await generateTestCases(config);
+await generateexamples(config);
 // const commitMessage = (await $`git log -1 --pretty=%B`).stdout;
 // await commitAndPush(config, commitMessage);
 
@@ -18,7 +18,7 @@ async function generateProposedRulePages({ tmpDir, rulesDir, glossaryDir, testAs
   `;
 }
 
-async function generateTestCases({ tmpDir, rulesDir, testAssetsDir }) {
+async function generateexamples({ tmpDir, rulesDir, testAssetsDir }) {
   await $`node ./node_modules/act-tools/dist/cli/build-examples.js \
     --rulesDir "${rulesDir}" \
     --testAssetsDir "${testAssetsDir}" \

.github/scripts/wai-build.mjs

@@ -4,7 +4,7 @@ import { config, cloneWcagActRules, commitAndPush } from './commons.mjs'
 
 await cloneWcagActRules(config);
 await generateProposedRulePages(config);
-await generateTestCases(config);
+await generateexamples(config);
 const commitMessage = (await $`git log -1 --pretty=%B`).stdout;
 await commitAndPush(config, commitMessage);
 
@@ -18,7 +18,7 @@ async function generateProposedRulePages({ tmpDir, rulesDir, glossaryDir, testAs
   `;
 }
 
-async function generateTestCases({ tmpDir, rulesDir, testAssetsDir }) {
+async function generateexamples({ tmpDir, rulesDir, testAssetsDir }) {
   await $`node ./node_modules/act-tools/dist/cli/build-examples.js \
     --rulesDir "${rulesDir}" \
     --testAssetsDir "${testAssetsDir}" \

__deprecated__/pages/contribute/rule-feedback.md

@@ -41,7 +41,7 @@ To start giving feedback and doing reviews for draft rules:
 
 We also welcome any feedback and suggestions for changes to already published rules. The published rules should be as precise as possible, limiting the number of potential false positives and false negatives. For this, it is important to draw on as many tool and methodology implementations and expert opinions as possible.
 
-Feedback and corrections for existing rules can target any of the sections of the rule itself (Applicability, Expectations, Accessibility Support, etc.), as well as the test cases, for example to expand the edge case coverage.
+Feedback and corrections for existing rules can target any of the sections of the rule itself (Applicability, Expectations, Accessibility Support, etc.), as well as the examples, for instance to expand the edge case coverage.
 
 You have several options for correcting existing rules:
 

__tests__/spelling-ignore.yml

@@ -252,7 +252,7 @@
 - 4E00–9FFF
 
 # JSON attributes/ metadata/ methods
-- testcases
+- examples
 - ruleId
 - ruleName
 - rulePage

_rules/__tests__/example-has-heading.js

@@ -0,0 +1,29 @@
+const describeRule = require('../../test-utils/describe-rule')
+const getMarkdownAstNodesOfType = require('../../utils/get-markdown-ast-nodes-of-type')
+
+describeRule('example has heading', ({ filename, markdownAST }) => {
+	/**
+	 * get all headings of examples (eg: #### Failed Example 1)
+	 */
+	const exampleHeadings = getMarkdownAstNodesOfType(markdownAST, 'heading')
+		.filter(({ depth, children }) => {
+			return depth === 4 && children && children.length > 0
+		})
+		.map(({ children }) => {
+			const [textNode] = children
+			return textNode.value
+		})
+
+	/**
+	 * get code blocks in markdown body
+	 */
+	const exampleCodeSnippets = getMarkdownAstNodesOfType(markdownAST, 'code')
+
+	/**
+	 * Check if filename has `id` as a part of the name
+	 */
+	test('each example has a heading', () => {
+		const msg = `Not all examples have headings in ${filename}.`
+		expect(exampleHeadings.length, msg).toBe(exampleCodeSnippets.length)
+	})
+})

_rules/__tests__/testcase-html-hint.js _rules/__tests__/example-html-hint.js_rules/__tests__/testcase-html-hint.js renamed to _rules/__tests__/example-html-hint.js

@@ -30,7 +30,7 @@ const htmlHintRules = {
 	'empty-tag-not-self-closed': false,
 }
 
-describeRule('testcases', ruleData => {
+describeRule('examples', ruleData => {
 	const { frontmatter, body } = ruleData
 	const { id, name, htmlHintIgnore = [] } = frontmatter
 

_rules/__tests__/headings.js

@@ -58,7 +58,7 @@ describeRule('headings', ruleData => {
 	/**
 	 * Check for `required` `h2` headings
 	 */
-	const requiredH2 = [`Applicability`, `Background`, `Test Cases`]
+	const requiredH2 = [`Applicability`, `Background`, `Examples`]
 	const h2Headings = getHeadingOfDepth(headings, 2)
 	test.each(requiredH2)('has required `h2` - `%s`', heading => {
 		expect(h2Headings).toContain(heading)