WIP: feat: add vale

.github/workflows/tests.yml

@@ -7,6 +7,15 @@ on:
         branches: [main]
 
 jobs:
+    vale:
+      name: runner / vale
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v3
+        - uses: errata-ai/vale-action@reviewdog
+          with:
+            files: "**/*.md"
+            reporter: github-pr-check
     build:
         runs-on: ubuntu-latest
         steps:

.vale.ini

@@ -0,0 +1,18 @@
+StylesPath=".vale/styles"
+
+Vocab = Base, Appwrite
+
+MinAlertLevel = suggestion
+
+# Ignore text in code blocks and tables
+IgnoredScopes = code, tt, a
+SkippedScopes = script, style, pre, figure
+
+[formats]
+markdoc = md
+
+[*.md]
+BasedOnStyles = Vale, appwrite
+
+# Ignore text inside markdoc components
+BlockIgnores = {%.*%}

.vale/styles/Vocab/Appwrite/accept.txt

@@ -0,0 +1,10 @@
+Appwrite
+Appwrite Realtime
+Appwrite Cloud
+Appwrite Console
+Backend as a Service
+Console
+Realtime
+Eldad
+Fux
+Christy

.vale/styles/Vocab/Base/accept.txt

@@ -0,0 +1,80 @@
+Hacktoberfest
+Bitwarden
+Twilio
+Instacart
+Trustpilot
+Gradle
+Authy
+Supabase
+Bcrypt
+Scrypt
+Zendesk
+Deno
+Excali
+Vue
+React
+Svelte
+SvelteKit
+Vite
+Datadog
+Markdoc
+runtime
+SDK
+REST
+Rest
+rest
+SMS
+GraphQL
+GET
+Get
+get
+POST
+Post
+post
+PUT
+Put
+put
+PATCH
+Patch
+patch
+DELETE
+Delete
+delete
+API
+CLI
+HTML
+CSS
+PDF
+URL
+Nuxt
+Xcode
+UIKit
+VSCode
+PowerShell
+BaaS
+JWT
+JSON
+GPU
+ASIC
+OAuth
+OAuth2
+CAPTCHA
+Bundler
+reputational
+cyberattack
+inclusivity
+admin
+console
+viewport
+repository
+keyframe
+todo
+favicons
+wireframe
+hostname
+Hostname
+destructuring
+Destructuring
+async
+rebrand
+serverless

.vale/styles/appwrite/SentenceCase.yml

@@ -0,0 +1,5 @@
+extends: capitalization
+message: "'%s' should be in sentence case"
+level: warning
+scope: heading
+match: $sentence

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "vale.valeCLI.path": "${workspaceFolder}/node_modules/.bin/vale"
+}

package.json

@@ -10,6 +10,7 @@
         "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
         "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
         "lint": "prettier --plugin-search-dir . --check . && eslint .",
+        "lint:docs": "vale --config=.vale.ini --glob='**/*.md' .",
         "format": "prettier --plugin-search-dir . --write .",
         "test:integration": "playwright test",
         "test:unit": "vitest",
@@ -20,6 +21,7 @@
     "devDependencies": {
         "@melt-ui/pp": "^0.1.2",
         "@melt-ui/svelte": "^0.55.0",
+        "@ocular-d/vale-bin": "^2.29.6",
         "@playwright/test": "^1.37.1",
         "@sveltejs/adapter-node": "^1.3.1",
         "@sveltejs/adapter-static": "^2.0.3",