Prettier base config and NPM scripts in preparation for CI integration (#2286)

Author: chalin

.prettierignore

@@ -0,0 +1,23 @@
+# Base
+
+/.netlify
+/.vscode
+/content-modules
+/iconography
+/layouts
+package-lock.json
+/public
+/themes
+/tmp
+
+# Temporary while we ramp up use of Prettier
+
+/.github
+/archetypes
+/assets
+/content
+/data
+/resources
+/scripts
+/static
+/templates

CONTRIBUTING.md

@@ -107,7 +107,7 @@ request an enhancement, [create an issue][new-issue].
 ## Submitting a change
 
 Enhancements and fixes to the website are most welcome! Before submitting a
-[pull request][PR] (PR) over the website, run `npm run test` and address any
+[pull request][pr] (PR) over the website, run `npm run test` and address any
 reported issues.
 
 ### Submodule changes
@@ -153,12 +153,14 @@ required.
 [hugo]: https://gohugo.io
 [localhost:8888]: http://localhost:8888
 [netlify]: https://netlify.com
-[new-issue]: https://github.com/open-telemetry/opentelemetry.io/issues/new/choose
+[new-issue]:
+  https://github.com/open-telemetry/opentelemetry.io/issues/new/choose
 [nodejs-rel]: https://nodejs.org/en/about/releases/
 [nodejs-win]:
   https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows
 [nvm]:
   https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
 [nvm-windows]: https://github.com/coreybutler/nvm-windows
 [org]: https://github.com/open-telemetry
-[pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests
+[pr]:
+  https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests

README.md

@@ -47,9 +47,8 @@ If your post will have images or other assets, instead run:
 npx hugo new content/en/blog/2023/short-name-for-post/index.md
 ```
 
-Edit the markdown file at the path you provided in the previous
-command. The file is initialized from the blog-post starter under
-[archetypes](archetypes).
+Edit the markdown file at the path you provided in the previous command. The
+file is initialized from the blog-post starter under [archetypes](archetypes).
 
 Put assets, if any, like images into the folder created.
 

hugo.yaml

@@ -40,7 +40,8 @@ outputs:
   home: [HTML, REDIRECTS, RSS]
 
 params:
-  copyright: 'The OpenTelemetry Authors | Documentation Distributed under CC BY 4.0 | '
+  copyright: >-
+    The OpenTelemetry Authors | Documentation Distributed under CC BY 4.0 |
   tagline: Effective observability requires high-quality telemetry
   sub_tagline: >-
     **OpenTelemetry** makes robust, portable telemetry a built-in feature of
@@ -108,7 +109,7 @@ params:
         url: https://github.com/open-telemetry
         icon: fab fa-github
         desc: Find us on GitHub.
-      - name: 'Slack #opentelemetry'
+      - name: "Slack #opentelemetry"
         url: https://cloud-native.slack.com/archives/CJFCJHG4Q
         icon: fab fa-slack
         desc: >-
@@ -159,7 +160,7 @@ params:
 
   fonts:
     - name: Noto Sans
-      sizes: [300,400,600,700]
+      sizes: [300, 400, 600, 700]
       type: sans_serif
 
 services:

package.json

@@ -35,6 +35,8 @@
     "precheck-links": "npm run build",
     "prepare": "run-s get:submodule _prepare:docsy",
     "preserve:hugo": "npm run _prebuild",
+    "prettier:check-all": "npx prettier --check .",
+    "prettier:no-ignore": "npx prettier --ignore-path ''",
     "preserve": "npm run _prebuild",
     "s": "run-s",
     "schemas:update": "npm run update:submodule content-modules/opentelemetry-specification",