diff --git a/.github/workflows/check-vale.yml b/.github/workflows/check-vale.yml deleted file mode 100644 index 8f19f22b7e..0000000000 --- a/.github/workflows/check-vale.yml +++ /dev/null @@ -1,35 +0,0 @@ -name: Check - Vale - -on: - push: - branches: - - main - paths: - - 'docs/**' - - 'blog/**' - - '.vale.ini' - - '.vale/**' - pull_request: - paths: - - 'docs/**' - - 'blog/**' - - '.vale.ini' - - '.vale/**' - -jobs: - vale: - name: Vale linting - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v6 - - - name: Vale Linter - uses: errata-ai/vale-action@reviewdog - with: - files: docs - reporter: github-pr-review - fail_on_error: false - vale_flags: "--config=.vale.ini" - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.vale.ini b/.vale.ini deleted file mode 100644 index ceae9724ab..0000000000 --- a/.vale.ini +++ /dev/null @@ -1,48 +0,0 @@ -StylesPath = .vale/styles -MinAlertLevel = suggestion - -Vocab = Codat - -Packages = Google - -# Global ignores - skip frontmatter -[formats] -mdx = md - -# File patterns -[*.{md,mdx}] -BasedOnStyles = Vale, Google - -# Disable rules that conflict with technical docs or MDX -# Acronyms - too noisy for API docs -Google.Acronyms = NO -# Allow "we" in company documentation -Google.We = NO -# Spacing rule has false positives with MDX components -Google.Spacing = NO -# Semicolons in code references cause false positives -Google.Semicolons = suggestion - -# Demote some rules to suggestions rather than warnings -Google.Headings = suggestion -Google.Parens = suggestion -Google.Passive = suggestion -Google.Will = suggestion -Google.FirstPerson = suggestion -Google.Exclamation = suggestion -Google.Colons = suggestion -Google.Quotes = suggestion - -# Vale built-in rules -Vale.Spelling = NO -Vale.Terms = YES - -# Ignore code blocks, frontmatter, and JSX -BlockIgnores = (?s) *```.*?```, (?s)^---.*?--- -TokenIgnores = (`[^`]+`), (\{[^}]+\}), (<[A-Z][^>]*>.*?]*>), (<[A-Z][^/>]*/?>) - -[*.yml] -BasedOnStyles = - -[*.json] -BasedOnStyles = diff --git a/.vale/styles/Google/AMPM.yml b/.vale/styles/Google/AMPM.yml deleted file mode 100644 index 37b49edf87..0000000000 --- a/.vale/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\b' - - '\d{1,2} ?[ap]m\b' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.vale/styles/Google/Acronyms.yml b/.vale/styles/Google/Acronyms.yml deleted file mode 100644 index f41af0189b..0000000000 --- a/.vale/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/.vale/styles/Google/Colons.yml b/.vale/styles/Google/Colons.yml deleted file mode 100644 index 4a027c307d..0000000000 --- a/.vale/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: - - '(?=1.0.0" -} diff --git a/.vale/styles/Google/vocab.txt b/.vale/styles/Google/vocab.txt deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/.vale/styles/config/vocabularies/Codat/accept.txt b/.vale/styles/config/vocabularies/Codat/accept.txt deleted file mode 100644 index fca2be8ee8..0000000000 --- a/.vale/styles/config/vocabularies/Codat/accept.txt +++ /dev/null @@ -1,98 +0,0 @@ -API -APIs -BACS -BigCommerce -Capchase -Chargebee -Codat -Codat's -datasource -datasources -datatype -datatypes -deauthorization -deauthorized -decisioning -drawdowns -eCommerce -endpoint -endpoints -FreshBooks -IBAN -Intacct -Intacct's -Intuit -Intuit's -Lightspeed -Maxio -metadata -MYOB -neobanks -NetSuite -Pandle -payables -Phorest -PrestaShop -QuickBooks -recategorization -recategorize -recategorizing -Recurly -SDK -SDKs -Svix -TrueLayer -TrueLayer's -usecase -usecases -Wayflyer -webhook -webhooks -writeback -Xero -Xero's -Zettle -frontmatter -codeblock -codeblocks -async -OAuth -iframe -dropdown -multi-select -multi-currency -onboarding -config -repo -repos -changelog -Presta -financials -serverless -subdomain -subdomains -idempotency -boolean -booleans -nullable -enum -enums -timestamp -timestamps -hostname -param -params -JSON -UUID -UUIDs -SMB -SMBs -lender -lenders -fintech -fintechs -Plaid -Stripe -Chargebee -SaaS -GraphQL diff --git a/.vale/styles/config/vocabularies/Codat/reject.txt b/.vale/styles/config/vocabularies/Codat/reject.txt deleted file mode 100644 index 9e624d956f..0000000000 --- a/.vale/styles/config/vocabularies/Codat/reject.txt +++ /dev/null @@ -1,7 +0,0 @@ -# Words to reject/flag -# Add terms that should never appear in docs -blacklist -whitelist -master -slave -sanity check diff --git a/package.json b/package.json index cc03446159..67792aa755 100644 --- a/package.json +++ b/package.json @@ -20,9 +20,6 @@ "format:mdx": "prettier --write \"**/*.{md,mdx}\"", "format:mdx:check": "prettier --check \"**/*.{md,mdx}\"", "links:check": "linkinator ./build --recurse --verbosity error --timeout 20000 --concurrency 25 --retry --skip \".*github.*\" --skip \"https://docs.codat.io\"", - "vale:sync": "vale sync", - "vale": "vale docs/", - "vale:check": "vale --minAlertLevel=warning docs/", "prepare": "husky" }, "dependencies": {