Browse Source

Updates to Vale style rules

Signed-off-by: chanmosq <[email protected]>
chanmosq 2 years ago
parent
commit
2926a3560c

+ 6 - 0
styles/O3DE/CodeStyle.yml

@@ -0,0 +1,6 @@
+extends: existence
+message: Use code-style format with back-ticks (`), such as `%s`.
+level: warning
+ignorecase: true
+tokens:
+    - (?<!`\w\d)o3de[A-Za-z0-9_.-]*(?!\w`) # repo names

+ 8 - 0
styles/O3DE/ExpandedAbbreviations.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: If this is the first appearance of %s in this page, use it's expanded form. For example, 'Open 3D Engine (O3DE)'.
+level: warning
+ignorecase: false
+tokens:
+  - (?:[A-Z]){2,}
+exceptions:
+# See O3DETerminology vocab for more exceptions.

+ 2 - 2
styles/O3DE/Spelling.yml

@@ -7,6 +7,6 @@ message: "Use correct American English spelling. Did you really mean '%s'?"
 # source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
 # source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
 # A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
 # A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
 # Spelling rule applies to individual words
 # Spelling rule applies to individual words
+ignorecase: true
 filters:
 filters:
-- Material Canvas
-- Gem
+- respawns

+ 2 - 4
styles/O3DE/TerminologyFormat.yml

@@ -4,12 +4,10 @@ ignorecase: true
 level: warning
 level: warning
 link: 
 link: 
 message: Use '%s' rather than '%s'
 message: Use '%s' rather than '%s'
-# source: "https://www.o3de.org/docs/contributing/to-docs/terminology/"
 action:
 action:
   name: replace
   name: replace
 swap:
 swap:
   blacklist: blocklist
   blacklist: blocklist
   whitelist: allowlist
   whitelist: allowlist
-  master(?! broker): primary|source|initiator|requester|controller|host|director|supplier
-  slave(?! broker): secondary|replica|responder|device|worker|proxy|performer|consumer
-  see: refer to
+  see: refer to
+  \&: and 

+ 17 - 1
styles/Vocab/O3DETerminology/accept.txt

@@ -12,18 +12,27 @@ SIG
 
 
 AnimGraph
 AnimGraph
 Asset Browser
 Asset Browser
+Atom Renderer
+Atom Sample Viewer
+Atom
+AZSL
+AZ
 O3DE Documentation
 O3DE Documentation
 O3DE
 O3DE
 Entity Outliner
 Entity Outliner
 Asset Processor
 Asset Processor
 Material Canvas
 Material Canvas
 Material Editor
 Material Editor
+RHI
+RPI
 Test Impact Analysis Framework
 Test Impact Analysis Framework
 TIAF
 TIAF
 Editor
 Editor
 
 
+FBX
 PySide
 PySide
 Snap
 Snap
+JSON
 Linux
 Linux
 OpenXR
 OpenXR
 XR
 XR
@@ -32,8 +41,15 @@ PhysX
 Lua
 Lua
 Vulkan
 Vulkan
 NVIDIA
 NVIDIA
+Windows
 
 
 AzQtComponents
 AzQtComponents
 AzCore
 AzCore
 
 
-GPU
+CPU
+GPU
+API
+PC
+UI
+URL
+UX