JobSentinel/.vale.ini at main · cboyd0319/JobSentinel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# Vale Configuration for JobSentinel
# Style: Google Developer Documentation Style Guide
# Audience: Non-technical job seekers (Grade 6 reading level)

# Core settings
StylesPath = .vale/styles
# Keep CI output focused. Advisory style warnings can be run manually by
# temporarily lowering this to suggestion.
MinAlertLevel = error

# Vocabulary and project-specific terms
Vocab = JobSentinel

# Package sources for styles (downloaded via `vale sync`)
Packages = Google, Readability, write-good

# Global settings for all files
[*]
BasedOnStyles = Vale, Google, Readability, write-good, JobSentinel

# Disable overly strict rules for conversational tone
Google.Passive = suggestion
Google.FirstPerson = NO
Google.We = NO
Google.Exclamation = NO
Google.EmDash = suggestion
Google.AMPM = suggestion
Google.Latin = suggestion
Google.LyHyphens = suggestion
Google.Quotes = suggestion
Google.Slang = suggestion
Google.Units = suggestion
Vale.Spelling = suggestion
write-good.So = suggestion
write-good.ThereIs = suggestion

# E-Prime is too strict (flags all "to be" verbs)
write-good.E-Prime = NO

# Weasel words can be intentional in user-friendly writing
write-good.Weasel = suggestion

# Use our contractions rule, not Google's (they conflict)
Google.Contractions = NO

# Ordinals in grade levels are common
Google.Ordinal = suggestion

# Readability targets for non-technical users
Readability.FleschKincaid = YES
Readability.GunningFog = YES
Readability.AutomatedReadability = YES

# Our custom JobSentinel rules
JobSentinel.Glossary = YES
JobSentinel.Jargon = YES
JobSentinel.PlainLanguage = YES

# Markdown documentation
[*.md]
BasedOnStyles = Vale, Google, Readability, write-good, JobSentinel
# Ignore code blocks
BlockIgnores = (?s) *`{3}.*?`{3}

# Agent-facing technical docs intentionally use repo and tool vocabulary.
[AGENTS.md]
BasedOnStyles =

[CLAUDE.md]
BasedOnStyles =

[docs/CLAUDE.md]
BasedOnStyles =

[docs/harness/**]
BasedOnStyles =

[docs/exec-plans.md]
BasedOnStyles =

[docs/plans/**]
BasedOnStyles =

[.github/copilot-instructions.md]
BasedOnStyles =

[.github/PULL_REQUEST_TEMPLATE.md]
BasedOnStyles =

# TypeScript files (error messages and user-facing strings)
[*.ts]
BasedOnStyles = Vale, JobSentinel
# Ignore comments
TokenIgnores = (//.+)

# TSX files (React components with user-facing text)
[*.tsx]
BasedOnStyles = Vale, JobSentinel
# Ignore comments
TokenIgnores = (//.+)

# Ignore generated files
[src-tauri/gen/**]
BasedOnStyles =

# Ignore vendor/dependency files
[node_modules/**]
BasedOnStyles =

# Ignore build output
[dist/**]
BasedOnStyles =

[target/**]
BasedOnStyles =

# Ignore changelog (has different formatting)
[CHANGELOG.md]
BasedOnStyles = Vale