From d8060871a78fd86bfd23b62efe609f310859b0d2 Mon Sep 17 00:00:00 2001
From: Pete Lumbis <pete@upbound.io>
Date: Wed, 26 Jul 2023 21:17:35 -0400
Subject: [PATCH] breakout terms into unique files and expand to cover more
 words

Signed-off-by: Pete Lumbis <pete@upbound.io>
---
 utils/vale/styles/Crossplane/Spelling.yml     | 10 +-
 .../vale/styles/Crossplane/allowed-jargon.txt | 55 +++++++++++
 utils/vale/styles/Crossplane/brands.txt       | 27 ++++++
 .../styles/Crossplane/crossplane-words.txt    | 52 ++++++++++
 .../vale/styles/Crossplane/provider-words.txt | 16 +++
 .../styles/Crossplane/spelling-exceptions.txt | 97 +++++++------------
 6 files changed, 196 insertions(+), 61 deletions(-)
 create mode 100644 utils/vale/styles/Crossplane/allowed-jargon.txt
 create mode 100644 utils/vale/styles/Crossplane/brands.txt
 create mode 100644 utils/vale/styles/Crossplane/crossplane-words.txt
 create mode 100644 utils/vale/styles/Crossplane/provider-words.txt

diff --git a/utils/vale/styles/Crossplane/Spelling.yml b/utils/vale/styles/Crossplane/Spelling.yml
index f1b62374..42d21249 100644
--- a/utils/vale/styles/Crossplane/Spelling.yml
+++ b/utils/vale/styles/Crossplane/Spelling.yml
@@ -8,6 +8,14 @@
 # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
 extends: spelling
 message: 'Spelling check: "%s"?'
-level: warning
+level: error
+custom: true
 ignore:
   - Crossplane/spelling-exceptions.txt
