chore: fix vale suggestions (#273)

* chore: fix vale suggestions * fix: prettier suggestions
flanksource · Sep 5, 2024 · 669e846 · 669e846
1 parent cf02e80
commit 669e846
Show file tree

Hide file tree

Showing 26 changed files with 42 additions and 34 deletions.
diff --git a/canary-checker/docs/comparison.md b/canary-checker/docs/comparison.md
@@ -15,6 +15,8 @@ Canary checker can replace the following exporters:
 | [github_actions_exporter](https://github.com/cpanato/github_actions_exporter)                                                                                                         |                           |             |
 | [filestat_exporter](https://github.com/michael-doubez/filestat_exporter)                                                                                                              |                           |             |
 
+<!-- vale off -->
+
 ### Prometheus Alert Manager
 
 ### Blackbox Exporter
@@ -36,3 +38,5 @@ Kuberhealthy serves the status of all checks on a simple JSON status page, a [Pr
 https://cloudprober.org/
 
 ### Karma Alert Dashboard
+
+<!-- vale on -->
diff --git a/canary-checker/docs/comparisons/blackbox-exporter.md b/canary-checker/docs/comparisons/blackbox-exporter.md
@@ -1,6 +1,6 @@
 # Canary-Checker vs Prometheus blackbox exporter
 
-[Prometheus Blackbox Exporter](https://github.com/prometheus/blackbox_exporter) is a prometheus exporter for probing HTTP, HTTPS, DNS, TCP, ICMP and gRPC.
+[Prometheus Blackbox Exporter](https://github.com/prometheus/blackbox_exporter) is a prometheus exporter for probing HTTP, HTTPS, DNS, TCP, ICMP, and gRPC.
 
 |                     | Blackbox Exporter                                                                              | Canary Checker                                                                                                         |
 | ------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |

diff --git a/canary-checker/docs/concepts/_artifacts.md b/canary-checker/docs/concepts/_artifacts.md
@@ -14,7 +14,7 @@ Artifacts allow you to archive files generated by some checks to a file store of
 
 ## Setting up artifact store
 
-One of the above Filestores can be used as the global artifact store. To setup an artifact store, pass the connection name of the store using the `artifact-connection` flag. If the artifact connection isn't setup, the artifacts are simply ignored.
+One of the above Filestores can be used as the global artifact store. To setup an artifact store, pass the connection name of the store using the `artifact-connection` flag. If the artifact connection isn't setup, the artifacts are ignored.
 
 Example:
 
@@ -70,7 +70,7 @@ artifacts
 
 ### Ex2. Archiving artifacts from stdout/stderr
 
-The path field accepts two special paths
+The path field accepts two paths:
 
 - `/dev/stdout`
 - `/dev/stderr`

diff --git a/canary-checker/docs/concepts/expressions/_transform_fields.mdx b/canary-checker/docs/concepts/expressions/_transform_fields.mdx
@@ -17,7 +17,7 @@
     field: "invalid",
     description: "Set to true if the check is not configured correctly, and can never pass",
     scheme: "bool",
-      priority: 2,
+    priority: 2,
     required: false
   },
     {
@@ -37,7 +37,7 @@
   },
   {
     field: "duration",
-    description: "Time in ms to use for the duration of the check",
+    description: "Time in ms for duration of the check",
     scheme: "int64",
     priority: 2,
     required: false
@@ -53,7 +53,7 @@
 
   {
     field: "name",
-    description: "Name of the check to use, the name will be used to lookup existing checks to update",
+    description: "Name of the check to use, the name is used to lookup existing checks to update",
     priority: 2,
     scheme: "string",
     required: true

diff --git a/canary-checker/docs/concepts/expressions/display-formatting.md b/canary-checker/docs/concepts/expressions/display-formatting.md
@@ -74,7 +74,7 @@ spec:
 ```
 
 :::info
-Do not return anything from the function, e.g. instead of `return "hello" + "world"` use just `"hello" + "world"`
+Do not return anything from the function, e.g. instead of `return "hello" + "world"` use `"hello" + "world"`
 :::
 
 See <CommonLink to="javascript">JavaScript</CommonLink> for more details and a function reference.

diff --git a/canary-checker/docs/concepts/expressions/health-evaluation.md b/canary-checker/docs/concepts/expressions/health-evaluation.md
@@ -5,7 +5,7 @@ title: Health Evaluation
 All checks expose a health stats of passing (Green) or failing (Red), for example the HTTP check fails if the status is `200 >= code < 299`
 these default behaviors can be changed using the `test` field:
 
-In the example below the http check will fail if the SSL certificate expiry age is below 7 days
+In the example below the http check fails if the SSL certificate expiry age is below 7 days
 
 ```yaml title=http-check-expr.yaml
 apiVersion: canaries.flanksource.com/v1

diff --git a/canary-checker/docs/concepts/expressions/transforms.mdx b/canary-checker/docs/concepts/expressions/transforms.mdx
@@ -4,8 +4,6 @@ title: Transformation
 
 import TransformFields from './_transform_fields.mdx'
 
-
-
 The `transform` can be used to convert one canary check into multiple checks programmatically.
 
 ```yaml
@@ -36,11 +34,11 @@ spec:
           JSON.stringify(out);
 ```
 
-In the above example, the check will return multiple alerts from alertmanager. By default, all of those alerts will be grouped in a single check.
+In the above example, the check returns multiple alerts from alertmanager. By default, all those alerts are grouped in a single check.
 
 But if we want to display each alert as its own check in the UI, we can use the `transform` function for this. The transform function takes a `Template` as input and the output from the template expected are the checks in JSON format.
 
-For example, if there are 9 different alerts, each alert will have its own check that can be managed and interacted with equally.
+For example, if there are 9 different alerts, each alert has its own check that can be managed and interacted with equally.
 
 <TransformFields/>
 

diff --git a/canary-checker/docs/concepts/metrics/stateful-metrics.md b/canary-checker/docs/concepts/metrics/stateful-metrics.md
@@ -80,7 +80,7 @@ metadata:
           : '{}'
 ```
 
-This snippet will retrieve the `last_result.results.max` value from the last execution ensuring data is not duplicated or missed
+This snippet retrieves the `last_result.results.max` value from the last execution ensuring data is not duplicated or missed
 
 ```go
 "@timestamp" : {

diff --git a/canary-checker/docs/concepts/secret-management.md b/canary-checker/docs/concepts/secret-management.md
@@ -151,7 +151,7 @@ spec:
 ```
 
 :::note
-For service account token issuing the canary-checker service account `canary-checker-sa` will need to be granted permissions to issue tokens using:
+For service account token issuing the canary-checker service account `canary-checker-sa` needs to be granted permissions to issue tokens using:
 
 ```yaml
 apiVersion: rbac.authorization.k8s.io/v1

diff --git a/canary-checker/docs/examples/k6.mdx b/canary-checker/docs/examples/k6.mdx
@@ -31,7 +31,7 @@ spec:
             command: ["/start.sh"]
 ```
 
-Using the [k6-junit](https://github.com/l-ross/k6-junit) utility to export JUnit results to the `testResults` folder, canary-checker will pick up the results and make then available display formating and health evaluation.
+Using the [k6-junit](https://github.com/l-ross/k6-junit) utility to export JUnit results to the `testResults` folder, canary-checker picks up the results and make then available display formatting and health evaluation.
 
 ```bash title="start.sh"
 mkdir -p /tmp/junit-results

diff --git a/canary-checker/docs/examples/newman.mdx b/canary-checker/docs/examples/newman.mdx
@@ -32,7 +32,7 @@ spec:
             command: ["/start.sh"]
 ```
 
-By configuring newman to export JUnit to the `testResults` folder, canary-checker will pick up the results and make then available display formatting and health evaluation.
+By configuring newman to export JUnit to the `testResults` folder, canary-checker picks up the results and make then available display formatting and health evaluation.
 
 ```bash title="start.sh"
 set -x

diff --git a/canary-checker/docs/examples/playwright.mdx b/canary-checker/docs/examples/playwright.mdx
@@ -32,7 +32,7 @@ spec:
             command: ["/start.sh"]
 ```
 
-By configuring playwright to export JUnit to the `testResults` folder, canary-checker will pick up the results and make then available display formatting and health evaluation.
+By configuring playwright to export JUnit to the `testResults` folder, canary-checker picks up the results and make then available display formatting and health evaluation.
 
 ```bash title="start.sh"
 mkdir -p /tmp/junit-results

diff --git a/canary-checker/docs/examples/sftp.mdx b/canary-checker/docs/examples/sftp.mdx
@@ -4,7 +4,7 @@ title: SFTP Connection
 
 # <Icon name="sftp" /> SFTPConnection
 
-Checks the contents of a folder over SFTP for size, age and count.
+Checks the contents of a folder over SFTP for size, age, and count.
 
 See [Folder](../reference/folder) for a full description.
 

diff --git a/canary-checker/docs/examples/smb.mdx b/canary-checker/docs/examples/smb.mdx
@@ -4,7 +4,7 @@ title: SMB/CIFS
 
 # <Icon name="smb" /> Windows File Share (SMB/CIFS)
 
-Checks the contents of a Windows / CIFS file share for size, age and count.
+Checks the contents of a Windows / CIFS file share for size, age, and count.
 
 See [Folder](../reference/folder) for a full description.
 

diff --git a/canary-checker/docs/reference/1-elasticsearch.mdx b/canary-checker/docs/reference/1-elasticsearch.mdx
@@ -4,7 +4,7 @@ title: Elasticsearch
 
 # <Icon name="elasticsearch" /> ElasticSearch
 
-This check will try to connect to a specified ElasticSearch database, run a query against it and verify the results.
+This check connects to a specified ElasticSearch database, run a query against it and verify the results.
 
 :::info Opensearch
 To connect to Opensearch use `opensearch` field instead of `elasticsearch`

diff --git a/canary-checker/docs/scripting/_functions.md b/canary-checker/docs/scripting/_functions.md
@@ -62,7 +62,7 @@ Functions in scripts are a combination of gomplate and sprig
 | [time.Now](https://docs.gomplate.ca/functions/time/#timenow)                                                                                        |                                                                                                                                                                                           |                                                              |
 | [time.Parse](https://docs.gomplate.ca/functions/time/#timeparse)                                                                                    | Parses a timestamp defined by the given layout                                                                                                                                            |                                                              |
 | [time.ParseDuration](https://docs.gomplate.ca/functions/time/#timeparseduration)                                                                    | Parses a duration string. This wraps [`time.ParseDuration`](https://golang.org/pkg/time/#ParseDuration).                                                                                  |                                                              |
-| [time.Since](https://docs.gomplate.ca/functions/time/#timesince)                                                                                    | Returns the time elapsed since a given tim                                                                                                                                                |                                                              |
+| [time.Since](https://docs.gomplate.ca/functions/time/#timesince)                                                                                    | Returns the time elapsed since a given time                                                                                                                                               |                                                              |
 | [time.Unix](https://docs.gomplate.ca/functions/time/#timeunix)                                                                                      | Returns the local `Time` corresponding to the given Unix time                                                                                                                             |                                                              |
 | [time.Until](https://docs.gomplate.ca/functions/time/#timeuntil)                                                                                    | Returns the duration until a given time.                                                                                                                                                  |                                                              |
 | [uuid.V1](https://docs.gomplate.ca/functions/uuid/#uuidv1)                                                                                          | Create a version 1 UUID                                                                                                                                                                   |                                                              |

diff --git a/canary-checker/docs/scripting/javascript.md b/canary-checker/docs/scripting/javascript.md
@@ -27,7 +27,7 @@ spec:
 ```
 
 :::tip Troubleshooting
-You can print to the console for rapid development e.g. `console.log(JSON.stringify(json))`, this will only be shown in the logs
+You can print to the console for rapid development e.g. `console.log(JSON.stringify(json))`, this is only shown in the logs
 :::
 
 ### Underscore

diff --git a/canary-checker/docs/troubleshooting.mdx b/canary-checker/docs/troubleshooting.mdx
@@ -25,7 +25,7 @@ Depending on the check this might include:
 - Access to cloud APIs, such as AWS, GCP or Azure API interfaces
 - Locally installed binaries invoked by `exec` scripts
 
-The following local settings will affect the permissions available for use by the canary-checker executable:
+The following local settings affects the permissions available for use by the canary-checker executable:
 
 - The active kubectl context as specified in `KUBECONFIG`
 - The AWS profile specified in `AWS_DEFAULT_PROFILE` or `AWS_PROFILE`, or the AWS credentials specified by `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
@@ -51,7 +51,7 @@ canary-checker run -v test-canary.yaml
 ```
 </Step>
 
-## Trigger a run fom the CLI
+## Trigger a run from the CLI
 
 
 To run a canary outside of its normal schedule add the `next-runtime` annotation:
@@ -90,7 +90,7 @@ which results in an output similar to the below:
 ![](/img/trace-screenshot.png)
 
 :::danger Sensitive Data & Excessive Logging
-Trace level logging will return the HTTP response body which may contain sensitive data (The authorization headers will be sanitized)
+Trace level logging returns the HTTP response body which may contain sensitive data (The authorization headers will be sanitized)
 :::
 
 **Trace Levels**
@@ -126,7 +126,7 @@ Database level logging can be enabled using `--db-log-level`
 | `debug` (1) | Print SQL statements without parameters |
 | `trace` (2) | Print SQL statements with parameters    |
 
-And Kubernetes Operator loggined with `--k8s-log-level`
+And Kubernetes Operator logging with `--k8s-log-level`
 
 | Level       | Description                             |
 | :---------- | :-------------------------------------- |

diff --git a/canary-checker/docs/windows.md b/canary-checker/docs/windows.md
@@ -29,7 +29,7 @@ Invoke-WebRequest -Uri https://github.com/flanksource/canary-checker/blob/master
 
 ### (Optional)
 
-If you require a [specific version of Canary Checker](https://github.com/flanksource/canary-checker/releases) or want to build your own to test, place the executable in the same folder as the required powershell script above. Otherwise, the powershell install script will download the latest release.
+If you require a [specific version of Canary Checker](https://github.com/flanksource/canary-checker/releases) or want to build your own to test, place the executable in the same folder as the required powershell script above. Otherwise, the powershell install script downloads the latest release.
 
 ## 3. Create a canary
 
@@ -57,7 +57,7 @@ To test our canary config without installing it, use the below
 
 ## 4. Install Canary Checker as a service
 
-The powershell install script is able to download all requirements , if the windows machine does not have internet access you will need to manually download the [prerequisites](/##-1.-check-prerequisites) and place them in the script folder.
+The powershell install script is able to download all requirements, if the windows machine does not have internet access you might need to manually download the [prerequisites](/##-1.-check-prerequisites) and place them in the script folder.
 
 ```
 .\install-service.ps1 -configfile .\canary-checker.yaml -operation install

diff --git a/modules/canary-checker b/modules/canary-checker
diff --git a/modules/config-db b/modules/config-db
diff --git a/modules/duty b/modules/duty
diff --git a/modules/mission-control b/modules/mission-control
diff --git a/styles/Flanksource/Ablist.yml b/styles/Flanksource/Ablist.yml
@@ -111,7 +111,8 @@ swap:
   insomniacs: people who have insomnia
   intellectually disabled: person with an intellectual disability
   intellectually disabled people: people with intellectual disabilities
-  invalid: turned off|has a disability|person with a disability|people with disabilities
+  # Disabling this as this is a field
+  # invalid: turned off|has a disability|person with a disability|people with disabilities
   junkie: person with a drug addiction|person recovering from a drug addiction
   junkies: people with a drug addiction|people recovering from a drug addiction
   lame: boring|dull

diff --git a/styles/Flanksource/ProfanityUnlikely.yml b/styles/Flanksource/ProfanityUnlikely.yml
@@ -100,7 +100,6 @@ tokens:
   - ethiopian
   - ethnic
   - european
-  - executed
   - executioner
   - explosion
   - fairies

diff --git a/styles/ignore/words-with-suggestions.txt b/styles/ignore/words-with-suggestions.txt
@@ -28,6 +28,7 @@ canary_check
 canary_check_duration
 canary_check_failed_count
 canary_check_info
+canary_check_success_count
 capitalizations
 Chartmuseum
 check_id
@@ -132,6 +133,7 @@ ignoredRules
 incidentcommander
 ingressHost
 ingressTimeout
+inlining
 insecure_tls
 ip
 javascript
@@ -337,3 +339,7 @@ responseCodes
 responseContent
 thresholdMillis
 maxSSLExpiry
+unencrypted
+etcd
+Bitnami
+imcp