Complete Vale configuration

Author: edmundmiller

.github/workflows/linting.yml

@@ -17,6 +17,8 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
       - run: npm install --only=dev
+      - name: Install custom mdx2vast for MDX directive vale support
+        run: npm install -g https://github.com/edmundmiller/mdx2vast.git
       - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
   vale:
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -13,5 +13,8 @@ repos:
     rev: v3.7.1
     hooks:
       - id: vale
-        args: ["--config=.vale.ini"]
-        files: \.(md|mdx)$
+        name: vale sync
+        pass_filenames: false
+        args: [sync]
+      - id: vale
+        args: [--output=line, --minAlertLevel=error]

.vale.ini

@@ -4,6 +4,9 @@ MinAlertLevel = warning
 Packages = MDX, https://github.com/nf-core/vale/releases/latest/download/nf-core.zip
 Vocab = Docs
 
+# Ignore API reference documentation (auto-generated)
+IgnoredPaths = sites/docs/src/content/api_reference/*, sites/main-site/src/content/events/*
+
 # Global settings for all Markdown and MDX files
 [*.{md,mdx}]
 BasedOnStyles = nf-core, Vale
@@ -20,16 +23,6 @@ nf-core.We = NO
 BasedOnStyles = nf-core, Vale
 Vale.Spelling = NO
 
-# Events - more relaxed rules for community content
-[sites/main-site/src/content/events/**/*.md]
-BasedOnStyles = nf-core, Vale
-Vale.Spelling = NO
-nf-core.We = NO
-nf-core.SeqeraLabs = NO
-
-# 2024 events - granular exception for historical content
-[sites/main-site/src/content/events/2024/**/*.md]
-nf-core.SeqeraLabs = YES
 
 # Component and pipeline pages
 [sites/modules-subworkflows/src/content/**/*.{md,mdx}]
@@ -44,3 +37,14 @@ Vale.Spelling = NO
 [sites/configs/src/content/**/*.{md,mdx}]
 BasedOnStyles = nf-core, Vale
 Vale.Spelling = NO
+
+# Events - more relaxed rules for community content
+[sites/main-site/src/content/events/**/*.md]
+BasedOnStyles = nf-core, Vale
+Vale.Spelling = NO
+nf-core.We = NO
+nf-core.SeqeraLabs = NO
+
+# 2024 events - granular exception for historical content
+[sites/main-site/src/content/events/2024/**/*.md]
+nf-core.SeqeraLabs = YES

.vscode/extensions.json

@@ -0,0 +1,28 @@
+{
+  "recommendations": [
+    // Documentation and linting
+    "errata-ai.vale-server",
+    "davidanson.vscode-markdownlint",
+    "streetsidesoftware.code-spell-checker",
+
+    // Formatting and Prettier
+    "esbenp.prettier-vscode",
+
+    // Astro and web development
+    "astro-build.astro-vscode",
+    "bradlc.vscode-tailwindcss",
+
+    // YAML and configuration files
+    "redhat.vscode-yaml",
+
+    // Git and version control
+    "eamodio.gitlens",
+
+    // Commitizen support
+    "commitizen.git-conventional-commits",
+
+    // Link checking (if available)
+    "tchayen.markdown-links"
+  ],
+  "unwantedRecommendations": []
+}

.vscode/settings.json

@@ -1,5 +1,48 @@
 {
   "markdown.styles": [
     "public/vscode_markdown.css"
-  ]
+  ],
+
+  "// Documentation linting and formatting": "",
+  "vale.valeCLI.config": ".vale.ini",
+  "vale.valeCLI.path": "vale",
+  "vale.core.useCLI": true,
+
+  "[markdown]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.rulers": [120],
+    "editor.wordWrap": "wordWrapColumn",
+    "editor.wordWrapColumn": 120
+  },
+
+  "// MDX settings": "",
+  "[mdx]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.rulers": [120],
+    "editor.wordWrap": "wordWrapColumn",
+    "editor.wordWrapColumn": 120
+  },
+
+  "// YAML settings": "",
+  "[yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+    "editor.insertSpaces": true,
+    "editor.tabSize": 2
+  },
+
+  "// Astro settings": "",
+  "[astro]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+
+  "// File explorer": "",
+  "files.exclude": {
+    "**/node_modules": true,
+    "**/dist": true,
+    "**/.astro": true
+  }
 }