diff --git a/.github/vale/config/vocabularies/Mintlify/accept.txt b/.github/vale/config/vocabularies/Mintlify/accept.txt new file mode 100644 index 00000000..8c1e0696 --- /dev/null +++ b/.github/vale/config/vocabularies/Mintlify/accept.txt @@ -0,0 +1,267 @@ +Mintlify +mintlify +VSCode +openapi +OpenAPI +Github +APIs + +repo +npm +dev + +Lorem +ipsum +impsum +amet + +const +myName +myObject +bearerAuth +favicon +topbar +url +borderRadius +args +modeToggle +ModeToggle +isHidden +autoplay + +_italic_ +Strikethrough +Blockquotes +Blockquote +Singleline +Multiline + +onboarding + +async +await +boolean +enum +func +impl +init +instanceof +typeof +params +stdin +stdout +stderr +stdout +stdin +var +const +let +null +undefined +struct +bool + +cors +csrf +env +xhr +xhr2 +jwt +oauth +websocket +localhost +middleware +runtime +webhook +stdin +stdout + +json +yaml +yml +md +txt +tsx +jsx +css +scss +html +png +jpg +svg + +cdn +cli +css +dom +dto +env +git +gui +http +https +ide +jvm +mvc +orm +rpc +sdk +sql +ssh +ssl +tcp +tls +uri +url +ux +ui + +nodejs +npm +yarn +pnpm +eslint +pytest +golang +rustc +kubectl +mongo +postgres +redis + +JavaScript +TypeScript +Python +Ruby +Rust +Go +Golang +Java +Kotlin +Swift +Node.js +NodeJS +Deno + +React +Vue +Angular +Next.js +Nuxt +Express +Django +Flask +Spring +Laravel +Redux +Vuex +TensorFlow +PostgreSQL +MongoDB +Redis +PNPM + +Docker +Kubernetes +AWS +Azure +GCP +Terraform +Jenkins +CircleCI +GitLab +Heroku + +Git +git +GitHub +GitLab +Bitbucket +VSCode +Visual Studio Code +IntelliJ +WebStorm +ESLint +eslint +Prettier +prettier +Webpack +webpack +Vite +vite +Babel +babel +Jest +jest +Mocha +Cypress +Postman + +HTTP +HTTPS +OAuth +JWT +GraphQL +REST +WebSocket +TCP/IP + +NPM +Yarn +PNPM +Pip +PIP +Cargo +RubyGems + +Swagger +OpenAPI +Markdown +MDX +Storybook +TypeDoc +JSDoc + +MySQL +PostgreSQL +MongoDB +Redis +Elasticsearch +DynamoDB + +Linux +Unix +macOS +iOS + +Firefox +Chromium +WebKit + +config +ctx +desc +dir +elem +err +len +msg +num +obj +prev +proc +ptr +req +res +str +tmp +val +vars + +todo +href +lang +nav +prev +next +toc \ No newline at end of file diff --git a/.github/vale/config/vocabularies/PowerSync/accept.txt b/.github/vale/config/vocabularies/PowerSync/accept.txt new file mode 100644 index 00000000..5f53f1ce --- /dev/null +++ b/.github/vale/config/vocabularies/PowerSync/accept.txt @@ -0,0 +1,126 @@ +# Terms +dev +subnet +subnets +hostname +config +serverless +failover +schemaless +sharded +sharding +pooler +binlog +walkthrough +denormalize +denormalization +defragment +defragmenting +defragmentation +hotfix +wifi +polyfill +polyfills +agnostically +websockets +uncomment +Podfile +Pubspec +realtime +signups +slidable +nullable +compilable +composables +uncheck +todo +todos +todolists +hardcode +hardcoding +teardown +lookups +unsynced +repo +repos +monorepo +retryable +pdf +deduplicate +geo +subqueries +deprovisioned +liveness + +# Acronyms +UUID +UUIDs +SDK +SDKs +SLA +SLAs +DAU +DAUs +API +APIs +URI +URIs +VPC +VPCs +CRDT +CRDTs +ORM +ORMs +IPs +JWT +JWTs + +# Code terms +jsonb +varchar +uuid +timestamptz +datetime +unixepoch +subsec +macaddr +inet +bytea +DBPointer +replicaset +clusterTime +cacert +jwks_uri +listitem +client_auth + +# Products/Companies +Power[Ss]ync +Supabase +Postgres +PostgreSQL +Coolify +Netlify +Vue +Kotlin +Multiplatform +Kysely +Stytch +Xcode +Cocoapods +MySQL +Ngrok +Tamagui +Prisma +Tauri +shadcn +Jepsen +WorkManager +SQLCipher +RSocket +KMMBridge +Yjs +Gradle +npx +cron +nginx \ No newline at end of file diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000..3a6d9a38 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,27 @@ +# Top level styles +StylesPath=.github/vale +MinAlertLevel = suggestion +IgnoredScopes = code, tt, img, url, a +SkippedScopes = script, style, pre, figure, code + +# Vocabularies +Vocab = Mintlify, PowerSync + +# This is required since Vale doesn't officially support MDX +[formats] +mdx = md + +# MDX support +[*.mdx] +BasedOnStyles = Vale +Vale.Terms = NO # Enforces really harsh capitalization rules, keep off + +TokenIgnores = (?sm)((?:import|export) .+?$), \ +(?)(?!`), \ +(<[A-Z]\w+>.+?<\/[A-Z]\w+>) + +# Exclude: +BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \ +(?sm)^({.+.*}) + +CommentDelimiters = {/*, */} \ No newline at end of file