Some lightweight grammar checks (#2505)

markzegarelli · web-flow · commit 41c08483af9d · 2022-02-17T09:30:12.000-08:00
* Some lightweight grammar checks

* update version

* check an updated file

* Update relative link check

* only annotate modified lines
diff --git a/.github/.vale.ini b/.github/.vale.ini
@@ -0,0 +1,7 @@
+StylesPath = .github/styles
+
+Vocab = Docs
+
+[*.md]
+BasedOnStyles = segment
+TokenIgnores = ({% .* %})
diff --git a/.github/Vocab/Docs/accept.txt b/.github/Vocab/Docs/accept.txt
@@ -0,0 +1,59 @@
+allowlist
+Appboy
+blocklist
+boolean
+CloudFront
+Cocoapods
+Gradle
+HTTP
+http
+HTTPS
+https
+Javadoc
+Javadocs
+Javascript
+Kameleoon
+Kissmetrics
+Littledata
+Middleware
+middleware
+Mixpanel
+Okta
+performant
+Preact
+Shopify
+Totango
+Twilio
+Vero
+WebKit
+Wootric
+Zendesk
+iOS
+ios
+Dev
+ga
+(?:G|g)tag
+(?:P|p)ageviews?\b
+(?:R|r)emarketing
+Doubleclick
+(?:C|c)annonical
+(?:U|u)rls?\b
+Optimizely
+Omnichannel
+namespace
+upsert
+viewability
+measurability
+Lightbox
+gmail
+(?:P|p)endo
+(?:K|k)laviyo
+(?:U|u)nmaps?\b
+(?:U|u)nlinks?\b
+(?:P|p)ostgres
+Smartly
+Hubspot
+Friendbuy
+Chargebee
+(?:L|l)ookback
+Subnet
diff --git a/.github/Vocab/Docs/reject.txt b/.github/Vocab/Docs/reject.txt
@@ -0,0 +1,6 @@
+functionality
+e.g.
+i.e.
+signup
+setup
+login
diff --git a/.github/Vocab/Marketing/accept.txt b/.github/Vocab/Marketing/accept.txt
diff --git a/.github/Vocab/Marketing/reject.txt b/.github/Vocab/Marketing/reject.txt
diff --git a/.github/styles/segment/Latin.yml b/.github/styles/segment/Latin.yml
@@ -0,0 +1,12 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+# link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words
+ignorecase: true
+level: error
+nonword: true
+
+action:
+  name: replace
+swap:
+  '\b(?:eg|e\.g\.)[\s,]': for example
+  '\b(?:ie|i\.e\.)[\s,]': that is, for example
diff --git a/.github/styles/segment/exclamation.yml b/.github/styles/segment/exclamation.yml
@@ -0,0 +1,6 @@
+extends: substitution
+message: "Please use '%s' instead of '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/exclamation-points
+level: warning
+swap:
+    '\w!\s': '\.'
diff --git a/.github/styles/segment/links.yml b/.github/styles/segment/links.yml
@@ -0,0 +1,6 @@
+extends: existence
+message: "Write meaningful link text."
+link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses
+level: warning
+raw:
+  - '\[?here\]\('
diff --git a/.github/styles/segment/relative-url.yml b/.github/styles/segment/relative-url.yml
@@ -0,0 +1,7 @@
+extends: existence
+message: 'Link to Segment docs "%s" must be relative.'
+level: warning
+scope: raw
+raw:
+  - '\[.+\]\(https://(www.)?segment.com/docs.*\)'
+
diff --git a/.github/styles/segment/subs.yml b/.github/styles/segment/subs.yml
@@ -0,0 +1,15 @@
+extends: substitution
+message:  Please use '%s' instead of '%s'
+level: error
+ignorecase: true
+swap:
+  blacklist: blocklist
+  whitelist: allowlist
+  utilize: use
+  utilizes: uses
+  utilizing: using
+  leverage: use
+  leverages: uses
+  leveraging: using
+  via: through, or using
+  drop in: enter
diff --git a/.github/styles/segment/third-person-specific.yml b/.github/styles/segment/third-person-specific.yml
@@ -0,0 +1,14 @@
+extends: existence
+message: "Avoid using first-person like '%s'. Use Segment, a product name, or the other company name."
+# link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural
+level: warning
+ignorecase: true
+
+tokens:
+  - we
+  - we'(?:ve|re)
+  - ours?
+  - our
+  - us
+  - let's
+  # - their
diff --git a/.github/workflows/grammar-lint.yml b/.github/workflows/grammar-lint.yml
@@ -0,0 +1,28 @@
+name: Linting
+on: [push]
+
+jobs:
+  prose:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: Vale
+      uses: errata-ai/vale-action@master
+      with:
+        # Optional
+        # styles: |
+        #   https://github.com/errata-ai/Microsoft/releases/latest/download/Microsoft.zip
+        #   https://github.com/errata-ai/write-good/releases/latest/download/write-good.zip
+
+        # Optional
+        # config: https://raw.githubusercontent.com/errata-ai/vale/master/.vale.ini
+
+        # Optional
+        files: __onlyModified
+        onlyAnnotateModifiedLines: true
+      env:
+        # Required, set by GitHub actions automatically:
+        # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
+        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
diff --git a/src/utils/vale-test.md b/src/utils/vale-test.md
@@ -0,0 +1,15 @@
+---
+title: Vale test
+hidden: true
+---
+This file will test various Vale styles we have installed (e.g. this exclamation point!) Neat! 
+
+Links to docs should be relative, for example [here](https://www.segment.com/docs/connections).
+
+For example, like [this](/docs/connections)
+
+segment.com/docs
+
+Here's an update.
+
+
diff --git a/vale-styles/segment/links.yml b/vale-styles/segment/links.yml
@@ -2,5 +2,6 @@ extends: existence
 message: "Write meaningful link text."
 link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses
 level: warning
+scope: link
 raw:
   - '\[?here\]\('
diff --git a/vale-styles/segment/relative-url.yml b/vale-styles/segment/relative-url.yml
@@ -2,6 +2,7 @@ extends: existence
 message: 'Link to Segment docs "%s" must be relative.'
 level: warning
 scope: raw
+nonword: true
 raw:
-  - '\[.+\]\(https://(www.)?segment.com/docs.*\)'
+  - '(www.)?segment.com\/docs.*\)'
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +functionality
 +e.g.
 +i.e.
 +signup
 +setup
 +login