+  - Crossplane/brands.txt
+  - Crossplane/crossplane-words.txt
+  - Crossplane/provider-words.txt
+  - Crossplane/allowed-jargon.txt
+filters:
+  - v\d\.\d\d
+  - \/.*
\ No newline at end of file
diff --git a/utils/vale/styles/Crossplane/allowed-jargon.txt b/utils/vale/styles/Crossplane/allowed-jargon.txt
new file mode 100644
index 00000000..bc740bd2
--- /dev/null
+++ b/utils/vale/styles/Crossplane/allowed-jargon.txt
@@ -0,0 +1,55 @@
+API's
+APIs
+bool
+boolean
+booleans
+CUE
+Enum
+Env
+JSONPath
+kubeconfig
+kubectl
+minikube
+namespace
+namespaced
+namespaces
+proselint
+semver
+shortcode
+shortcodes
+ESS
+SLAs
+stdin
+stdout
+Subnet
+subnet
+subnets
+Substrings
+OCI
+syscall
+tolerations
+VM
+32-bit
+64-bit
+float64
+SHA-1
+SHA-256
+SHA-512
+base64
+RBAC
+ServiceAccounts
+ServiceAccount
+ClusterRole
+ClusterRoles
+key-pair
+CI
+command-line
+YAML
+CSS
+SCSS
+docs-specific
+CRD
+CLI
+kube-controller-manager
+kube-apiserver
+cluster-wide
\ No newline at end of file
diff --git a/utils/vale/styles/Crossplane/brands.txt b/utils/vale/styles/Crossplane/brands.txt
new file mode 100644
index 00000000..0aa8b7e0
--- /dev/null
+++ b/utils/vale/styles/Crossplane/brands.txt
@@ -0,0 +1,27 @@
+Bootstrap
+Geekdocs
+Grammarly
+HashiCorp
+Kustomize
+Netlify
+OpenAPI
+OpenAPIv3
+PostgreSQL
+Upbound
+Upbound's
+Upjet
+Velero
+VSCode
+Webpack
+Zendesk
+write-good
+CNCF
+CC-BY
+Commonmark
+Goldmark
+PostCSS
+postcss-lightningcss
+PurgeCSS
+postcss-sort-media-queries
+NPM
+instant.page
\ No newline at end of file
diff --git a/utils/vale/styles/Crossplane/crossplane-words.txt b/utils/vale/styles/Crossplane/crossplane-words.txt
new file mode 100644
index 00000000..dc4df2fd
--- /dev/null
+++ b/utils/vale/styles/Crossplane/crossplane-words.txt
@@ -0,0 +1,52 @@
+clampMax
+clampMin
+CompositeResourceDefinition
+CompositeResourceDefinitions
+CRDs
+Crossplane
+Crossplane's
+EnvironmentConfig
+EnvironmentConfigs
+external-name
+finalizer
+finalizers
+ProviderConfig
+XCluster
+XNetwork
+xpkg
+XRD
+XRD's
+XRDs
+XRs
+XR
+XRC
+ControllerConfig
+ProviderConfigs
+StoreConfig
+PatchSet
+PatchSets
+FromCompositeFieldPath
+ToCompositeFieldPath
+CombineFromComposite
+CombineToComposite
+FromEnvironmentFieldPath
+ToEnvironmentFieldPath
+CombineFromEnvironment
+CombineToEnvironment
+TrimPrefix
+TrimSuffix
+fromFieldPath
+ControllerConfigs
+UnknownPackageRevisionHealth
+StoreConfigs
+crossplane-admin
+UnhealthyPackageRevision
+ActivePackageRevision
+crossplane-edit
+HealthyPackageRevision
+crossplane-view
+crossplane-browse
+InactivePackageRevision
+crossplane.yaml
+definition.yaml
+composition.yaml
\ No newline at end of file
diff --git a/utils/vale/styles/Crossplane/provider-words.txt b/utils/vale/styles/Crossplane/provider-words.txt
new file mode 100644
index 00000000..32a3799b
--- /dev/null
+++ b/utils/vale/styles/Crossplane/provider-words.txt
@@ -0,0 +1,16 @@
+Dataflow
+EC2
+EKS
+GCP's
+S3
+VPC
+GKE
+provider-aws-s3
+GCP
+provider-aws-iam
+DynmoDB
+Pub/Sub
+europe-central2
+us-central1
+eu-north-1
+us-east-2
\ No newline at end of file
diff --git a/utils/vale/styles/Crossplane/spelling-exceptions.txt b/utils/vale/styles/Crossplane/spelling-exceptions.txt
index 98217a1a..d7e28096 100644
--- a/utils/vale/styles/Crossplane/spelling-exceptions.txt
+++ b/utils/vale/styles/Crossplane/spelling-exceptions.txt
@@ -1,62 +1,39 @@
-API's
-APIs
-bool
-boolean
-booleans
-Bootstrap
-clampMax
-clampMin
 conformant
-CRDs
-Crossplane
-Crossplane's
-CUE
-Dataflow
-Datastore
-editCode
-Enum
-Env
-finalizer
-finalizers
-GCP's
-Geekdocs
-Grammarly
-HashiCorp
-JSONPath
-kubeconfig
-kubectl
-Kustomize
-minikube
-namespace
-namespaced
-namespaces
-Netlify
-PostgreSQL
-proselint
-semver
-shortcode
-shortcodes
-SLAs
-stdin
-stdout
-Subnet
-subnet
-subnets
-Substrings
-syscall
-tolerations
+cross-reference
+Cross-resource
+cross-resource
+per-object
+per-resource
+pre-existing
+pre-provisioned
+top-level
 untrusted
-Upbound
-Upbound's
-Upjet
-Velero
-VSCode
-Webpack
-XCluster
-XNetwork
-xpkg
-XRD
-XRD's
-XRDs
-XRs
-Zendesk
\ No newline at end of file
+UpperCamelCase
+UpperCamelCased
+in-memory
+non-empty
+resource-specific
+race-conditions
+user-defined
+poll-interval
+double-check
+double-checks
+read-only
+non-Kubernetes
+comma-seperated
+in-depth
+how-to
+version-specific
+step-by-step
+free-form
+left-hand
+right-hand
+call-outs
+/tab
+/tabs
+per-element
+run-time
+hands-on
+dry-run
+end-points
+multi-region
\ No newline at end of file