Skip to content

Commit

Permalink
Add additional rules (#108)
Browse files Browse the repository at this point in the history
* Add style rule for postgresdb

Signed-off-by: Mirjam Aulbach <mirjam.aulbach@aiven.io>

* Add rule for condensending language

Signed-off-by: Mirjam Aulbach <mirjam.aulbach@aiven.io>

* Add rule for use of race related words and update error.

Signed-off-by: Mirjam Aulbach <mirjam.aulbach@aiven.io>

---------

Signed-off-by: Mirjam Aulbach <mirjam.aulbach@aiven.io>
  • Loading branch information
programmiri committed Sep 28, 2023
1 parent e271e87 commit 7f93d1a
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 1 deletion.
8 changes: 8 additions & 0 deletions .github/vale/styles/Klaw/first-postgresql-registered.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: conditional
message: "The first mention of '%s' must be marked as ®"
level: warning
scope: text
ignorecase: false

first: '\b(PostgreSQL)(?!®)'
second: '(PostgreSQL)(?:®)'
18 changes: 18 additions & 0 deletions .github/vale/styles/Klaw/language-condescending.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Based alex https://github.com/errata-ai/alex/

extends: existence
message: Using '%s' may come across as condescending.
link: https://css-tricks.com/words-avoid-educational-writing/
level: warning
ignorecase: true
tokens:
- clearly
- easily
- easy
- everyone knows
- just
- obvious
- obviously
- of course
- simple
- simply
24 changes: 24 additions & 0 deletions .github/vale/styles/Klaw/language-race.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Based alex https://github.com/errata-ai/alex/

extends: substitution
message: Consider using '%s' instead of '%s'.
ignorecase: true
level: error
action:
name: replace
swap:
black list: blocklist|wronglist|banlist|deny list
blacklist: blocklist|wronglist|banlist|deny list
blacklisted: blocklisted|wronglisted|banlisted|deny-listed
blacklisting: blocklisting|wronglisting|banlisting|deny-listing
master: primary|hub|reference
masters: primaries|hubs|references
sophisticated technology: complex technology
white list: passlist|alrightlist|safelist|allow list
white space: space|blank
white spaces: space|blank
whitelist: passlist|alrightlist|safelist|allow list
whitelisted: passlisted|alrightlisted|safelisted|allow-listed
whitelisting: passlisting|alrightlisting|safelisting|allow-listing
whitespace: space|blank
whitespaces: space|blank
2 changes: 1 addition & 1 deletion docs/Releases/release100.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Date: 29th Sep, 2022
Klaw version 1.0.0 is a first major release.

- Klaw (formerly Kafkawize) Initial Release 1.0.0
- This release is cloned from master branch of
- This release is cloned from main branch of
<https://github.com/muralibasani/kafkawize>
- Package renamed to io.aiven.klaw
- Introduced 'Kafka flavor' in the configuration of clusters
Expand Down

0 comments on commit 7f93d1a

Please sign in to comment.