lint: add lefthook, prettier, typos (memfault#481)

Install from npm, because it's simpler, so use lefthook as the
pre-commit runner (`yarn install` automatically installs the hooks,
which is somewhat nice too).

I removed the reference to the `grammarly` vscode extension, since it's
no longer available in the marketplace and the github repo is archived.

Update to yarn 3 to support modern lefthook plugin.

---------

Co-authored-by: Gillian Minnehan <gillian@memfault.com>

Author: noahp

.gitignore

@@ -8,3 +8,12 @@ _site/
 /vendor
 /example/*/build
 /.venv
+/node_modules
+
+# Yarn 2
+.yarn/*
+!.yarn/releases
+!.yarn/plugins
+!.yarn/sdks
+!.yarn/versions
+.pnp.*

.vscode/settings.json

@@ -1,13 +1,7 @@
 {
-  "grammarly.files.include": [
-    "**/readme.md",
-    "**/README.md",
-    "**/*.txt",
-    "**/*.md"
-  ],
-  "grammarly.config.documentDialect": "american",
-  "grammarly.config.suggestions.OxfordComma": true,
+  "editor.formatOnSave": true,
   "[markdown]": {
-    "editor.formatOnSave": true
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
   }
 }

.yarn/releases/yarn-3.6.3.cjs

@@ -0,0 +1,2 @@
+yarnPath: .yarn/releases/yarn-3.6.3.cjs
+nodeLinker: node-modules

.yarnrc.yml

@@ -0,0 +1,12 @@
+# See config documentation here:
+# https://github.com/crate-ci/typos/blob/master/docs/reference.md
+[default.extend-words]
+
+[default]
+# extend-ignore-re list operates on sequences, not identifiers, so we can
+# have very targeted ignores
+extend-ignore-re = []
+
+[files]
+# list of files to exclude
+extend-exclude = []

_typos.toml

@@ -0,0 +1,16 @@
+# Lefthook configuration:
+#
+#   Refer for explanation to following link:
+#   https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md
+#
+
+pre-commit:
+  parallel: true
+  commands:
+    prettier:
+      glob: "*.md"
+      run: yarn prettier --write --prose-wrap=always {staged_files}
+      stage_fixed: true
+    typos:
+      glob: "*.md"
+      run: yarn typos --config _typos.toml {staged_files}

lefthook.yml

@@ -0,0 +1,15 @@
+{
+  "scripts": {
+    "lint:prettier": "prettier --check _posts _drafts",
+    "lint:typos": "typos _posts _drafts",
+    "lint:prettier:fix": "prettier --write _posts _drafts"
+  },
+  "dependencies": {
+    "lefthook": "^1.6.16",
+    "prettier": "^3.3.2"
+  },
+  "devDependencies": {
+    "typos-rs-npm": "dalisoft/typos-rs-npm"
+  },
+  "packageManager": "yarn@3.6.3"
+}

package.json

@@ -11,17 +11,22 @@ Interrupt is a community for embedded software makers and professionals alike.
 
 Interrupt welcomes submissions on embedded software topics.
 
