Skip to content

Commit

Permalink
chore: upgrade Vale to 3.0.5
Browse files Browse the repository at this point in the history
Fix typos caught by error-level alerting for Repetition style violations.

Closes: #537
  • Loading branch information
beritou committed Jan 17, 2024
1 parent cb6d554 commit e6d70da
Show file tree
Hide file tree
Showing 15 changed files with 127 additions and 125 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/linting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
# v2.0.1
uses: errata-ai/vale-action@c4213d4de3d5f718b8497bd86161531c78992084
with:
version: 2.30.0
version: 3.0.5
files: '["docs/dev", "docs/src", "samples"]'
fail_on_error: true
filter_mode: nofilter
Expand Down
1 change: 0 additions & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Packages = Microsoft, write-good
BasedOnStyles = Vale, Lightbend, write-good

# Override the alert level of certain styles
Vale.Repetition = warning
Lightbend.Contractions = suggestion
Lightbend.Avoid = warning
write-good.So = suggestion
Expand Down
2 changes: 1 addition & 1 deletion build/license.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"**/*.yml",
"samples/*/*/lib/generated",
"sdk/test/*.desc",
"styles/Vocab/Base/",
"styles/config/vocabularies/Base",
"tck/generated",
"testkit/integration-test/proto.*"
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Actions are stateless functions that can be triggered by gRPC or HTTP calls. The
=== Entities
Stateful services encapsulate business logic in in Value Entities, Event Sourced Entities, or Replicated Entities. At runtime, command messages invoke operations on Entities. A command may only act on one Entity at a time.
Stateful services encapsulate business logic in Value Entities, Event Sourced Entities, or Replicated Entities. At runtime, command messages invoke operations on Entities. A command may only act on one Entity at a time.
TIP: To learn more about Kalix entities see xref:javascript:value-entity.adoc[Implement a Value Entity], xref:javascript:eventsourced.adoc[Implement an Event Sourced Entity], and xref:javascript:replicated-entity.adoc[Implement a Replicated Entity].
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/javascript/pages/eventsourced.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The following shows an example shopping cart definition in a `domain.proto` file
include::example$domain.proto[]
----

In this file, the `Cart` message represents the state snapshot, while `ItemAdded` and `ItemRemoved` are events. Note the event names are in past tense--events are facts, indisputable things that happened in the past. A fact never becomes false: after an item has been added to a shopping cart, it never becomes untrue that that item was added to the cart. It can be removed, but that doesn't change the fact that it was added, it only changes the current state of the cart. The names of events should always be in past tense to reflect the indisputable fact that they represent.
In this file, the `Cart` message represents the state snapshot, while `ItemAdded` and `ItemRemoved` are events. Note the event names are in past tense--events are facts, indisputable things that happened in the past. A fact never becomes false: after an item has been added to a shopping cart, it never becomes untrue that the item was added to the cart. It can be removed, but that doesn't change the fact that it was added, it only changes the current state of the cart. The names of events should always be in past tense to reflect the indisputable fact that they represent.

== Creating an entity

Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/javascript/pages/value-entity.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The `counter_api.proto` file defines the commands we can send to the Counter ser
include::example$valueentity-counter/proto/counter_api.proto[]
----
<1> Import the Kalix protobuf annotations, or options.
<2> Any classes generated from this protobuf file will be be nested in the package hierarchy: `com.example`.
<2> Any classes generated from this protobuf file will be nested in the package hierarchy: `com.example`.

<3> Protobuf messages describe the Commands that the service handles. They may contain other messages to represent structured data.
<4> Every Command must contain a `string` field that contains the entity ID and is marked with the `(kalix.field).entity_key` option.
Expand Down
4 changes: 1 addition & 3 deletions samples/js/js-replicated-entity-shopping-cart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d

## Developing

