Infrastructure: Run Prettier on commit of all files (#2614)

nschonni · web-flow · commit 0896c7a403fb · 2023-02-14T10:21:28.000-05:00
* Infrastructure: Run Prettier on commit of all files

* Update .prettierignore
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,5 +1,9 @@
 {
-  "extends": ["eslint:recommended", "plugin:jsdoc/recommended", "plugin:prettier/recommended"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:jsdoc/recommended",
+    "plugin:prettier/recommended"
+  ],
   "env": {
     "browser": true,
     "es6": true
@@ -50,26 +54,22 @@
       }
     },
     {
-      "files": [
-        "**/*.html"
-      ],
-      "plugins":[
-        "html"
-      ],
+      "files": ["**/*.html"],
+      "plugins": ["html"],
       "globals": {
         "sourceCode": true
       },
       "rules": {
         "strict": 0,
-        "no-unused-vars":  ["error", { "varsIgnorePattern": "SkipToConfig" }]
+        "no-unused-vars": ["error", { "varsIgnorePattern": "SkipToConfig" }]
       }
     },
     {
-      "files": [ "content/shared/js/app.js" ],
+      "files": ["content/shared/js/app.js"],
       "parserOptions": { "ecmaVersion": 11 }
     },
     {
-      "files": [ "content/shared/js/specLinks.mjs" ],
+      "files": ["content/shared/js/specLinks.mjs"],
       "parserOptions": { "sourceType": "module" }
     }
   ]
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,18 +1,18 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: monthly
-    time: "10:00"
-  open-pull-requests-limit: 99
-  commit-message:
-    prefix: "Infrastructure"
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "10:00"
-  open-pull-requests-limit: 99
-  commit-message:
-    prefix: "Infrastructure"
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "10:00"
+    open-pull-requests-limit: 99
+    commit-message:
+      prefix: "Infrastructure"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "10:00"
+    open-pull-requests-limit: 99
+    commit-message:
+      prefix: "Infrastructure"
diff --git a/.github/workflows/coverage-report.yml b/.github/workflows/coverage-report.yml
@@ -3,9 +3,9 @@ name: Regression Tests Coverage Report
 on:
   pull_request_target:
     paths:
-    - "content/**/examples/**"
-    - "test/**"
-    - "!content/landmarks/examples/**"
+      - "content/**/examples/**"
+      - "test/**"
+      - "!content/landmarks/examples/**"
 
 permissions:
   contents: read
diff --git a/.prettierignore b/.prettierignore
@@ -4,3 +4,12 @@ common
 # Vendored theme files
 bootstrap.css
 bootstrap-theme.css
+
+# Ignore HTML formatting as the diffs are not great
+*.html
+
+# Ignore third party JavaScript
+**/*.min.js
+content/patterns/landmarks/examples/js/visua11y.js
+content/shared/js/highlight.pack.js
+content/shared/js/skipto.js
diff --git a/.prettierrc b/.prettierrc
@@ -6,6 +6,12 @@
       "options": {
         "singleQuote": false
       }
+    },
+    {
+      "files": ["**/*.yml"],
+      "options": {
+        "singleQuote": false
+      }
     }
   ]
 }
