feat(rule): refactor alternatives

Author: naiyerasif

Diff for: Prim/RequiredAlternatives.yml renamed to Prim/Consistency.yml

@@ -1,20 +1,17 @@
 extends: substitution
 message: "Use '%s' instead of '%s'."
-level: error
+level: warning
 ignorecase: true
 action:
   name: replace
 swap:
   24/7: 24x7
   3\-D: 3D
-  Ajax: AJAX
   audio(?:-| )books?: audiobook|audiobooks
   autodetect: auto-detect
   back(?:-| )light: backlight
   back\s(slash|slashes): backslash|backslashes
-  '[bB]asic [aA]uth': Basic HTTP authentication|Basic authentication
   bottle(?:-| )necks?: bottleneck|bottlenecks
-  (?:cell ?phone|smart ?phone): phone|mobile phone
   chat(?:-| )bots?: chatbot|chatbots
   check lists?: checklist|checklists
   check marks?: checkmark|checkmarks
@@ -28,7 +25,9 @@ swap:
   (?:OAuth ?2|Oauth): OAuth 2.0
   ok: OK
   on demand: on-demand
+  open-source: open source
   (?:file ?path|path ?name)s?: path|paths
+  (?:cell ?phone|smart ?phone): phone|mobile phone
   (?:quote mark|quotemark)s?: quotation mark|quotation marks
   scroll(?:-| )bars?: scrollbar|scrollbars
   synch: sync
@@ -38,3 +37,4 @@ swap:
   an URL: a URL
   usecases?: use case|use cases
   (?:WiFi|wifi): Wi-Fi
+  World Wide Web: web

Diff for: Prim/PreferredAlternatives.yml

@@ -5,5 +5,9 @@ ignorecase: true
 action:
   name: replace
 swap:
+  0-days?: zero-day|zero-days
+  12 am: midnight
+  12 pm: noon
+  adversely impact: hurt
   approximately: about|around
   state-of-the-art: modern|latest

Diff for: Prim/SimplerAlternatives.yml renamed to Prim/Simplifications.yml

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

Diff for: package.json

@@ -3,4 +3,4 @@ StylesPath = ../../../
 MinAlertLevel = suggestion
 
 [*.md]
-Prim.SimplerAlternatives = YES
+Prim.Consistency = YES

Diff for: test/fixtures/SimplerAlternatives/.vale.ini renamed to test/fixtures/Consistency/.vale.ini

@@ -1,14 +1,11 @@
-# Required Alternatives
+# Consistency
 
 <!-- 24/7 -->
 Our emergency hotline is staffed 24/7 for immediate assistance.
 
 <!-- 3-D -->
 The movie was stunning in 3-D.
 
-<!-- Ajax -->
-The web developer used Ajax to create a dynamic search feature on the website.
-
 <!-- audiobook -->
 I use audio-books to learn new languages.
 This audio book is several hours long.
@@ -24,19 +21,12 @@ This phone can automatically adjust the back-light brightness.
 Press back slash to reset the search.
 On Windows, we use back slashes to separate directories and files.
 
-<!-- Basic authentication -->
-Basic Auth requires a username and password to authenticate requests.
-
 <!-- bottleneck -->
 The bottle necks in production caused delays.
 The narrow hallway creates a bottle-neck during rush hours.
 
-<!-- phone -->
-I use my cell phone to take pictures.
-Keep your smartphone on airplane mode during the flight.
-
-<!-- chatbot -->
-A chat-bot is a conversational agent that simulates human conversation.
+<!-- chat bot -->
+She used a chat bot to proofread her paper.
 Chat bots can be trained to analyze data and provide insights.
 
 <!-- check list -->
@@ -81,10 +71,17 @@ I prefer watching movies on demand.
 <!-- OK -->
 Is everything ok?
 
+<!-- open-source -->
+I contributed a new feature to an open-source project.
+
 <!-- path -->
 Check the file path to locate the document.
 Copy and paste the full path names to navigate to the desired folder.
 
