From 28e20eefbb8e2f1c3d1add67b8dc966eb695f4bb Mon Sep 17 00:00:00 2001 From: markzegarelli Date: Wed, 15 Jun 2022 10:11:01 -0700 Subject: [PATCH] Update Vale rules (#3043) --- .github/Vocab/Marketing/accept.txt | 0 .github/Vocab/Marketing/reject.txt | 0 .github/{ => styles}/Vocab/Docs/accept.txt | 0 .github/{ => styles}/Vocab/Docs/reject.txt | 0 .github/styles/segment/headings.yml | 5 +++++ .github/styles/segment/inclusivity.yml | 20 ++++++++++++++++++++ .github/styles/segment/links copy.yml | 6 ++++++ .vale.ini | 2 +- src/utils/vale-test.md | 9 +++------ vale-styles/segment/headings.yml | 5 +++++ vale-styles/segment/inclusivity.yml | 20 ++++++++++++++++++++ vale-styles/segment/links.yml | 1 - 12 files changed, 60 insertions(+), 8 deletions(-) delete mode 100644 .github/Vocab/Marketing/accept.txt delete mode 100644 .github/Vocab/Marketing/reject.txt rename .github/{ => styles}/Vocab/Docs/accept.txt (100%) rename .github/{ => styles}/Vocab/Docs/reject.txt (100%) create mode 100644 .github/styles/segment/headings.yml create mode 100644 .github/styles/segment/inclusivity.yml create mode 100644 .github/styles/segment/links copy.yml create mode 100644 vale-styles/segment/headings.yml create mode 100644 vale-styles/segment/inclusivity.yml diff --git a/.github/Vocab/Marketing/accept.txt b/.github/Vocab/Marketing/accept.txt deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/.github/Vocab/Marketing/reject.txt b/.github/Vocab/Marketing/reject.txt deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/.github/Vocab/Docs/accept.txt b/.github/styles/Vocab/Docs/accept.txt similarity index 100% rename from .github/Vocab/Docs/accept.txt rename to .github/styles/Vocab/Docs/accept.txt diff --git a/.github/Vocab/Docs/reject.txt b/.github/styles/Vocab/Docs/reject.txt similarity index 100% rename from .github/Vocab/Docs/reject.txt rename to .github/styles/Vocab/Docs/reject.txt diff --git a/.github/styles/segment/headings.yml b/.github/styles/segment/headings.yml new file mode 100644 index 0000000000..7c6d14d08c --- /dev/null +++ b/.github/styles/segment/headings.yml @@ -0,0 +1,5 @@ +extends: capitalization +message: "'%s' should be in sentence case" +level: warning +scope: heading +match: $sentence diff --git a/.github/styles/segment/inclusivity.yml b/.github/styles/segment/inclusivity.yml new file mode 100644 index 0000000000..ffb9046404 --- /dev/null +++ b/.github/styles/segment/inclusivity.yml @@ -0,0 +1,20 @@ +extends: existence +message: Avoid the term '%s' +level: warning +code: false +ignorecase: true +tokens: + - appears to be + - arguably + - grandfather + - powow + - blacklist + - whitelist + - blackhat + - whitehat + - manned + - man-made + - master + - slave + - sanity check + - dummy \ No newline at end of file diff --git a/.github/styles/segment/links copy.yml b/.github/styles/segment/links copy.yml new file mode 100644 index 0000000000..9847e1054e --- /dev/null +++ b/.github/styles/segment/links copy.yml @@ -0,0 +1,6 @@ +extends: existence +message: "Write meaningful link text." +level: warning +scope: link +raw: + - '\[?here\]\(' diff --git a/.vale.ini b/.vale.ini index a0e9f3e9f4..a06bcbb1b7 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = vale-styles +StylesPath = .github/styles Vocab = Docs diff --git a/src/utils/vale-test.md b/src/utils/vale-test.md index 24c100f961..a3ff6531eb 100644 --- a/src/utils/vale-test.md +++ b/src/utils/vale-test.md @@ -2,13 +2,10 @@ title: Vale test hidden: true --- -This file will test various Vale styles we have installed (e.g. this exclamation point!) Neat! +sdfsdfd -Links to docs should be relative, for example [here](https://www.segment.com/docs/connections). +Slave should flag, and so should grandfather. -For example, like [this](/docs/connections) +## Sentence Case Here -segment.com/docs -Here's an update. -![alt tag](/diagram-library/Elements.png) diff --git a/vale-styles/segment/headings.yml b/vale-styles/segment/headings.yml new file mode 100644 index 0000000000..7c6d14d08c --- /dev/null +++ b/vale-styles/segment/headings.yml @@ -0,0 +1,5 @@ +extends: capitalization +message: "'%s' should be in sentence case" +level: warning +scope: heading +match: $sentence diff --git a/vale-styles/segment/inclusivity.yml b/vale-styles/segment/inclusivity.yml new file mode 100644 index 0000000000..ffb9046404 --- /dev/null +++ b/vale-styles/segment/inclusivity.yml @@ -0,0 +1,20 @@ +extends: existence +message: Avoid the term '%s' +level: warning +code: false +ignorecase: true +tokens: + - appears to be + - arguably + - grandfather + - powow + - blacklist + - whitelist + - blackhat + - whitehat + - manned + - man-made + - master + - slave + - sanity check + - dummy \ No newline at end of file diff --git a/vale-styles/segment/links.yml b/vale-styles/segment/links.yml index 2e9653d53b..9847e1054e 100644 --- a/vale-styles/segment/links.yml +++ b/vale-styles/segment/links.yml @@ -1,6 +1,5 @@ extends: existence message: "Write meaningful link text." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses level: warning scope: link raw: