feat: add pre-commit-hooks for spell checking, markdown linting, etc.

Author: ryan4yin

.github/CONTRIBUTING.md

@@ -33,7 +33,7 @@ When creating a pull request, please heed the following:
 
 You will need [nix](https://github.com/NixOS/nix) & with flakes enabled.
 
-After cloning the repo, run enter an environment with pnpm and vitepress installed first:
+After cloning the repo, run enter an environment with pnpm, vitepress, spell checker and markdown linter installed first:
 
 ```sh
 $ nix develop
@@ -46,4 +46,10 @@ Boot up the documentation site locally, with live reloading of the source code:
 $ pnpm run docs:dev
 ```
 
+If you made a lot of changes, run the following command to check for typos before submitting a pull request:
+
+```sh
+$ typos -w
+```
+
 After executing the above command, visit <http://localhost:5173> and try modifying the source code. You'll get live update.

.gitignore

@@ -18,3 +18,5 @@ playground-temp
 temp
 TODOs.md
 .eslintcache
+.direnv/
+.pre-commit-config.yaml

docs/zh/preface.md

@@ -62,7 +62,8 @@ Nixpkgs 源码等各种资料中提取出我需要的信息，同时还要忽略
 我写这本小书的原因只是因为没有人为当时还是新手的我做这件事，如上所述，社区的文档太乱了，所以我选择自己动手，丰衣足食。
 即使我知道我可能会犯错，但这总比什么都不做要好得多。
 
-我希望这本书能帮助更多的人，让他们能够体验到 NixOS 的乐趣。希望你们喜欢它！
+ 我希望这本书能帮助更多的人，让他们能够体验到 NixOS 的乐趣。希望你们喜欢它！
+
 
 ## 本书的特点
 

flake.lock

@@ -4,12 +4,14 @@
   inputs = {
     nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.11";
     flake-utils.url = "github:numtide/flake-utils";
+    pre-commit-hooks.url = "github:cachix/pre-commit-hooks.nix";
   };
 
   outputs = {
     self,
     nixpkgs,
     flake-utils,
+    pre-commit-hooks,
   }:
     flake-utils.lib.eachDefaultSystem (system: let
       overlays = [
@@ -21,13 +23,39 @@
       ];
       pkgs = import nixpkgs {inherit overlays system;};
       pkgs_chromium = import nixpkgs {inherit system;};
-      packages = with pkgs; [node2nix nodejs pnpm yarn git];
+      packages = with pkgs; [
+        node2nix
+        nodejs
+        pnpm
+        yarn
+
+        git
+        typos
+        alejandra
+      ];
     in {
+      checks = {
+        pre-commit-check = pre-commit-hooks.lib.${system}.run {
+          src = ./.;
+          hooks = {
+            typos.enable = true; # Source code spell checker
+            alejandra.enable = true; # Nix linter
+          };
+          settings = {
+            typos = {
+              write = true; # Automatically fix typos
+              ignored-words = [];
+            };
+          };
+        };
+      };
+
       devShells.default = pkgs.mkShell {
         inherit packages;
 
         shellHook = ''
           echo "node `${pkgs.nodejs}/bin/node --version`"
+          ${self.checks.${system}.pre-commit-check.shellHook}
         '';
       };