Improve Vale

.github/workflows/vale.yml

@@ -23,6 +23,12 @@ jobs:
     steps:
       - name: Checkout repo
         uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            .vale.ini
+            .vale
+            content/en/docs
+          sparse-checkout-cone-mode: false
 
       - name: Get changed files
         id: changed-files

.vale.ini

@@ -30,6 +30,14 @@ BasedOnStyles = Microsoft, Mendix
 # Replacement: Mendix.Acronyms accepts sentence-case definitions
 Microsoft.Acronyms = NO
 
+# Auto
+# Reduce severity to warning because it just isn't that important
+Microsoft.Auto = warning
+
+# Avoid
+# Rule is incomplete; doesn't seem worth having
+Microsoft.Avoid = NO
+
 # Contractions
 # Microsoft requires contractions; Mendix prohibits them
 # Mendix style guide: "Do not use contractions. Write 'it is' and not 'it's.'"
@@ -90,6 +98,11 @@ Microsoft.Terms = NO
 # Too far off from Mendix terminology guidance
 Microsoft.Vocab = NO
 
+# Wordiness
+# Replaced some of the substitutions
+# Replacement: Mendix.Wordiness
+Microsoft.Vocab = NO
+
 # ============================================================================
 # Path-Specific Overrides
 # ============================================================================

.vale/styles/Mendix/Acronyms.yml

@@ -29,6 +29,7 @@ exceptions:
   - GCC
   - GDB
   - GET
+  - GIF
   - GPU
   - GTK
   - GUI
@@ -37,6 +38,8 @@ exceptions:
   - HTTPS
   - IDE
   - JAR
+  - JPEG
+  - JPG
   - JSON
   - JSX
   - LESS
@@ -50,6 +53,7 @@ exceptions:
   - PATH
   - PDF
   - PHP
+  - PNG
   - POST
   - RAM
   - REPL

.vale/styles/Mendix/Dashes.yml

@@ -1,6 +1,7 @@
 # Reference: content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/grammar-formatting.md (Dashes)
+# Known issue: False positive around links
 extends: substitution
-message: "Remove spaces around the em dash (—). Or, to set off a list item intro, use an en dash (–) instead."
+message: "Remove spaces around the em dash (—). Or, to set off a list item intro or number range, use an en dash (–) instead."
 link: https://docs.mendix.com/community-tools/contribute-to-mendix-docs/style-guide/grammar-formatting/#em-dash
 ignorecase: false
 nonword: true

.vale/styles/Mendix/Wordiness.yml

@@ -0,0 +1,127 @@
+extends: substitution
+message: "Consider using '%s' instead of '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences
+ignorecase: false
+level: suggestion
+action:
+  name: replace
+swap:
+  "sufficient number(?: of)?": enough
+  (?:take away|eliminate): remove
+  (?:in order to|as a means to): to
+  (?:inform): tell
+  (?:previous|prior) to: before
+  (?:utilize|make use of): use
+  a (?:large)? majority of: most
+  a (?:large)? number of: many
+  a myriad of: myriad
+  adversely impact: hurt
+  all across: across
+  all of a sudden: suddenly
+  all of these: these
+  all of(?! a sudden| these): all
+  all-time record: record
+  allows you to: lets you
+  almost all: most
+  almost never: seldom
+  along the lines of: similar to
+  an adequate number of: enough
+  an appreciable number of: many
+  an estimated: about
+  any and all: all
+  are in agreement: agree
+  as a matter of fact: in fact
+  as a means of: to
+  as a result of: because of
+  as of yet: yet
+  as per: per
+  at a later date: later
+  at all times: always
+  at the present time: now
+  at this point in time: at this point
+  based in large part on: based on
+  based on the fact that: because
+  basic necessity: necessity
+  because of the fact that: because
+  came to a realization: realized
+  came to an abrupt end: ended abruptly
+  carry out an evaluation of: evaluate
+  close down: close
+  closed down: closed
+  complete stranger: stranger
+  completely separate: separate
+  concerning the matter of: regarding
+  conduct a review of: review
+  conduct an investigation: investigate
+  conduct experiments: experiment
+  continue on: continue
+  despite the fact that: although
+  disappear from sight: disappear
+  doomed to fail: will fail
+  drag and drop: drag
+  drag-and-drop: drag
+  due to the fact that: because
+  during the period of: during
+  during the time that: while
+  emergency situation: emergency
+  establish connectivity: connect
+  except when: unless
+  excessive number: too many
+  extend an invitation: invite
+  fall down: fall
+  fell down: fell
+  for the duration of: during
+  gather together: gather
+  has the ability to: can
+  has the capacity to: can
+  has the opportunity to: could
+  hold a meeting: meet
+  if this is not the case: if not
+  in a careful manner: carefully
+  in a thoughtful manner: thoughtfully
+  in a timely manner: on time
+  in addition: also
+  in an effort to: to
+  in between: between
+  in lieu of: instead of
+  in many cases: often
+  in most cases: usually
+  in order to: to
+  in some cases: sometimes
+  in spite of the fact that: although
+  in spite of: despite
+  in the (?:very)? near future: soon
+  in the event that: if
+  in the neighborhood of: roughly
+  in the vicinity of: close to
+  it would appear that: apparently
+  lift up: lift
+  made reference to: referred to
+  make reference to: refer to
+  mix together: mix
+  none at all: none
+  not in a position to: unable
+  not possible: impossible
+  of major importance: important
+  perform an assessment of: assess
+  pertaining to: about
+  place an order: order
+  plays a key role in: is essential to
+  present time: now
+  readily apparent: apparent
+  some of the: some
+  span across: span
+  subsequent to: after
+  successfully complete: complete
+  take action: act
+  take into account: consider
+  the question as to whether: whether
+  there is no doubt but that: doubtless
+  this day and age: this age
+  this is a subject that: this subject
+  time (?:frame|period): time
+  under the provisions of: under
+  until such time as: until
+  whether or not: whether
+  with regard to: regarding
+  with the exception of: except for