feat(rule): add abbreviation rules

Author: naiyerasif

Prim/Abbreviations.yml

@@ -0,0 +1,56 @@
+extends: conditional
+message: "Spell out '%s', if it's unfamiliar to the audience."
+level: suggestion
+ignorecase: false
+first: '\b(?=\w{3,})(?=(?:\w*[A-Z]){2,})[A-Za-z]+\b(?!\s*\((?:[A-Z][a-z]+\s+)+\))'
+second: '(?:\b[A-Z][a-z]+\s+)+\(([A-Za-z]{3,})\)'
+exceptions:
+  - API
+  - AWS
+  - BIOS
+  - CAPTCHA
+  - CLI
+  - CSS
+  - CSV
+  - DEBUG
+  - DELETE
+  - ERROR
+  - FAQ
+  - GET
+  - GIF
+  - INFO
+  - HEAD
+  - HTML
+  - IDE
+  - JAR
+  - JDBC
+  - JDK
+  - JPA
+  - JPEG
+  - JSON
+  - JVM
+  - LaTeX
+  - MIT
+  - OEM
+  - OSS
+  - PATCH
+  - PIN
+  - PNG
+  - POST
+  - PUT
+  - ReCAPTCHA
+  - REST
+  - RSS
+  - SQL
+  - SVG
+  - TODO
+  - TRACE
+  - USB
+  - UTF
+  - WARN
+  - WebP
+  - WiFi
+  - XML
+  - YAML
+  - YML
+  - ZIP

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "prim",
-	"version": "0.1.4",
+	"version": "0.1.5",
 	"description": "A Vale-compatible prose style for non-native English speaker",
 	"type": "module",
 	"author": "Naiyer Asif (https://naiyerasif.com)",

test/fixtures/Abbreviations/.vale.ini

@@ -0,0 +1,6 @@
+StylesPath = ../../../
+
+MinAlertLevel = suggestion
+
+[*.md]
+Prim.Abbreviations = YES

test/fixtures/Abbreviations/test.md

@@ -0,0 +1,36 @@
+# Abbreviation Periods
+
+<!-- ❌ trigger on abbreviations without full forms -->
+Our email service supports PGP.
+VoIP is widely used in corporate environments.
+Let's standardize this DoD.
+
+<!-- ✅ ignore abbreviations followed by full forms -->
+International Space Station (ISS) is a marvel of engineering.
+International Organization for Standardization (ISO) develops and publishes international standards.
+
+<!-- ✅ ignore two letter abbreviations -->
+Europe is trying to move away from US tech.
+Reboot your PC to install upgrades.
+
+<!-- ✅ ignore exceptions -->
+CAPTCHA is becoming annoying.
+Just use HTML and CSS.
+Do you use JPA to connect to database or just JDBC to work with SQL?
+Should the endpoint return a JSON or XML response?
+This equation can be written in LaTeX.
+They have put a ReCAPTCHA on login.
+What's your WiFi password?
+You should expose this service as a REST API.
+You can use a JPEG, PNG or SVG, although you should be using WebP.
+Your IDE can generate the JAR file using the installed JDK.
+Here are some FAQ about JVM.
+Use verbs like GET, POST, PATCH, PUT, DELETE or HEAD instead of always returning an OK with custom message.
+Add a TODO comment to implement an RSS feed later.
+For complete address, please provide a ZIP or PIN code.
+AWS CLI can be used to upload the GIF.
+Either of the aliases, YAML or YML, is fine.
+The log level can be set to TRACE, DEBUG, INFO, WARN or ERROR.
+The OEM needs an OSS license, such as MIT.
+Encode the CSV with UTF for maximum compatibility.
+Unplug the USB drive to avoid rebooting into the BIOS.

test/snapshots/Abbreviations.log

@@ -0,0 +1,3 @@
+test.md:4:28:Prim.Abbreviations:Spell out 'PGP', if it's unfamiliar to the audience.
+test.md:5:1:Prim.Abbreviations:Spell out 'VoIP', if it's unfamiliar to the audience.
+test.md:6:24:Prim.Abbreviations:Spell out 'DoD', if it's unfamiliar to the audience.