Add editorial checks through Vale (#12)

* add vale config

* update existing content based on vale lint checks

* linting

* remove alex from npm deps

* update workflow

* add installation step

* Update poetry.lock

* sync vale before running it in pre-commit

Co-Authored-By: Faisal Alquaddoomi <faisal.alquaddoomi@cuanschutz.edu>

* lint file

---------

Co-authored-by: Faisal Alquaddoomi <faisal.alquaddoomi@cuanschutz.edu>

.github/workflows/pre-commit-checks.yml

@@ -15,6 +15,7 @@ jobs:
       - uses: actions/checkout@v4
       - name: Install python env
         uses: ./.github/actions/install-python-env
-      - name: Install node env
-        uses: ./.github/actions/install-node-env
+      - name: Install vale dependencies
+        run: |
+          poetry run vale sync
       - uses: pre-commit/action@v3.0.1

.gitignore

@@ -297,3 +297,6 @@ dist
 # almanac-specific ignores
 
 /src/almanac/_build
+
+# for ignoring vale package installs
+/styles

.pre-commit-config.yaml

@@ -58,17 +58,11 @@ repos:
       - id: actionlint-docker
   - repo: local
     hooks:
-      - id: alex.js
-        name: alex.js language check
-        entry: npx alex
+      - id: vale.sh
+        name: vale.sh writing checks
+        entry: poetry run poe vale-checks
         language: system
-        pass_filenames: true
-        exclude: |
-          (?x)^(
-              .*\.lock |
-              .pre-commit-config.yaml |
-              src/almanac/_config.yml
-          )$
+        pass_filenames: false
       - id: cffconvert
         name: cffconvert check for citation.cff formatting
         entry: poetry run cffconvert --validate

.vale.ini

@@ -0,0 +1,13 @@
+# generated from https://vale.sh/generator/
+StylesPath = styles
+
+MinAlertLevel = warning
+
+Vocab = almanac
+
+Packages = proselint, write-good, alex
+
+[*.{md}]
+BasedOnStyles = Vale, proselint, write-good, alex
+
+write-good.TooWordy = NO