Skip to content

Commit 3fe7cfe

Browse files
committed
docs: enhace Vale rules
1 parent a7f1270 commit 3fe7cfe

File tree

3 files changed

+31
-17
lines changed

3 files changed

+31
-17
lines changed

.github/styles/Apify/Apify.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@ message: "Use '%s' instead of '%s'."
33
ignorecase: false
44
level: warning
55
swap:
6+
# Brand consistency
67
Apify Dashboard: Apify Console
78
apify freelancers: Apify freelancers
89
Apify Platform: Apify platform
10+
11+
# Product names
912
'(?:[Tt]he\s)?[Aa]pify\sproxy': Apify Proxy
13+
14+
# Writing style
1015
circa: approx.
Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
extends: existence
2-
message: "The word '%s' should always be capitalized."
2+
message: "The word '%s' should always be capitalized when referring to Apify products."
33
ignorecase: false
44
level: error
5+
scope: text
56
tokens:
6-
# Before the word there should be no: /, -, #, word character
7-
# (avoids anchors, URLs, identifiers, and words like 'factors')
8-
#
9-
# After the word there should be no: /, } (avoids paths or URLs)
10-
# Also no . followed by a word character (avoids 'actors.md')
7+
# Apify Actors (the product) - avoid matching in URLs, code, or other contexts
118
- '(?<![\/\-#\w])actors(?![\/\}])(?!\.\w)'
12-
13-
# Before the word there should be no: /, -, #, ., `, word character
14-
# (avoids anchors, URLs, identifiers, code, and words like 'factors')
15-
#
16-
# After the word there should be no: /, }, -, word character (avoids paths or URLs)
17-
# Also no " =" (avoids code like "actor = ...")
18-
# Also no . followed by a word character (avoids 'actor.md' or 'actor.update()')
9+
10+
# Apify Actor (the product) - avoid matching in URLs, code, or other contexts
1911
- '(?<![\/\-#\.`\w])actor(?![\/\}\-\w])(?! =)(?!\.\w)'
12+
13+
# Apify Console (the product)
14+
- '(?<![\/\-#\.`\w])console(?![\/\}\-\w])(?! =)(?!\.\w)'
15+
16+
# Apify Proxy (the product)
17+
- '(?<![\/\-#\.`\w])proxy(?![\/\}\-\w])(?! =)(?!\.\w)'
2018
nonword: false

.github/styles/Apify/Languages.yml

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
extends: substitution
2-
message: "Use '%s' instead of '%s'."
2+
message: "Use '%s' instead of '%s' for proper language naming."
33
ignorecase: false
44
level: warning
55
swap:
6+
# JavaScript variations
67
'javascript|Javascript|javaScript': JavaScript
8+
9+
# Python variations (avoid matching in URLs like python.org)
710
'(?<!-)python(?!-)': Python
8-
'typescript|Typescript|typescript': TypeScript
9-
'nodejs|Nodejs|node.js': Node.js
10-
# Add more languages or common mistakes as needed
11+
12+
# TypeScript variations
13+
'typescript|Typescript': TypeScript
14+
15+
# Node.js variations
16+
'nodejs|Nodejs|node\.js': Node.js
17+
18+
# Additional common language variations
19+
'js|JS': JavaScript
20+
'ts|TS': TypeScript
21+
'py|PY': Python

0 commit comments

Comments
 (0)