diff --git a/.stylelintrc b/.stylelintrc
@@ -4,18 +4,14 @@
     "media-feature-name-no-unknown": [
       true,
       {
-        "ignoreMediaFeatureNames": [
-          "forced-colors"
-        ]
-      },
+        "ignoreMediaFeatureNames": ["forced-colors"]
+      }
     ],
     "font-family-no-missing-generic-family-keyword": [
       true,
       {
-        "ignoreFontFamilies": [
-          "Font Awesome 5 Free"
-        ]
-      },
+        "ignoreFontFamilies": ["Font Awesome 5 Free"]
+      }
     ],
     "selector-class-pattern": null,
     "selector-id-pattern": null
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,5 +1,3 @@
 {
-    "recommendations": [
-        "streetsidesoftware.code-spell-checker"
-    ]
+  "recommendations": ["streetsidesoftware.code-spell-checker"]
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,7 +2,7 @@ Contributions to this repository are intended to become part of Technical Report
 [Software and Document License](https://www.w3.org/Consortium/Legal/copyright-software). To make substantive contributions to documents, you must either participate
 in the relevant W3C Working Group or transfer copyright to W3C.
 
-If you are not the sole contributor to a contribution (pull request), please identify all 
+If you are not the sole contributor to a contribution (pull request), please identify all
 contributors in the pull request comment.
 
 To add a contributor (other than yourself, that's automatic), mark them one per line as follows:
@@ -17,5 +17,5 @@ If you added a contributor by mistake, you can remove them in a comment with:
 -@github_username
 ```
 
-If you are making a pull request on behalf of someone else but you had no part in designing the 
+If you are making a pull request on behalf of someone else but you had no part in designing the
 feature, you can remove yourself with the above syntax.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,4 +1,3 @@
 All documents in this Repository are licensed by contributors
-under the 
+under the
 [W3C Software and Document License](https://www.w3.org/Consortium/Legal/copyright-software).
-
diff --git a/README.md b/README.md
@@ -2,17 +2,17 @@
 
 This repository maintains the WAI-ARIA Authoring Practices Guide (APG).
 
-* Published at: [w3.org/wai/aria/apg](https://www.w3.org/wai/aria/apg/)
-* Developed by the [Authoring Practices Task Force](https://www.w3.org/WAI/ARIA/task-forces/practices/) of the [ARIA Working Group](http://www.w3.org/WAI/ARIA/).
-* Staff contact: [Michael Cooper](http://www.w3.org/People/cooper/).
+- Published at: [w3.org/wai/aria/apg](https://www.w3.org/wai/aria/apg/)
+- Developed by the [Authoring Practices Task Force](https://www.w3.org/WAI/ARIA/task-forces/practices/) of the [ARIA Working Group](http://www.w3.org/WAI/ARIA/).
+- Staff contact: [Michael Cooper](http://www.w3.org/People/cooper/).
 
 Please do not provide commit access to this repository without coordination.
 
 ## How the work is organized
 
-* Work is planned and prioritized in our [milestones](https://github.com/w3c/aria-practices/milestones?direction=asc&sort=due_date&state=open). Each milestone corresponds to a working draft or release published to w3.org.
-* Work is organized by topic in our [projects](https://github.com/w3c/aria-practices/projects). Each project corresponds to a type of design pattern or section of guidance.
-* The [scope of work and roadmap](https://github.com/w3c/aria-practices/wiki/Scope) are described in the project wiki.
+- Work is planned and prioritized in our [milestones](https://github.com/w3c/aria-practices/milestones?direction=asc&sort=due_date&state=open). Each milestone corresponds to a working draft or release published to w3.org.
+- Work is organized by topic in our [projects](https://github.com/w3c/aria-practices/projects). Each project corresponds to a type of design pattern or section of guidance.
+- The [scope of work and roadmap](https://github.com/w3c/aria-practices/wiki/Scope) are described in the project wiki.
 
 ## Contributing
 
@@ -109,9 +109,9 @@ contains additional useful editorial guidance.
 
 ## ARIA Roles, Properties and States Referenced in Guidance and Examples(Also known as APG Coverage Report)
 
-[APG Coverage Report](https://raw.githack.com/w3c/aria-practices/main/coverage/index.html) includes information on number of guidance and example references in the WAI-ARIA Authoring Practices for each ARIA role, property and state. 
+[APG Coverage Report](https://raw.githack.com/w3c/aria-practices/main/coverage/index.html) includes information on number of guidance and example references in the WAI-ARIA Authoring Practices for each ARIA role, property and state.
 
-As of January 11, 2022, APG has examples of 
+As of January 11, 2022, APG has examples of
 
 1. CSV Files of Role, Properties and States Coverage
 2. Roles with no Guidance or Examples (29)
diff --git a/cspell.json b/cspell.json
diff --git a/package.json b/package.json
diff --git a/w3c.json b/w3c.json

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`{`
`2`		`- "extends": ["eslint:recommended", "plugin:jsdoc/recommended", "plugin:prettier/recommended"],`
	`2`	`+ "extends": [`
	`3`	`+ "eslint:recommended",`
	`4`	`+ "plugin:jsdoc/recommended",`
	`5`	`+ "plugin:prettier/recommended"`
	`6`	`+ ],`
`3`	`7`	`"env": {`
`4`	`8`	`"browser": true,`
`5`	`9`	`"es6": true`
`@@ -50,26 +54,22 @@`
`50`	`54`	`}`
`51`	`55`	`},`
`52`	`56`	`{`
`53`		`- "files": [`
`54`		`- "*/.html"`
`55`		`- ],`
`56`		`- "plugins":[`
`57`		`- "html"`
`58`		`- ],`
	`57`	`+ "files": ["*/.html"],`
	`58`	`+ "plugins": ["html"],`
`59`	`59`	`"globals": {`
`60`	`60`	`"sourceCode": true`
`61`	`61`	`},`
`62`	`62`	`"rules": {`
`63`	`63`	`"strict": 0,`
`64`		`- "no-unused-vars": ["error", { "varsIgnorePattern": "SkipToConfig" }]`
	`64`	`+ "no-unused-vars": ["error", { "varsIgnorePattern": "SkipToConfig" }]`
`65`	`65`	`}`
`66`	`66`	`},`
`67`	`67`	`{`
`68`		`- "files": [ "content/shared/js/app.js" ],`
	`68`	`+ "files": ["content/shared/js/app.js"],`
`69`	`69`	`"parserOptions": { "ecmaVersion": 11 }`
`70`	`70`	`},`
`71`	`71`	`{`
`72`		`- "files": [ "content/shared/js/specLinks.mjs" ],`
	`72`	`+ "files": ["content/shared/js/specLinks.mjs"],`
`73`	`73`	`"parserOptions": { "sourceType": "module" }`
`74`	`74`	`}`
`75`	`75`	`]`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,12 @@`
`6`	`6`	`"options": {`
`7`	`7`	`"singleQuote": false`
`8`	`8`	`}`
	`9`	`+ },`
	`10`	`+ {`
	`11`	`+ "files": ["*/.yml"],`
	`12`	`+ "options": {`
	`13`	`+ "singleQuote": false`
	`14`	`+ }`
`9`	`15`	`}`
`10`	`16`	`]`
`11`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`	`1`	`{`
`2`		`- "recommendations": [`
`3`		`- "streetsidesoftware.code-spell-checker"`
`4`		`- ]`
	`2`	`+ "recommendations": ["streetsidesoftware.code-spell-checker"]`
`5`	`3`	`}`