Updates for the new version of the ruleset

Merge pull request #5 from rmlos/update-vale-rules
OutSystems · Sep 3, 2021 · d39436b · d39436b
2 parents 256febd + 38973f2
commit d39436b
Show file tree

Hide file tree

Showing 9 changed files with 54 additions and 11 deletions.
diff --git a/styles-vale/OutSystems/Acronyms.yml b/styles-vale/OutSystems/Acronyms.yml
@@ -10,21 +10,26 @@ first: '\b([A-Z]{3,5})\b'
 second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
 # ... with the exception of these:
 exceptions:
+  - AAB
   - API
+  - APK
   - ASP
   - CPU
   - CSS
   - CSV
+  - CRUD
+  - DEV
   - DOM
   - FAQ
   - GDB
   - GET
-  - GUI
   - GPS
+  - GUI
   - HTML
   - HTTP
   - HTTPS
   - IDE
+  - IPA
   - JSON
   - LDAP
   - LESS
@@ -36,6 +41,8 @@ exceptions:
   - PDF
   - PHP
   - POST
+  - PP
+  - PROD
   - PWA
   - RAM
   - REST
@@ -49,6 +56,7 @@ exceptions:
   - SSL
   - SVG
   - TCP
+  - TEST
   - TLS
   - URI
   - URL
@@ -59,6 +67,6 @@ exceptions:
   - XSS
   - YAML
   - ZIP
-  - DEV
-  - PP
-  - PROD
+  - VPN
+  - IIS
+
diff --git a/styles-vale/OutSystems/BrandTerms.yml b/styles-vale/OutSystems/BrandTerms.yml
@@ -17,4 +17,5 @@ swap:
   apis: APIs
   urls: URLs
   javascript: JavaScript
+  SS: Service Studio
 
diff --git a/styles-vale/OutSystems/ImageAltSpacesOnly.yml b/styles-vale/OutSystems/ImageAltSpacesOnly.yml
@@ -0,0 +1,6 @@
+extends: existence
+message: "Alt value wrong. Describe the image properly."
+level: warning
+scope: raw
+raw:
+  - '\!\[\s+\]'
diff --git a/styles-vale/OutSystems/ImageNoAlt.yml b/styles-vale/OutSystems/ImageNoAlt.yml
@@ -0,0 +1,6 @@
+extends: existence
+message: "Consider adding alt description for non-decorative images."
+level: suggestion
+scope: raw
+raw:
+  - '\!\[\]'
diff --git a/styles-vale/OutSystems/ImageWidthDeprecated.yml b/styles-vale/OutSystems/ImageWidthDeprecated.yml
@@ -0,0 +1,6 @@
+extends: existence
+message: "Width tag is deprecated. Edit the image and use the full width instead."
+level: suggestion
+scope: raw
+raw:
+  - '\?width\='
diff --git a/styles-vale/OutSystems/NeedsMoreContent.yml b/styles-vale/OutSystems/NeedsMoreContent.yml
@@ -0,0 +1,8 @@
+extends: occurrence
+message: "Content too short. Provide at least 400 characters."
+level: warning
+scope: raw
+min: 400
+max: 1000000
+raw:
+  - '[\w-]+'
diff --git a/styles-vale/OutSystems/SentenceLength.yml b/styles-vale/OutSystems/SentenceLength.yml
@@ -1,7 +1,7 @@
 # Based on OpenStack.SentenceLength
-message: "Write short sentences (less than 40 words)."
+message: "Write sentences shorter than 30 words."
 extends: occurrence
 scope: sentence
 level: suggestion
-max: 40
+max: 30
 token: \b(\w+)\b
diff --git a/styles-vale/OutSystems/SummaryEmpty.yml b/styles-vale/OutSystems/SummaryEmpty.yml
@@ -0,0 +1,7 @@
+extends: existence
+message: "Consider adding content for summary."
+level: warning
+scope: raw
+raw:
+  - '^summary:$'
+
diff --git a/styles-vale/vocab.txt b/styles-vale/vocab.txt
@@ -1,15 +1,16 @@
 Android
+Ctrl
+Excel
+MABS
+MindTouch
 boolean
 chatbot
-Ctrl
 datacenter
-Excel
-enum
 denormalization
 denormalize
-keystore
+enum
 iOS
-MindTouch
+keystore
 reinstall
 reinstallation
 scrollable