chore: lint staged files before commit

vaibhavkumar-sf · Jul 7, 2020 · 2de520c · 2de520c
1 parent 4bf77c8
commit 2de520c
Show file tree

Hide file tree

Showing 4 changed files with 574 additions and 0 deletions.
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,9 @@
+{
+  "*.{ts,js}": [
+    "node packages/build/bin/run-prettier --write",
+    "node packages/build/bin/run-eslint --fix --report-unused-disable-directives --cache"
+  ],
+  "*.{md}": [
+    "node packages/build/bin/run-prettier --write"
+  ]
+}
diff --git a/docs/site/DEVELOPING.md b/docs/site/DEVELOPING.md
@@ -229,6 +229,9 @@ npm script `lint:fix`.
 npm run lint:fix
 ```
 
+Files staged for commit are linted automatically. If necessary, pre-commit
+linting can be bypassed by setting the environment variable `LINT_STAGED=0`.
+
 ## Working with dependencies
 
 We use npm's