This project has a bare-bones skeleton service ready to go, but in order to adapt and extend it it may be useful to
read up on [developing services](https://docs.kalix.io/developing/index.html) and in
particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
This project has a bare-bones skeleton service ready to go, but to adapt and extend it, reading up on [developing services](https://docs.kalix.io/developing/index.html), especially the [JavaScript section](https://docs.kalix.io/javascript/index.html), may be useful.

## Prerequisites

Expand Down
4 changes: 1 addition & 3 deletions samples/js/js-valueentity-shopping-cart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d

## Developing

This project has a bare-bones skeleton service ready to go, but in order to adapt and
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
This project has a bare-bones skeleton service ready to go, but to adapt and extend it, reading up on [developing services](https://docs.kalix.io/developing/index.html), especially the [JavaScript section](https://docs.kalix.io/javascript/index.html), may be useful.

## Prerequisites

Expand Down
4 changes: 1 addition & 3 deletions samples/js/valueentity-counter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d

## Developing

This project has a functioning service ready to adapt and
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
This project has a bare-bones skeleton service ready to go, but to adapt and extend it, reading up on [developing services](https://docs.kalix.io/developing/index.html), especially the [JavaScript section](https://docs.kalix.io/javascript/index.html), may be useful.

## Prerequisites

Expand Down
4 changes: 1 addition & 3 deletions samples/ts/ts-replicated-entity-shopping-cart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d

## Developing

This project has a bare-bones skeleton service ready to go, but in order to adapt and extend it it may be useful to
read up on [developing services](https://docs.kalix.io/developing/index.html) and in
particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
This project has a bare-bones skeleton service ready to go, but to adapt and extend it, reading up on [developing services](https://docs.kalix.io/developing/index.html), especially the [JavaScript section](https://docs.kalix.io/javascript/index.html), may be useful.

## Prerequisites

Expand Down
4 changes: 1 addition & 3 deletions samples/ts/ts-valueentity-counter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d

## Developing

This project has a functioning service ready to adapt and
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
This project has a bare-bones skeleton service ready to go, but to adapt and extend it, reading up on [developing services](https://docs.kalix.io/developing/index.html), especially the [JavaScript section](https://docs.kalix.io/javascript/index.html), may be useful.

## Prerequisites

Expand Down
4 changes: 1 addition & 3 deletions samples/ts/ts-valueentity-shopping-cart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d

## Developing

This project has a bare-bones skeleton service ready to go, but in order to adapt and
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
This project has a bare-bones skeleton service ready to go, but to adapt and extend it, reading up on [developing services](https://docs.kalix.io/developing/index.html), especially the [JavaScript section](https://docs.kalix.io/javascript/index.html), may be useful.

## Prerequisites

Expand Down
101 changes: 0 additions & 101 deletions styles/Vocab/Base/accept.txt

This file was deleted.

116 changes: 116 additions & 0 deletions styles/config/vocabularies/Base/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
(?# see https://vale.sh/docs/topics/vocab/#case-sensitivity for explanation of case sensitivity configuration)
Ack
ACLs
Aiven
Akka
allowMethods
allowOrigins
[Aa]ntora
(?i)API
[Aa]rchitecting
async
[Aa]utoscaling
[Bb]ackoffice
[Bb]oolean
brokerless
Buildah
CA's
caSecret
[Cc]hatbots
classname
clientCertificate
codegen
config
configs
corsPolicy
CRDTs
Ctrl
defaultMode
declaratively
deserialize
dev
facto
enum
env
failover
[Gg]itHub
googleCloud
grpcui
(?i)gRPCurl
hasPrefix
hasSuffix
hostname
hostnames
httpBasic
https
[Ii]dempotency
instanceType
interconnectivity
iss
JUnit
(?i)JWT
(?i)JWTs
[Kk]afka
[Kk]alix
keyId
[Ll]ightbend
matchers
maxInstances
minInstances
mountPath
namespace
newname
npx
npm
onboarding
(?i)OTLP
passivates
passwordHashes
plaintext
preconfigured
[Pp]rometheus
proto
[Pp]rotobuf
[Qq]uantiles
[Qq]uickstarts
recurse
redeliveries
(?i)RPC
sbt
(?i)Scala
SDKs
secretName
serverCertificate
Serverless
serverless
serviceAccountSecret
sharding
signup
smallstep
sourceType
[Ss]plunk
src
SREs
[Ss]tackdriver
subcommand
subjectMatches
subpage
[Tt]elemedicine
[Tt]estKit
Tink
(?i)TLS
tokenid
tokenSecret
transcoded
[Tt]ranscoding
unary
unencrypted
[Uu]nexpose
unnested
unsets
upsert
upserting
userid
valueFrom
volumeMounts
[Zz]sh
File renamed without changes.

0 comments on commit e6d70da

Please sign in to comment.