From a596287af275ab9141827d589fd7a0602c01c524 Mon Sep 17 00:00:00 2001 From: Khushal Agarwal Date: Tue, 24 Dec 2024 19:36:02 +0530 Subject: [PATCH] chore: remove docusaurus related actions and vale setup in favor of new docs system (#2864) --- .github/workflows/check-pr.yml | 4 +- .github/workflows/docusaurus.yml | 28 ---- .github/workflows/next-release.yml | 6 +- .github/workflows/release.yml | 2 +- .github/workflows/vale-doc-lint.yml | 26 ---- .styles/Google/AMPM.yml | 9 -- .styles/Google/Acronyms.yml | 64 --------- .styles/Google/Colons.yml | 8 -- .styles/Google/Contractions.yml | 30 ----- .styles/Google/DateFormat.yml | 9 -- .styles/Google/Ellipses.yml | 9 -- .styles/Google/EmDash.yml | 12 -- .styles/Google/EnDash.yml | 13 -- .styles/Google/Exclamation.yml | 7 - .styles/Google/FirstPerson.yml | 13 -- .styles/Google/Gender.yml | 9 -- .styles/Google/GenderBias.yml | 45 ------- .styles/Google/HeadingPunctuation.yml | 13 -- .styles/Google/Headings.yml | 29 ---- .styles/Google/Latin.yml | 11 -- .styles/Google/LyHyphens.yml | 14 -- .styles/Google/OptionalPlurals.yml | 12 -- .styles/Google/Ordinal.yml | 7 - .styles/Google/OxfordComma.yml | 7 - .styles/Google/Parens.yml | 7 - .styles/Google/Passive.yml | 184 -------------------------- .styles/Google/Periods.yml | 7 - .styles/Google/Quotes.yml | 7 - .styles/Google/Ranges.yml | 7 - .styles/Google/Semicolons.yml | 8 -- .styles/Google/Slang.yml | 11 -- .styles/Google/Spacing.yml | 8 -- .styles/Google/Spelling.yml | 8 -- .styles/Google/Units.yml | 8 -- .styles/Google/We.yml | 11 -- .styles/Google/Will.yml | 7 - .styles/Google/WordList.yml | 80 ----------- .styles/Google/meta.json | 4 - .styles/Google/vocab.txt | 0 .styles/Vocab/Base/accept.txt | 64 --------- .styles/Vocab/Base/reject.txt | 0 .vale.ini | 17 --- package.json | 4 +- package/.eslintignore | 1 - 44 files changed, 5 insertions(+), 825 deletions(-) delete mode 100644 .github/workflows/docusaurus.yml delete mode 100644 .github/workflows/vale-doc-lint.yml delete mode 100644 .styles/Google/AMPM.yml delete mode 100644 .styles/Google/Acronyms.yml delete mode 100644 .styles/Google/Colons.yml delete mode 100644 .styles/Google/Contractions.yml delete mode 100644 .styles/Google/DateFormat.yml delete mode 100644 .styles/Google/Ellipses.yml delete mode 100644 .styles/Google/EmDash.yml delete mode 100644 .styles/Google/EnDash.yml delete mode 100644 .styles/Google/Exclamation.yml delete mode 100644 .styles/Google/FirstPerson.yml delete mode 100644 .styles/Google/Gender.yml delete mode 100644 .styles/Google/GenderBias.yml delete mode 100644 .styles/Google/HeadingPunctuation.yml delete mode 100644 .styles/Google/Headings.yml delete mode 100644 .styles/Google/Latin.yml delete mode 100644 .styles/Google/LyHyphens.yml delete mode 100644 .styles/Google/OptionalPlurals.yml delete mode 100644 .styles/Google/Ordinal.yml delete mode 100644 .styles/Google/OxfordComma.yml delete mode 100644 .styles/Google/Parens.yml delete mode 100644 .styles/Google/Passive.yml delete mode 100644 .styles/Google/Periods.yml delete mode 100644 .styles/Google/Quotes.yml delete mode 100644 .styles/Google/Ranges.yml delete mode 100644 .styles/Google/Semicolons.yml delete mode 100644 .styles/Google/Slang.yml delete mode 100644 .styles/Google/Spacing.yml delete mode 100644 .styles/Google/Spelling.yml delete mode 100644 .styles/Google/Units.yml delete mode 100644 .styles/Google/We.yml delete mode 100644 .styles/Google/Will.yml delete mode 100644 .styles/Google/WordList.yml delete mode 100644 .styles/Google/meta.json delete mode 100644 .styles/Google/vocab.txt delete mode 100644 .styles/Vocab/Base/accept.txt delete mode 100644 .styles/Vocab/Base/reject.txt delete mode 100644 .vale.ini diff --git a/.github/workflows/check-pr.yml b/.github/workflows/check-pr.yml index 3d5dd6dcc4..004c41daf1 100644 --- a/.github/workflows/check-pr.yml +++ b/.github/workflows/check-pr.yml @@ -26,8 +26,6 @@ jobs: - name: Install && Build - SDK and Sample App uses: ./.github/actions/install-and-build-sdk - name: Lint - run: yarn lerna-workspaces run lint && cd docusaurus && npx prettier --check '**/*.mdx' + run: yarn lerna-workspaces run lint - name: Test run: yarn test:coverage - env: - GITHUB_TOKEN: ${{ secrets.DOCUSAURUS_GH_TOKEN }} diff --git a/.github/workflows/docusaurus.yml b/.github/workflows/docusaurus.yml deleted file mode 100644 index b951cad79f..0000000000 --- a/.github/workflows/docusaurus.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: docusaurus - -on: - push: - branches: - - main # default branch name for each repo that docs should be push from - - develop -env: - branch_map: '{"refs/heads/main": "production", "refs/heads/develop": "staging"}' -jobs: - push_docusaurus: - runs-on: ubuntu-latest - strategy: - matrix: - node-version: [18.x] - steps: - - uses: actions/checkout@v2 - - name: Node ${{ matrix.node-version }} - uses: actions/setup-node@v3 - with: - node-version: ${{ matrix.node-version }} - cache: 'yarn' - - name: Push to stream-chat-docusaurus - uses: GetStream/push-stream-chat-docusaurus-action@main - with: - target-branch: ${{ fromJSON(env.branch_map)[github.ref] }} - env: - DOCUSAURUS_GH_TOKEN: ${{ secrets.DOCUSAURUS_GH_TOKEN }} diff --git a/.github/workflows/next-release.yml b/.github/workflows/next-release.yml index 935f2fcd7c..c379c4b58c 100644 --- a/.github/workflows/next-release.yml +++ b/.github/workflows/next-release.yml @@ -30,12 +30,8 @@ jobs: - name: Install && Build - SDK and Sample App uses: ./.github/actions/install-and-build-sdk - name: Lint - run: yarn lerna-workspaces run lint && (cd docusaurus; npx prettier --check '**/*.mdx') + run: yarn lerna-workspaces run lint - name: Test run: yarn test:coverage - env: - GITHUB_TOKEN: ${{ secrets.DOCUSAURUS_GH_TOKEN }} - name: Publish Next Release run: GITHUB_SHORT_SHA="$(git rev-parse --short $GITHUB_SHA)" yarn release-next - env: - NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }} diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 7d82f3129f..d9dfcf66ad 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -31,7 +31,7 @@ jobs: - name: Install && Build - SDK and Sample App uses: ./.github/actions/install-and-build-sdk - name: Lint - run: yarn lerna-workspaces run lint && cd docusaurus && npx prettier --check '**/*.mdx' + run: yarn lerna-workspaces run lint - name: Publish Release run: yarn release env: diff --git a/.github/workflows/vale-doc-lint.yml b/.github/workflows/vale-doc-lint.yml deleted file mode 100644 index 734fb3d172..0000000000 --- a/.github/workflows/vale-doc-lint.yml +++ /dev/null @@ -1,26 +0,0 @@ -name: Check Docusaurus docs with Vale linter - -on: [pull_request] - -jobs: - vale: - name: Vale doc linter - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: errata-ai/vale-action@reviewdog - with: - version: 2.30.0 - # added, diff_context, file, nofilter - # Default is added: results are filtered for added/modified files. Set to no filter when all files need to be checked. - # More info: https://github.com/errata-ai/vale-action and https://github.com/reviewdog/reviewdog#filter-mode - filter_mode: nofilter - # github-pr-check, github-pr-review, github-check - reporter: github-pr-check - # Set fail_on_error to true to make sure builds fail. - fail_on_error: true - files: docusaurus - 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.DOCUSAURUS_GH_TOKEN }} diff --git a/.styles/Google/AMPM.yml b/.styles/Google/AMPM.yml deleted file mode 100644 index fbdc6e4f84..0000000000 --- a/.styles/Google/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Use 'AM' or 'PM' (preceded by a space)." -link: 'https://developers.google.com/style/word-list' -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.styles/Google/Acronyms.yml b/.styles/Google/Acronyms.yml deleted file mode 100644 index f41af0189b..0000000000 --- a/.styles/Google/Acronyms.yml +++ /dev/null @@ -1,64 +0,0 @@ -extends: conditional -message: "Spell out '%s', if it's unfamiliar to the audience." -link: 'https://developers.google.com/style/abbreviations' -level: suggestion -ignorecase: false -# Ensures that the existence of 'first' implies the existence of 'second'. -first: '\b([A-Z]{3,5})\b' -second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP diff --git a/.styles/Google/Colons.yml b/.styles/Google/Colons.yml deleted file mode 100644 index 99363fbd46..0000000000 --- a/.styles/Google/Colons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' should be in lowercase." -link: 'https://developers.google.com/style/colons' -nonword: true -level: warning -scope: sentence -tokens: - - ':\s[A-Z]' diff --git a/.styles/Google/Contractions.yml b/.styles/Google/Contractions.yml deleted file mode 100644 index 95234987be..0000000000 --- a/.styles/Google/Contractions.yml +++ /dev/null @@ -1,30 +0,0 @@ -extends: substitution -message: "Feel free to use '%s' instead of '%s'." -link: 'https://developers.google.com/style/contractions' -level: suggestion -ignorecase: true -action: - name: replace -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 - is not: isn't - it is: it's - should not: shouldn't - that is: that's - they are: they're - was not: wasn't - we are: we're - we have: we've - were not: weren't - what is: what's - when is: when's - where is: where's - will not: won't diff --git a/.styles/Google/DateFormat.yml b/.styles/Google/DateFormat.yml deleted file mode 100644 index e9d227fa13..0000000000 --- a/.styles/Google/DateFormat.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Use 'July 31, 2016' format, not '%s'." -link: 'https://developers.google.com/style/dates-times' -ignorecase: true -level: error -nonword: true -tokens: - - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' - - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}' diff --git a/.styles/Google/Ellipses.yml b/.styles/Google/Ellipses.yml deleted file mode 100644 index 1e070517bf..0000000000 --- a/.styles/Google/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: 'https://developers.google.com/style/ellipses' -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/.styles/Google/EmDash.yml b/.styles/Google/EmDash.yml deleted file mode 100644 index 1befe72aa8..0000000000 --- a/.styles/Google/EmDash.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: existence -message: "Don't put a space before or after a dash." -link: 'https://developers.google.com/style/dashes' -nonword: true -level: error -action: - name: edit - params: - - remove - - ' ' -tokens: - - '\s[—–]\s' diff --git a/.styles/Google/EnDash.yml b/.styles/Google/EnDash.yml deleted file mode 100644 index b314dc4e98..0000000000 --- a/.styles/Google/EnDash.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Use an em dash ('—') instead of '–'." -link: 'https://developers.google.com/style/dashes' -nonword: true -level: error -action: - name: edit - params: - - replace - - '-' - - '—' -tokens: - - '–' diff --git a/.styles/Google/Exclamation.yml b/.styles/Google/Exclamation.yml deleted file mode 100644 index 3e15181b2f..0000000000 --- a/.styles/Google/Exclamation.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use exclamation points in text." -link: 'https://developers.google.com/style/exclamation-points' -nonword: true -level: error -tokens: - - '\w!(?:\s|$)' diff --git a/.styles/Google/FirstPerson.yml b/.styles/Google/FirstPerson.yml deleted file mode 100644 index 0b7b8828ca..0000000000 --- a/.styles/Google/FirstPerson.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Avoid first-person pronouns such as '%s'." -link: 'https://developers.google.com/style/pronouns#personal-pronouns' -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - (?:^|\s)I,\s - - \bI'm\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/.styles/Google/Gender.yml b/.styles/Google/Gender.yml deleted file mode 100644 index c8486181d6..0000000000 --- a/.styles/Google/Gender.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Don't use '%s' as a gender-neutral pronoun." -link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' -level: error -ignorecase: true -tokens: - - he/she - - s/he - - \(s\)he diff --git a/.styles/Google/GenderBias.yml b/.styles/Google/GenderBias.yml deleted file mode 100644 index 261cfb666f..0000000000 --- a/.styles/Google/GenderBias.yml +++ /dev/null @@ -1,45 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: 'https://developers.google.com/style/inclusive-documentation' -ignorecase: true -level: error -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) - congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/.styles/Google/HeadingPunctuation.yml b/.styles/Google/HeadingPunctuation.yml deleted file mode 100644 index b538be5b42..0000000000 --- a/.styles/Google/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Don't put a period at the end of a heading." -link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -nonword: true -level: warning -scope: heading -action: - name: edit - params: - - remove - - '.' -tokens: - - '[a-z0-9][.]\s*$' diff --git a/.styles/Google/Headings.yml b/.styles/Google/Headings.yml deleted file mode 100644 index a53301338a..0000000000 --- a/.styles/Google/Headings.yml +++ /dev/null @@ -1,29 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -level: warning -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Cosmos - - Docker - - Emmet - - gRPC - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows diff --git a/.styles/Google/Latin.yml b/.styles/Google/Latin.yml deleted file mode 100644 index d91700de3f..0000000000 --- a/.styles/Google/Latin.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: 'https://developers.google.com/style/abbreviations' -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)[\s,]': for example - '\b(?:ie|i\.e\.)[\s,]': that is diff --git a/.styles/Google/LyHyphens.yml b/.styles/Google/LyHyphens.yml deleted file mode 100644 index ac8f557a4a..0000000000 --- a/.styles/Google/LyHyphens.yml +++ /dev/null @@ -1,14 +0,0 @@ -extends: existence -message: "'%s' doesn't need a hyphen." -link: 'https://developers.google.com/style/hyphens' -level: error -ignorecase: false -nonword: true -action: - name: edit - params: - - replace - - '-' - - ' ' -tokens: - - '\s[^\s-]+ly-' diff --git a/.styles/Google/OptionalPlurals.yml b/.styles/Google/OptionalPlurals.yml deleted file mode 100644 index f858ea6fee..0000000000 --- a/.styles/Google/OptionalPlurals.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: existence -message: "Don't use plurals in parentheses such as in '%s'." -link: 'https://developers.google.com/style/plurals-parentheses' -level: error -nonword: true -action: - name: edit - params: - - remove - - '(s)' -tokens: - - '\b\w+\(s\)' diff --git a/.styles/Google/Ordinal.yml b/.styles/Google/Ordinal.yml deleted file mode 100644 index d1ac7d27e8..0000000000 --- a/.styles/Google/Ordinal.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Spell out all ordinal numbers ('%s') in text." -link: 'https://developers.google.com/style/numbers' -level: error -nonword: true -tokens: - - \d+(?:st|nd|rd|th) diff --git a/.styles/Google/OxfordComma.yml b/.styles/Google/OxfordComma.yml deleted file mode 100644 index b9ba21ebb2..0000000000 --- a/.styles/Google/OxfordComma.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use the Oxford comma in '%s'." -link: 'https://developers.google.com/style/commas' -scope: sentence -level: warning -tokens: - - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/.styles/Google/Parens.yml b/.styles/Google/Parens.yml deleted file mode 100644 index 3b8711d0c8..0000000000 --- a/.styles/Google/Parens.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use parentheses judiciously." -link: 'https://developers.google.com/style/parentheses' -nonword: true -level: suggestion -tokens: - - '\(.+\)' diff --git a/.styles/Google/Passive.yml b/.styles/Google/Passive.yml deleted file mode 100644 index 3265890e52..0000000000 --- a/.styles/Google/Passive.yml +++ /dev/null @@ -1,184 +0,0 @@ -extends: existence -link: 'https://developers.google.com/style/voice' -message: "In general, use active voice instead of passive voice ('%s')." -ignorecase: true -level: suggestion -raw: - - \b(am|are|were|being|is|been|was|be)\b\s* -tokens: - - '[\w]+ed' - - awoken - - beat - - become - - been - - begun - - bent - - beset - - bet - - bid - - bidden - - bitten - - bled - - blown - - born - - bought - - bound - - bred - - broadcast - - broken - - brought - - built - - burnt - - burst - - cast - - caught - - chosen - - clung - - come - - cost - - crept - - cut - - dealt - - dived - - done - - drawn - - dreamt - - driven - - drunk - - dug - - eaten - - fallen - - fed - - felt - - fit - - fled - - flown - - flung - - forbidden - - foregone - - forgiven - - forgotten - - forsaken - - fought - - found - - frozen - - given - - gone - - gotten - - ground - - grown - - heard - - held - - hidden - - hit - - hung - - hurt - - kept - - knelt - - knit - - known - - laid - - lain - - leapt - - learnt - - led - - left - - lent - - let - - lighted - - lost - - made - - meant - - met - - misspelt - - mistaken - - mown - - overcome - - overdone - - overtaken - - overthrown - - paid - - pled - - proven - - put - - quit - - read - - rid - - ridden - - risen - - run - - rung - - said - - sat - - sawn - - seen - - sent - - set - - sewn - - shaken - - shaven - - shed - - shod - - shone - - shorn - - shot - - shown - - shrunk - - shut - - slain - - slept - - slid - - slit - - slung - - smitten - - sold - - sought - - sown - - sped - - spent - - spilt - - spit - - split - - spoken - - spread - - sprung - - spun - - stolen - - stood - - stridden - - striven - - struck - - strung - - stuck - - stung - - stunk - - sung - - sunk - - swept - - swollen - - sworn - - swum - - swung - - taken - - taught - - thought - - thrived - - thrown - - thrust - - told - - torn - - trodden - - understood - - upheld - - upset - - wed - - wept - - withheld - - withstood - - woken - - won - - worn - - wound - - woven - - written - - wrung diff --git a/.styles/Google/Periods.yml b/.styles/Google/Periods.yml deleted file mode 100644 index d24a6a6c03..0000000000 --- a/.styles/Google/Periods.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't use periods with acronyms or initialisms such as '%s'." -link: 'https://developers.google.com/style/abbreviations' -level: error -nonword: true -tokens: - - '\b(?:[A-Z]\.){3,}' diff --git a/.styles/Google/Quotes.yml b/.styles/Google/Quotes.yml deleted file mode 100644 index 3cb6f1abd1..0000000000 --- a/.styles/Google/Quotes.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Commas and periods go inside quotation marks." -link: 'https://developers.google.com/style/quotation-marks' -level: error -nonword: true -tokens: - - '"[^"]+"[.,?]' diff --git a/.styles/Google/Ranges.yml b/.styles/Google/Ranges.yml deleted file mode 100644 index 3ec045e777..0000000000 --- a/.styles/Google/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Don't add words such as 'from' or 'between' to describe a range of numbers." -link: 'https://developers.google.com/style/hyphens' -nonword: true -level: warning -tokens: - - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/.styles/Google/Semicolons.yml b/.styles/Google/Semicolons.yml deleted file mode 100644 index bb8b85b420..0000000000 --- a/.styles/Google/Semicolons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use semicolons judiciously." -link: 'https://developers.google.com/style/semicolons' -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/.styles/Google/Slang.yml b/.styles/Google/Slang.yml deleted file mode 100644 index 63f4c248a8..0000000000 --- a/.styles/Google/Slang.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Don't use internet slang abbreviations such as '%s'." -link: 'https://developers.google.com/style/abbreviations' -ignorecase: true -level: error -tokens: - - 'tl;dr' - - ymmv - - rtfm - - imo - - fwiw diff --git a/.styles/Google/Spacing.yml b/.styles/Google/Spacing.yml deleted file mode 100644 index 27f7ca2bdc..0000000000 --- a/.styles/Google/Spacing.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "'%s' should have one space." -link: 'https://developers.google.com/style/sentence-spacing' -level: error -nonword: true -tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' diff --git a/.styles/Google/Spelling.yml b/.styles/Google/Spelling.yml deleted file mode 100644 index 57acb88414..0000000000 --- a/.styles/Google/Spelling.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "In general, use American spelling instead of '%s'." -link: 'https://developers.google.com/style/spelling' -ignorecase: true -level: warning -tokens: - - '(?:\w+)nised?' - - '(?:\w+)logue' diff --git a/.styles/Google/Units.yml b/.styles/Google/Units.yml deleted file mode 100644 index 379fad6b8e..0000000000 --- a/.styles/Google/Units.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Put a nonbreaking space between the number and the unit in '%s'." -link: 'https://developers.google.com/style/units-of-measure' -nonword: true -level: error -tokens: - - \d+(?:B|kB|MB|GB|TB) - - \d+(?:ns|ms|s|min|h|d) diff --git a/.styles/Google/We.yml b/.styles/Google/We.yml deleted file mode 100644 index c7ac7d3622..0000000000 --- a/.styles/Google/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: 'https://developers.google.com/style/pronouns#personal-pronouns' -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/.styles/Google/Will.yml b/.styles/Google/Will.yml deleted file mode 100644 index 128a918362..0000000000 --- a/.styles/Google/Will.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Avoid using '%s'." -link: 'https://developers.google.com/style/tense' -ignorecase: true -level: warning -tokens: - - will diff --git a/.styles/Google/WordList.yml b/.styles/Google/WordList.yml deleted file mode 100644 index bb711517e6..0000000000 --- a/.styles/Google/WordList.yml +++ /dev/null @@ -1,80 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: 'https://developers.google.com/style/word-list' -level: warning -ignorecase: false -action: - name: replace -swap: - '(?:API Console|dev|developer) key': API key - '(?:cell ?phone|smart ?phone)': phone|mobile phone - '(?:dev|developer|APIs) console': API console - '(?:e-mail|Email|E-mail)': email - '(?:file ?path|path ?name)': path - '(?:kill|terminate|abort)': stop|exit|cancel|end - '(?:OAuth ?2|Oauth)': OAuth 2.0 - '(?:ok|Okay)': OK|okay - '(?:WiFi|wifi)': Wi-Fi - '[\.]+apk': APK - '3\-D': 3D - 'Google (?:I\-O|IO)': Google I/O - 'tap (?:&|and) hold': touch & hold - 'un(?:check|select)': clear - above: preceding - account name: username - action bar: app bar - admin: administrator - Ajax: AJAX - Android device: Android-powered device - android: Android - API explorer: APIs Explorer - application: app - approx\.: approximately - authN: authentication - authZ: authorization - autoupdate: automatically update - cellular data: mobile data - cellular network: mobile network - chapter: documents|pages|sections - check box: checkbox - check: select - CLI: command-line tool - click on: click|click in - Cloud: Google Cloud Platform|GCP - Container Engine: Kubernetes Engine - content type: media type - curated roles: predefined roles - data are: data is - Developers Console: Google API Console|API Console - disabled?: turn off|off - ephemeral IP address: ephemeral external IP address - fewer data: less data - file name: filename - firewalls: firewall rules - functionality: capability|feature - Google account: Google Account - Google accounts: Google Accounts - Googling: search with Google - grayed-out: unavailable - HTTPs: HTTPS - in order to: to - ingest: import|load - k8s: Kubernetes - long press: touch & hold - network IP address: internal IP address - omnibox: address bar - open-source: open source - overview screen: recents screen - regex: regular expression - SHA1: SHA-1|HAS-SHA1 - sign into: sign in to - sign-?on: single sign-on - static IP address: static external IP address - stylesheet: style sheet - synch: sync - tablename: table name - tablet: device - touch: tap - url: URL - vs\.: versus - World Wide Web: web diff --git a/.styles/Google/meta.json b/.styles/Google/meta.json deleted file mode 100644 index a5da2a8480..0000000000 --- a/.styles/Google/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Google/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/.styles/Google/vocab.txt b/.styles/Google/vocab.txt deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/.styles/Vocab/Base/accept.txt b/.styles/Vocab/Base/accept.txt deleted file mode 100644 index 544011f063..0000000000 --- a/.styles/Vocab/Base/accept.txt +++ /dev/null @@ -1,64 +0,0 @@ -viewport -[Tt]ooltip -SDKs -100ms -Giphy -Angular -React -API -timeframe -APNs -Telehealth -Xcode -UI -memoize -memoization -bundler -config -iMessage -react -typings -serializable -Upserts -Unsets -SDK's -SDKs -Worklet -aiba -(nl) -(ru) -(ko) -namespace -falsy -iCloud -jetifier -npm -Notifee -colorScheme -performant -virtualized -rncli -RNCLI -CDNs -haptics -async -Podfile -pickFile -onChange -pressable -Pressable -boolean -Async -subscribable -memoizing -Boolean -draggable -sendMessage -overridable -loadMore -pollAnswers -enum -SendMessage -interop -bridgeless -resizer \ No newline at end of file diff --git a/.styles/Vocab/Base/reject.txt b/.styles/Vocab/Base/reject.txt deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/.vale.ini b/.vale.ini deleted file mode 100644 index 115f33b4a0..0000000000 --- a/.vale.ini +++ /dev/null @@ -1,17 +0,0 @@ -StylesPath = .styles - -MinAlertLevel = error -Vocab = Base - -Packages = Google - -# The "formats" section allows you to associate an "unknown" format -# with one of Vale's supported formats. -[formats] -mdx = md - -# Since we mapped `mdx` to `md` in the `formats`section we have to declare our format to be `md` -[*.md] -BasedOnStyles = Vale, Google -TokenIgnores = (^###.*),(^import .*;),(import .*;), (\{#[a-zA-Z].*?\}), (\*\*.*?\*\*), (src='.*?'), -BlockIgnores = (\n(.*\n)+
),(\| .* \|), (), () \ No newline at end of file diff --git a/package.json b/package.json index 79bed03fa5..94003a463d 100644 --- a/package.json +++ b/package.json @@ -31,8 +31,8 @@ "release-next": "yarn lerna-workspaces run release-next", "extract-changelog": "rm -rf NEXT_RELEASE_CHANGELOG.md && yarn lerna-workspaces run extract-changelog", "bootstrap": "yarn lerna-workspaces run bootstrap", - "lint": "yarn lerna-workspaces run lint && (cd docusaurus && npx prettier --check '**/*.mdx')", - "lint-fix": "yarn lerna-workspaces run lint-fix && (cd docusaurus && npx prettier --write '**/*.mdx')", + "lint": "yarn lerna-workspaces run lint", + "lint-fix": "yarn lerna-workspaces run lint-fix", "build": "yarn lerna-workspaces run build", "test:coverage": "yarn lerna-workspaces run test:coverage", "test:unit": "yarn lerna-workspaces run test:unit", diff --git a/package/.eslintignore b/package/.eslintignore index 4835dc2cf7..792b2f2404 100644 --- a/package/.eslintignore +++ b/package/.eslintignore @@ -6,4 +6,3 @@ vendor/ *.md src/components/docs/ lib/ -docusaurus/ \ No newline at end of file