+<!-- phone -->
+Have you seen my cell phone?
+My smartphone is running low on battery.
+
 <!-- quotation mark -->
 You can use quote marks to format in-text citations.
 Use quotemark to set off a quotation from the text.
@@ -112,3 +109,6 @@ We analyzed the usecases to identify potential improvements.
 <!-- wifi -->
 The cafe offers free wifi for customers.
 I can't finish my work without WiFi.
+
+<!-- World Wide Web -->
+I'd better search the World Wide Web for a new recipe.

Diff for: test/fixtures/RequiredAlternatives/test.md renamed to test/fixtures/Consistency/test.md

@@ -3,4 +3,4 @@ StylesPath = ../../../
 MinAlertLevel = suggestion
 
 [*.md]
-Prim.RequiredAlternatives = YES
+Prim.Simplifications = YES

Diff for: test/fixtures/PreferredAlternatives/.vale.ini

@@ -0,0 +1,20 @@
+# Simplifications
+
+<!-- 0-day -->
+A hacker forum was found selling a 0-day exploit for a popular web browser.
+Security researchers discovered critical 0-days in the operating system.
+
+<!-- 12 am -->
+Our online support is available until 12 am.
+
+<!-- 12 pm -->
+Please submit your report by 12 pm tomorrow.
+
+<!-- adversely impact -->
+The new regulations may adversely impact small businesses.
+
+<!-- approximately -->
+The population of the city is approximately 1 million people.
+
+<!-- state-of-the-art -->
+This state-of-the-art arena can host 7,000 fans.

Diff for: test/fixtures/PreferredAlternatives/test.md

