Skip to content

Commit a62cdae

Browse files
committed
Complete Vale configuration improvements
- Enhanced .vale.ini with specific patterns for different content types - Raised MinAlertLevel to 'warning' to reduce noise - Added comprehensive nf-core vocabulary (40+ terms) - Added Vale to pre-commit hooks for local development - Support for both .md and .mdx files throughout This commit completes the Vale modernization started in the workflow update.
1 parent 013f196 commit a62cdae

File tree

4 files changed

+78
-6
lines changed

4 files changed

+78
-6
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
11
Astro
2+
nf-core
3+
Nextflow
4+
Seqera
5+
SeqeraLabs
6+
Bytesize
7+
Conda
8+
Mamba
9+
Bioconda
10+
Singularity
11+
Apptainer
12+
Docker
13+
GitHub
14+
GitLab
15+
Bitbucket
16+
AWS
17+
Azure
18+
GCP
19+
S3
20+
Kubernetes
21+
Slurm
22+
PBS
23+
LSF
24+
SGE
25+
TORQUE
26+
HTCondor
27+
Podman
28+
Charliecloud
29+
Shifter
30+
Spack
31+
OpenEBench
32+
MultiQC
33+
FastQC
34+
nf-test
35+
DSL2
36+
Groovy
37+
CWL
38+
WDL
39+
Snakemake
40+
Prefect
41+
Cromwell

.github/workflows/linting.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ jobs:
3333
with:
3434
files: sites/main-site/src/content,sites/docs/src/content,sites/configs/src/content,sites/modules-subworkflows/src/content,sites/pipelines/src/content
3535
reporter: github-pr-check
36-
fail_on_error: false
36+
fail_on_error: true
3737
env:
3838
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.pre-commit-config.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,9 @@ repos:
99
1010
1111
files: \.(astro|svelte|mdx|md|yml|yaml)$
12+
- repo: https://github.com/errata-ai/vale
13+
rev: v3.7.1
14+
hooks:
15+
- id: vale
16+
args: ["--config=.vale.ini"]
17+
files: \.(md|mdx)$

.vale.ini

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,46 @@
11
StylesPath = .github/styles
2-
MinAlertLevel = suggestion
2+
MinAlertLevel = warning
33

44
Packages = https://github.com/nf-core/vale/releases/latest/download/nf-core.zip
55
Vocab = Docs
66

7-
[*.md]
7+
# Global settings for all Markdown and MDX files
8+
[*.{md,mdx}]
89
BasedOnStyles = nf-core, Vale
910
Vale.Spelling = NO
1011

11-
[src/content/events/**]
12+
# Blog posts - apply standard rules with relaxed personal pronouns
13+
[sites/main-site/src/content/blog/**/*.{md,mdx}]
14+
BasedOnStyles = nf-core, Vale
15+
Vale.Spelling = NO
16+
nf-core.We = NO
17+
18+
# Documentation - stricter rules for formal documentation
19+
[sites/docs/src/content/**/*.{md,mdx}]
20+
BasedOnStyles = nf-core, Vale
21+
Vale.Spelling = NO
22+
23+
# Events - more relaxed rules for community content
24+
[sites/main-site/src/content/events/**/*.md]
25+
BasedOnStyles = nf-core, Vale
26+
Vale.Spelling = NO
1227
nf-core.We = NO
1328
nf-core.SeqeraLabs = NO
1429

15-
[src/content/events/2024]
30+
# 2024 events - granular exception for historical content
31+
[sites/main-site/src/content/events/2024/**/*.md]
1632
nf-core.SeqeraLabs = YES
1733

18-
[src/content/events/*/bytesize_*.md]
34+
# Component and pipeline pages
35+
[sites/modules-subworkflows/src/content/**/*.{md,mdx}]
36+
BasedOnStyles = nf-core, Vale
37+
Vale.Spelling = NO
38+
39+
[sites/pipelines/src/content/**/*.{md,mdx}]
40+
BasedOnStyles = nf-core, Vale
41+
Vale.Spelling = NO
42+
43+
# Config pages
44+
[sites/configs/src/content/**/*.{md,mdx}]
1945
BasedOnStyles = nf-core, Vale
2046
Vale.Spelling = NO

0 commit comments

Comments
 (0)