Merge pull request 'add Vale for prose linting' (#1370) from fricklerhandwerk/clan-core:add-vale into main

Reviewed-on: #1370

README.md

@@ -1,6 +1,6 @@
-# Clan Core Repository
+# Clan core repository
 
-Welcome to the Clan Core Repository, the heart of the [clan.lol](https://clan.lol/) project! This monorepo is the foundation of Clan, a revolutionary open-source project aimed at restoring fun, freedom, and functionality to computing. Here, you'll find all the essential packages, NixOS modules, CLI tools, and tests needed to contribute to and work with the Clan project. Clan leverages the Nix system to ensure reliability, security, and seamless management of digital environments, putting the power back into the hands of users.
+Welcome to the Clan core repository, the heart of the [clan.lol](https://clan.lol/) project! This monorepo is the foundation of Clan, a revolutionary open-source project aimed at restoring fun, freedom, and functionality to computing. Here, you'll find all the essential packages, NixOS modules, CLI tools, and tests needed to contribute to and work with the Clan project. Clan leverages the Nix system to ensure reliability, security, and seamless management of digital environments, putting the power back into the hands of users.
 
 ## Why Clan?
 
@@ -14,13 +14,13 @@ Our mission is simple: to democratize computing by providing tools that empower
 - **Robust Backup Management:** Long-term, self-hosted data preservation.
 - **Intuitive Secret Management:** Simplified encryption and password management processes.
 
-## Getting Started with Clan
+## Getting started with Clan
 
 If you're new to Clan and eager to dive in, start with our quickstart guide and explore the core functionalities that Clan offers:
 
 - **Quickstart Guide**: Check out [getting started](https://docs.clan.lol/#starting-with-a-new-clan-project)<!-- [docs/site/index.md](docs/site/index.md) --> to get up and running with Clan in no time.
 
-### Managing Secrets
+### Managing secrets
 
 In the Clan ecosystem, security is paramount. Learn how to handle secrets effectively:
 
@@ -32,11 +32,11 @@ The Clan project thrives on community contributions. We welcome everyone to cont
 
 - **Contribution Guidelines**: Make a meaningful impact by following the steps in [contributing](https://docs.clan.lol/contributing/contributing/)<!-- [contributing.md](docs/CONTRIBUTING.md) -->.
 
-## Join the Revolution
+## Join the revolution
 
 Clan is more than a tool; it's a movement towards a better digital future. By contributing to the Clan project, you're part of changing technology for the better, together.
 
-### Community and Support
+### Community and support
 
 Connect with us and the Clan community for support and discussion:
 

formatter.nix

@@ -45,5 +45,53 @@
         ];
         includes = [ "*.py" ];
       };
+      treefmt.settings.formatter.vale =
+        with pkgs;
+        let
+          vocab = "cLAN";
+          style = "Docs";
+          config = writeText "vale.ini" ''
+            StylesPath = ${styles}
+            Vocab = ${vocab}
+
+            [*.md]
+            BasedOnStyles = Vale, ${style}
+            Vale.Terms = No
+          '';
+          styles = symlinkJoin {
+            name = "vale-style";
+            paths = [
+              accept
+              headings
+            ];
+          };
+          accept = writeTextDir "config/vocabularies/${vocab}/accept.txt" ''
+            Nix
+            NixOS
+            Nixpkgs
+            clan.lol
+            Clan
+            monorepo
+          '';
+          headings = writeTextDir "${style}/headings.yml" ''
+            extends: capitalization
+            message: "'%s' should be in sentence case"
+            level: error
+            scope: heading
+            # $title, $sentence, $lower, $upper, or a pattern.
+            match: $sentence
+          '';
+        in
+        {
+          command = "${vale}/bin/vale";
+          options = [ "--config=${config}" ];
+          includes = [ "*.md" ];
+          # TODO: too much at once, fix piecemeal
+          excludes = [
+            "docs/*"
+            "clanModules/*"
+            "pkgs/*"
+          ];
+        };
     };
 }