Skip to content

Commit 5dff827

Browse files
authored
chore: upgrade Vale to 3.0.5 (#538)
Fix typos caught by error-level alerting for Repetition style violations. Closes: #537
1 parent cb6d554 commit 5dff827

File tree

15 files changed

+127
-125
lines changed

15 files changed

+127
-125
lines changed

.github/workflows/linting.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
# v2.0.1
2323
uses: errata-ai/vale-action@c4213d4de3d5f718b8497bd86161531c78992084
2424
with:
25-
version: 2.30.0
25+
version: 3.0.5
2626
files: '["docs/dev", "docs/src", "samples"]'
2727
fail_on_error: true
2828
filter_mode: nofilter

.vale.ini

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Packages = Microsoft, write-good
99
BasedOnStyles = Vale, Lightbend, write-good
1010

1111
# Override the alert level of certain styles
12-
Vale.Repetition = warning
1312
Lightbend.Contractions = suggestion
1413
Lightbend.Avoid = warning
1514
write-good.So = suggestion

build/license.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"**/*.yml",
1313
"samples/*/*/lib/generated",
1414
"sdk/test/*.desc",
15-
"styles/Vocab/Base/",
15+
"styles/config/vocabularies/Base",
1616
"tck/generated",
1717
"testkit/integration-test/proto.*"
1818
],

docs/src/modules/developing/pages/development-process-js.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Actions are stateless functions that can be triggered by gRPC or HTTP calls. The
3939
4040
=== Entities
4141
42-
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.
42+
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.
4343
4444
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].
4545

docs/src/modules/javascript/pages/eventsourced.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following shows an example shopping cart definition in a `domain.proto` file
1717
include::example$domain.proto[]
1818
----
1919

20-
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.
20+
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.
2121

2222
== Creating an entity
2323

docs/src/modules/javascript/pages/value-entity.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The `counter_api.proto` file defines the commands we can send to the Counter ser
3737
include::example$valueentity-counter/proto/counter_api.proto[]
3838
----
3939
<1> Import the Kalix protobuf annotations, or options.
40-
<2> Any classes generated from this protobuf file will be be nested in the package hierarchy: `com.example`.
40+
<2> Any classes generated from this protobuf file will be nested in the package hierarchy: `com.example`.
4141

4242
<3> Protobuf messages describe the Commands that the service handles. They may contain other messages to represent structured data.
4343
<4> Every Command must contain a `string` field that contains the entity ID and is marked with the `(kalix.field).entity_key` option.

samples/js/js-replicated-entity-shopping-cart/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d
66

77
## Developing
88

9-
This project has a bare-bones skeleton service ready to go, but in order to adapt and extend it it may be useful to
10-
read up on [developing services](https://docs.kalix.io/developing/index.html) and in
11-
particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
9+
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.
1210

1311
## Prerequisites
1412

samples/js/js-valueentity-shopping-cart/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d
66

77
## Developing
88

9-
This project has a bare-bones skeleton service ready to go, but in order to adapt and
10-
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
11-
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
9+
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.
1210

1311
## Prerequisites
1412

samples/js/valueentity-counter/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d
66

77
## Developing
88

9-
This project has a functioning service ready to adapt and
10-
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
11-
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
9+
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.
1210

1311
## Prerequisites
1412

samples/ts/ts-replicated-entity-shopping-cart/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d
66

77
## Developing
88

9-
This project has a bare-bones skeleton service ready to go, but in order to adapt and extend it it may be useful to
10-
read up on [developing services](https://docs.kalix.io/developing/index.html) and in
11-
particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
9+
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.
1210

1311
## Prerequisites
1412

samples/ts/ts-valueentity-counter/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d
66

77
## Developing
88

9-
This project has a functioning service ready to adapt and
10-
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
11-
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
9+
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.
1210

1311
## Prerequisites
1412

samples/ts/ts-valueentity-shopping-cart/README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ While designing your service it is useful to read [designing services](https://d
66

77
## Developing
88

9-
This project has a bare-bones skeleton service ready to go, but in order to adapt and
10-
extend it it may be useful to read up on [developing services](https://docs.kalix.io/developing/index.html)
11-
and in particular the [JavaScript section](https://docs.kalix.io/javascript/index.html)
9+
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.
1210

1311
## Prerequisites
1412

styles/Vocab/Base/accept.txt

-101
This file was deleted.
+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
(?# see https://vale.sh/docs/topics/vocab/#case-sensitivity for explanation of case sensitivity configuration)
2+
Ack
3+
ACLs
4+
Aiven
5+
Akka
6+
allowMethods
7+
allowOrigins
8+
[Aa]ntora
9+
(?i)API
10+
[Aa]rchitecting
11+
async
12+
[Aa]utoscaling
13+
[Bb]ackoffice
14+
[Bb]oolean
15+
brokerless
16+
Buildah
17+
CA's
18+
caSecret
19+
[Cc]hatbots
20+
classname
21+
clientCertificate
22+
codegen
23+
config
24+
configs
25+
corsPolicy
26+
CRDTs
27+
Ctrl
28+
defaultMode
29+
declaratively
30+
deserialize
31+
dev
32+
facto
33+
enum
34+
env
35+
failover
36+
[Gg]itHub
37+
googleCloud
38+
grpcui
39+
(?i)gRPCurl
40+
hasPrefix
41+
hasSuffix
42+
hostname
43+
hostnames
44+
httpBasic
45+
https
46+
[Ii]dempotency
47+
instanceType
48+
interconnectivity
49+
iss
50+
JUnit
51+
(?i)JWT
52+
(?i)JWTs
53+
[Kk]afka
54+
[Kk]alix
55+
keyId
56+
[Ll]ightbend
57+
matchers
58+
maxInstances
59+
minInstances
60+
mountPath
61+
namespace
62+
newname
63+
npx
64+
npm
65+
onboarding
66+
(?i)OTLP
67+
passivates
68+
passwordHashes
69+
plaintext
70+
preconfigured
71+
[Pp]rometheus
72+
proto
73+
[Pp]rotobuf
74+
[Qq]uantiles
75+
[Qq]uickstarts
76+
recurse
77+
redeliveries
78+
(?i)RPC
79+
sbt
80+
(?i)Scala
81+
SDKs
82+
secretName
83+
serverCertificate
84+
Serverless
85+
serverless
86+
serviceAccountSecret
87+
sharding
88+
signup
89+
smallstep
90+
sourceType
91+
[Ss]plunk
92+
src
93+
SREs
94+
[Ss]tackdriver
95+
subcommand
96+
subjectMatches
97+
subpage
98+
[Tt]elemedicine
99+
[Tt]estKit
100+
Tink
101+
(?i)TLS
102+
tokenid
103+
tokenSecret
104+
transcoded
105+
[Tt]ranscoding
106+
unary
107+
unencrypted
108+
[Uu]nexpose
109+
unnested
110+
unsets
111+
upsert
112+
upserting
113+
userid
114+
valueFrom
115+
volumeMounts
116+
[Zz]sh
File renamed without changes.

0 commit comments

Comments
 (0)