@@ -0,0 +1,51 @@
+test.md:4:34:Prim.Consistency:Use '24x7' instead of '24/7'.
+test.md:7:27:Prim.Consistency:Use '3D' instead of '3-D'.
+test.md:10:7:Prim.Consistency:Use 'audiobook' or 'audiobooks' instead of 'audio-books'.
+test.md:11:6:Prim.Consistency:Use 'audiobook' or 'audiobooks' instead of 'audio book'.
+test.md:14:14:Prim.Consistency:Use 'auto-detect' instead of 'autodetect'.
+test.md:17:24:Prim.Consistency:Use 'backlight' instead of 'back light'.
+test.md:18:41:Prim.Consistency:Use 'backlight' instead of 'back-light'.
+test.md:21:7:Prim.Consistency:Use 'backslash' or 'backslashes' instead of 'back slash'.
+test.md:22:20:Prim.Consistency:Use 'backslash' or 'backslashes' instead of 'back slashes'.
+test.md:25:5:Prim.Consistency:Use 'bottleneck' or 'bottlenecks' instead of 'bottle necks'.
+test.md:26:30:Prim.Consistency:Use 'bottleneck' or 'bottlenecks' instead of 'bottle-neck'.
+test.md:29:12:Prim.Consistency:Use 'chatbot' or 'chatbots' instead of 'chat bot'.
+test.md:30:1:Prim.Consistency:Use 'chatbot' or 'chatbots' instead of 'Chat bots'.
+test.md:33:12:Prim.Consistency:Use 'checklist' or 'checklists' instead of 'check list'.
+test.md:34:8:Prim.Consistency:Use 'checklist' or 'checklists' instead of 'check lists'.
+test.md:37:17:Prim.Consistency:Use 'checkmark' or 'checkmarks' instead of 'check mark'.
+test.md:38:12:Prim.Consistency:Use 'checkmark' or 'checkmarks' instead of 'check marks'.
+test.md:41:5:Prim.Consistency:Use 'downtime' instead of 'down time'.
+test.md:44:17:Prim.Consistency:Use 'dual-boot' instead of 'dualboot'.
+test.md:45:34:Prim.Consistency:Use 'dual-boot' instead of 'dual boot'.
+test.md:48:15:Prim.Consistency:Use 'email' instead of 'e-mail'.
+test.md:49:1:Prim.Consistency:Use 'email' instead of 'E-mail'.
+test.md:52:18:Prim.Consistency:Use 'hardcopy' or 'hardcopies' instead of 'hard copy'.
+test.md:53:41:Prim.Consistency:Use 'hardcopy' or 'hardcopies' instead of 'hard copies'.
+test.md:56:14:Prim.Consistency:Use 'hard-coded' instead of 'hardcoded'.
+test.md:59:12:Prim.Consistency:Use 'HTTPS' instead of 'HTTPs'.
+test.md:62:25:Prim.Consistency:Use 'in-depth' instead of 'in depth'.
+test.md:65:14:Prim.Consistency:Use 'OAuth 2.0' instead of 'OAuth'.
+test.md:66:1:Prim.Consistency:Use 'OAuth 2.0' instead of 'Oauth'.
+test.md:69:26:Prim.Consistency:Use 'on-demand' instead of 'on demand'.
+test.md:72:15:Prim.Consistency:Use 'OK' instead of 'ok'.
+test.md:75:35:Prim.Consistency:Use 'open source' instead of 'open-source'.
+test.md:78:11:Prim.Consistency:Use 'path' or 'paths' instead of 'file path'.
+test.md:79:25:Prim.Consistency:Use 'path' or 'paths' instead of 'path names'.
+test.md:82:18:Prim.Consistency:Use 'phone' or 'mobile phone' instead of 'cell phone'.
+test.md:83:4:Prim.Consistency:Use 'phone' or 'mobile phone' instead of 'smartphone'.
+test.md:86:13:Prim.Consistency:Use 'quotation mark' or 'quotation marks' instead of 'quote marks'.
+test.md:87:5:Prim.Consistency:Use 'quotation mark' or 'quotation marks' instead of 'quotemark'.
+test.md:90:9:Prim.Consistency:Use 'scrollbar' or 'scrollbars' instead of 'scroll bar'.
+test.md:91:24:Prim.Consistency:Use 'scrollbar' or 'scrollbars' instead of 'scroll-bars'.
+test.md:94:19:Prim.Consistency:Use 'sync' instead of 'synch'.
+test.md:97:5:Prim.Consistency:Use 'test case' or 'test cases' instead of 'testcase'.
+test.md:98:76:Prim.Consistency:Use 'test case' or 'test cases' instead of 'testcases'.
+test.md:101:17:Prim.Consistency:Use 'URL' instead of 'url'.
+test.md:102:5:Prim.Consistency:Use 'URL of' instead of 'URL for'.
+test.md:103:10:Prim.Consistency:Use 'a URL' instead of 'an URL'.
+test.md:106:28:Prim.Consistency:Use 'use case' or 'use cases' instead of 'usecase'.
+test.md:107:17:Prim.Consistency:Use 'use case' or 'use cases' instead of 'usecases'.
+test.md:110:22:Prim.Consistency:Use 'Wi-Fi' instead of 'wifi'.
+test.md:111:32:Prim.Consistency:Use 'Wi-Fi' instead of 'WiFi'.
+test.md:114:23:Prim.Consistency:Use 'web' instead of 'World Wide Web'.

Diff for: test/fixtures/SimplerAlternatives/test.md

@@ -0,0 +1,7 @@
+test.md:4:36:Prim.Simplifications:Use 'zero-day' or 'zero-days' instead of '0-day'.
+test.md:5:42:Prim.Simplifications:Use 'zero-day' or 'zero-days' instead of '0-days'.
+test.md:8:39:Prim.Simplifications:Use 'midnight' instead of '12 am'.
+test.md:11:30:Prim.Simplifications:Use 'noon' instead of '12 pm'.
+test.md:14:25:Prim.Simplifications:Use 'hurt' instead of 'adversely impact'.
+test.md:17:31:Prim.Simplifications:Use 'about' or 'around' instead of 'approximately'.
+test.md:20:6:Prim.Simplifications:Use 'modern' or 'latest' instead of 'state-of-the-art'.