-Prior to getting in touch, you should get yourself acquainted with our [Code of Conduct](https://interrupt.memfault.com/code-of-conduct).
+Prior to getting in touch, you should get yourself acquainted with our
+[Code of Conduct](https://interrupt.memfault.com/code-of-conduct).
 
-To submit your content, either email us at interrupt@memfault.com, or open a pull request!
+To submit your content, either email us at interrupt@memfault.com, or open a
+pull request!
 
-See [Contributing](https://interrupt.memfault.com/contributing) for more information.
+See [Contributing](https://interrupt.memfault.com/contributing) for more
+information.
 
 ## Running
 
 ### Docker (Recommended)
 
-Follow the instructions in the [Install Docker Engine](https://docs.docker.com/engine/install/) according to your operating system.
+Follow the instructions in the
+[Install Docker Engine](https://docs.docker.com/engine/install/) according to
+your operating system.
 
 Clone the repo, run in docker:
 
@@ -40,6 +45,9 @@ You'll need:
 - Python 3.8 or later
 - Ruby 3.2.2
 
+Optionally, to run the linters, you'll need `yarn` (easy way is via
+[`volta`](https://volta.sh/)).
+
 #### Install Dependencies
 
 Clone the repo and install Python dependencies:
@@ -56,9 +64,9 @@ $ pip install -r requirements.txt
 
 The virtual environment can be deactivated with `deactivate`.
 
-We highly recommend setting up a version manager for Ruby, such as
-`rbenv`. Follow the instructions [here](https://github.com/rbenv/rbenv) to set it
-up for your operating system and install the right version of Ruby.
+We highly recommend setting up a version manager for Ruby, such as `rbenv`.
+Follow the instructions [here](https://github.com/rbenv/rbenv) to set it up for
+your operating system and install the right version of Ruby.
 
 Install Ruby dependencies:
 
@@ -68,17 +76,26 @@ $ ruby -v
 $ bundle install
 ```
 
+Install `yarn` dependencies (this also installs the git hooks):
+
+```bash
+$ yarn install
+```
+
 #### Launch
 
-Serve with the following command, which will also open up the site in your browser:
+Serve with the following command, which will also open up the site in your
+browser:
 
 ```bash
 $ bundle exec jekyll serve --drafts --livereload --open-url --future
 ```
 
 ## Acknowledgements
 
-Interrupt is based on the Emerald theme by [Jacopo Rabolini](https://www.jacoporabolini.com/). Emerald is available on [Github](https://github.com/KingFelix/emerald).
+Interrupt is based on the Emerald theme by
+[Jacopo Rabolini](https://www.jacoporabolini.com/). Emerald is available on
+[Github](https://github.com/KingFelix/emerald).
 
 ---
 

readme.md

@@ -0,0 +1,163 @@
+# This file is generated by running "yarn install" inside your project.
+# Manual changes might be lost - proceed with caution!
+
+__metadata:
+  version: 6
+  cacheKey: 8
+
+"binary2npm@https://github.com/dalisoft/binary2npm#v0.4.4":
+  version: 0.4.3
+  resolution: "binary2npm@https://github.com/dalisoft/binary2npm.git#commit=ee4e0c76854e80728b4112a86d05cf742e03f8d3"
+  dependencies:
+    detect-libc: ^2.0.3
+  checksum: a18a88820339bd10c66fe2c369c1ad91bf5b4058adaf0d7197486829b39571823f7fc400850327539493b150c6daf5dc4c20bf5803f7bc5eb1c728a4f9e92b72
+  languageName: node
+  linkType: hard
+
+"detect-libc@npm:^2.0.3":
+  version: 2.1.2
+  resolution: "detect-libc@npm:2.1.2"
+  checksum: 471740d52365084c4b2ae359e507b863f2b1d79b08a92835ebdf701918e08fc9cfba175b3db28483ca33b155e1311a91d69dc42c6d192b476f41a9e1f094ce6a
+  languageName: node
+  linkType: hard
+
+"lefthook-darwin-arm64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-darwin-arm64@npm:1.13.6"
+  conditions: os=darwin & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-darwin-x64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-darwin-x64@npm:1.13.6"
+  conditions: os=darwin & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-freebsd-arm64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-freebsd-arm64@npm:1.13.6"
+  conditions: os=freebsd & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-freebsd-x64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-freebsd-x64@npm:1.13.6"
+  conditions: os=freebsd & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-linux-arm64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-linux-arm64@npm:1.13.6"
+  conditions: os=linux & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-linux-x64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-linux-x64@npm:1.13.6"
+  conditions: os=linux & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-openbsd-arm64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-openbsd-arm64@npm:1.13.6"
+  conditions: os=openbsd & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-openbsd-x64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-openbsd-x64@npm:1.13.6"
+  conditions: os=openbsd & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook-windows-arm64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-windows-arm64@npm:1.13.6"
+  conditions: os=win32 & cpu=arm64
+  languageName: node
+  linkType: hard
+
+"lefthook-windows-x64@npm:1.13.6":
+  version: 1.13.6
+  resolution: "lefthook-windows-x64@npm:1.13.6"
+  conditions: os=win32 & cpu=x64
+  languageName: node
+  linkType: hard
+
+"lefthook@npm:^1.6.16":
+  version: 1.13.6
+  resolution: "lefthook@npm:1.13.6"
+  dependencies:
+    lefthook-darwin-arm64: 1.13.6
+    lefthook-darwin-x64: 1.13.6
+    lefthook-freebsd-arm64: 1.13.6
+    lefthook-freebsd-x64: 1.13.6
+    lefthook-linux-arm64: 1.13.6
+    lefthook-linux-x64: 1.13.6
+    lefthook-openbsd-arm64: 1.13.6
+    lefthook-openbsd-x64: 1.13.6
+    lefthook-windows-arm64: 1.13.6
+    lefthook-windows-x64: 1.13.6
+  dependenciesMeta:
+    lefthook-darwin-arm64:
+      optional: true
+    lefthook-darwin-x64:
+      optional: true
+    lefthook-freebsd-arm64:
+      optional: true
+    lefthook-freebsd-x64:
+      optional: true
+    lefthook-linux-arm64:
+      optional: true
+    lefthook-linux-x64:
+      optional: true
+    lefthook-openbsd-arm64:
+      optional: true
+    lefthook-openbsd-x64:
+      optional: true
+    lefthook-windows-arm64:
+      optional: true
+    lefthook-windows-x64:
+      optional: true
+  bin:
+    lefthook: bin/index.js
+  checksum: 3f84a085285e58026774228a8d84dbb812e1e4556e1766a603bf824ca73ae2fd60733b09bac44e3b8846054dcbc34a950b16c1e43f66538e2de2dcf6138237bb
+  languageName: node
+  linkType: hard
+
+"prettier@npm:^3.3.2":
+  version: 3.7.4
+  resolution: "prettier@npm:3.7.4"
+  bin:
+    prettier: bin/prettier.cjs
+  checksum: 955e37e87b1151ca3b3282463f5295f4c415821884791df152ff66e6eb1c5257115153cccba61b13962546100dd00ae45670ff27077dcab04c977d84036eaf80
+  languageName: node
+  linkType: hard
+
+"root-workspace-0b6124@workspace:.":
+  version: 0.0.0-use.local
+  resolution: "root-workspace-0b6124@workspace:."
+  dependencies:
+    lefthook: ^1.6.16
+    prettier: ^3.3.2
+    typos-rs-npm: dalisoft/typos-rs-npm
+  languageName: unknown
+  linkType: soft
+
+typos-rs-npm@dalisoft/typos-rs-npm:
+  version: 1.34.0
+  resolution: "typos-rs-npm@https://github.com/dalisoft/typos-rs-npm.git#commit=834679ffc47249d4d37da4228697e7d6baa60675"
+  dependencies:
+    binary2npm: "https://github.com/dalisoft/binary2npm#v0.4.4"
+  bin:
+    typos: ./typos
+  checksum: f0f1ad27623982f426c3c7f8514992f27f690a8e44028df82f5cf888d2f785346a47e65daffa11b832eb2195c82f69bba11ae0ade432af3c217b5b78884fa974
+  languageName: node
+  linkType: hard