feat(secret-path): enforce all uppercase, add vale-config, add docs (#8)

Author: gorillamoe

.vale/styles/18F/Abbreviations.yml

@@ -0,0 +1,15 @@
+---
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: https://content-guide.18f.gov/specific-words-and-phrases/
+ignorecase: false
+level: error
+nonword: true
+swap:
+  '\beg\b': e.g.,
+  '\bie\b': i.e.,
+  'e\.g\.(?:[^,]|$)': e.g.,
+  'i\.e\.(?:[^,]|$)': i.e.,
+  '(?i)\d{1,2} ?[ap]m': a.m. or p.m.
+  'D\.C\.': DC
+  '\bUSA?\b': U.S.

.vale/styles/18F/Ages.yml

@@ -0,0 +1,7 @@
+---
+extends: existence
+message: Avoid hyphens in ages unless it clarifies the text.
+link: https://content-guide.18f.gov/specific-words-and-phrases/
+level: warning
+tokens:
+  - '\d{1,3}-year-old'

.vale/styles/18F/Brands.yml

@@ -0,0 +1,22 @@
+---
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: https://content-guide.18f.gov/trademarks-and-brands/
+level: warning
+ignorecase: true
+swap:
+  Band-Aid: bandage
+  Bubble Wrap: packaging bubbles
+  Chapstick: lip balm
+  Crayola: crayons
+  Dumpster: waste container
+  Hi-Liter: highlighting marker
+  iPod: MP3 player
+  Kleenex: tissue
+  Plexiglas: plastic glass
+  Post-it note: adhesive note
+  Q-Tips: cotton swabs
+  Scotch tape: transparent tape
+  Styrofoam: plastic foam
+  Taser: stun gun
+  Xerox: photocopy

.vale/styles/18F/Clarity.yml

@@ -0,0 +1,35 @@
+---
+extends: substitution
+message: '%s'
+link: https://content-guide.18f.gov/plain-language/#words-to-avoid
+level: warning
+ignorecase: true
+swap:
+  (?:commit|pledge): >
+    Be more specific — we’re either doing something or we’re not.
+  advancing: Avoid using 'advancing.'
+  agenda: Avoid using 'agenda' (unless you’re talking about a meeting).
+  deploy: >
+    Avoid using 'deploy', unless you’re talking about the military or
+    software.
+  disincentivize: Avoid using 'disincentivize.'
+  empower: Avoid using 'empower.'
+  focusing: Avoid using 'focusing.'
+  foster: Avoid using 'foster' (unless it’s children).
+  impact(?:ful)?: Avoid using impact or impactful.
+  incentivize: Avoid using 'incentivize.'
+  innovative: Use words that describe the positive outcome of the innovation.
+  key: Avoid using 'key' (unless it unlocks something).
+  leverage: >
+    Avoid using 'leverage' (unless you're using it in the financial sense).
+  progress: What are you actually doing?
+  promote: Avoid using 'promote' (unless you’re talking about an ad campaign).
+  streamline: Avoid using 'streamline.'
+  strengthening: >
+    Avoid using 'strengthening' (unless you’re referring to bridges or other
+    structures).
+  tackling: >
+    Avoid using 'tackling' (unless you’re referring to football or another
+    contact sport).
+  touchpoint: Mention specific system components.
+  transforming: What are you actually doing to change it?

.vale/styles/18F/Contractions.yml

@@ -0,0 +1,41 @@
+---
+extends: substitution
+message: 'Use "%s" instead of "%s".'
+link: https://content-guide.18f.gov/voice-and-tone/#use-contractions
+level: error
+ignorecase: true
+swap:
+  are not: aren't
+  cannot: can't
+  could not: couldn't
+  did not: didn't
+  do not: don't
+  does not: doesn't
+  has not: hasn't
+  have not: haven't
+  how is: how's
+  how will: how'll
+  is not: isn't
+  it is: it's
+  it will: it'll
+  should not: shouldn't
+  that is: that's
+  that will: that'll
+  they are: they're
+  they will: they'll
+  was not: wasn't
+  we are: we're
+  we have: we've
+  we will: we'll
+  were not: weren't
+  what is: what's
+  what will: what'll
+  when is: when's
+  when will: when'll
+  where is: where's
+  where will: where'll
+  who is: who's
+  who will: who'll
+  why is: why's
+  why will: why'll
+  will not: won't

.vale/styles/18F/DropDown.yml

@@ -0,0 +1,14 @@
+---
+extends: substitution
+message: "Use %s instead of '%s'."
+link: https://content-guide.18f.gov/specific-words-and-phrases/
+level: error
+# 'drop-down' when used as an adjective. For example, drop-down menu.
+# 'drop down' when used as a noun. For example, an option from the drop down.
+# Never dropdown.
+pos: 'drop/\w+ down/RP|dropdown/\w+|drop-down/NN'
+ignorecase: true
+swap:
+  drop down: "'drop-down'"
+  drop-down: "'drop down'"
+  dropdown: "'drop-down' or 'drop down'"

.vale/styles/18F/Headings.yml

@@ -0,0 +1,7 @@
+---
+extends: capitalization
+message: "'%s' should be in sentence case."
+link: https://content-guide.18f.gov/capitalization/#headings
+level: warning
+scope: heading
+match: $sentence

.vale/styles/18F/Quotes.yml

@@ -0,0 +1,8 @@
+---
+extends: existence
+message: Punctuation should be inside the quotes.
+link: https://content-guide.18f.gov/punctuation/#quotes
+level: error
+nonword: true
+tokens:
+  - '"[^"]+"[.,?]'

.vale/styles/18F/Reading.yml

@@ -0,0 +1,8 @@
+---
+message: Craft sentences at 25 words or fewer, whenever possible.
+link: 'https://content-guide.18f.gov/be-concise/#keep-sentences-short-and-sweet'
+extends: occurrence
+scope: sentence
+level: warning
+max: 25
+token: '\b(\w+)\b'

.vale/styles/18F/SentenceLength.yml

@@ -0,0 +1,8 @@
+---
+message: Craft sentences at 25 words or fewer, whenever possible.
+link: 'https://content-guide.18f.gov/be-concise/#keep-sentences-short-and-sweet'
+extends: occurrence
+scope: sentence
+level: warning
+max: 25
+token: '\b(\w+)\b'