v0.0.6

Prim/Ampersand.yml

@@ -0,0 +1,6 @@
+extends: existence
+message: "Use 'and' as a separator instead of '&'."
+level: warning
+nonword: true
+tokens:
+  - '\b\w+\s&\s\w+\b'

Prim/PassiveVoice.yml

@@ -0,0 +1,185 @@
+extends: existence
+message: "'%s' looks like passive voice."
+level: suggestion
+ignorecase: true
+raw:
+  - \b(am|are|were|being|is|been|was|be)\b\s*
+tokens:
+  - '[\w]+ed'
+  - arisen
+  - awoken
+  - beaten
+  - become
+  - been
+  - begun
+  - bent
+  - beset
+  - bet
+  - bid
+  - bidden
+  - bitten
+  - bled
+  - blown
+  - born
+  - borne
+  - bought
+  - bound
+  - bred
+  - broadcast
+  - broken
+  - brought
+  - built
+  - burnt
+  - burst
+  - cast
+  - caught
+  - chosen
+  - clung
+  - come
+  - cost
+  - crept
+  - cut
+  - dealt
+  - done
+  - dove
+  - drawn
+  - dreamed
+  - dreamt
+  - driven
+  - drunk
+  - dug
+  - eaten
+  - fallen
+  - felt
+  - fit
+  - fled
+  - flown
+  - flung
+  - forbidden
+  - foregone
+  - forgiven
+  - forgotten
+  - forsaken
+  - fought
+  - found
+  - frozen
+  - given
+  - gone
+  - gotten
+  - ground
+  - grown
+  - heard
+  - held
+  - hidden
+  - hit
+  - hung
+  - hurt
+  - kept
+  - knelt
+  - knit
+  - known
+  - laid
+  - lain
+  - leapt
+  - learnt
+  - left
+  - lent
+  - let
+  - lit
+  - lost
+  - made
+  - meant
+  - met
+  - misspelt
+  - mistaken
+  - mown
+  - overcome
+  - overdone
+  - overseen
+  - overtaken
+  - overthrown
+  - paid
+  - proven
+  - put
+  - quit
+  - read
+  - rid
+  - ridden
+  - risen
+  - run
+  - rung
+  - said
+  - sat
+  - sawn
+  - seen
+  - sent
+  - set
+  - sewn
+  - shaken
+  - shaven
+  - shod
+  - shone
+  - shorn
+  - shot
+  - shown
+  - shrunk
+  - shrunken
+  - shut
+  - slain
+  - slept
+  - slid
+  - slit
+  - slung
+  - smelt
+  - smitten
+  - sold
+  - sought
+  - sown
+  - spent
+  - spilt
+  - spit
+  - split
+  - spoken
+  - spread
+  - sprung
+  - spun
+  - stolen
+  - stood
+  - stridden
+  - striven
+  - struck
+  - strung
+  - stuck
+  - stung
+  - stunk
+  - sung
+  - sunk
+  - swept
+  - swollen
+  - sworn
+  - swum
+  - swung
+  - taken
+  - taught
+  - thought
+  - thrown
+  - thrust
+  - told
+  - torn
+  - trodden
+  - undergone
+  - understood
+  - undertaken
+  - upheld
+  - upset
+  - wept
+  - withdrawn
+  - withheld
+  - withstood
+  - woken
+  - won
+  - worn
+  - wound
+  - woven
+  - written
+  - wrung

Prim/RequiredAlternatives.yml

@@ -18,6 +18,8 @@ swap:
   hard copy: hardcopy
   hardcoded: hard-coded
   HTTPs: HTTPS
+  in depth: in-depth
+  on demand: on-demand
   (?:file ?path|path ?name)s?: path|paths
   (?:scroll bar|scroll-bar)s?: scrollbar|scrollbars
   synch: sync
@@ -26,3 +28,4 @@ swap:
   URL for: URL of
   an URL: a URL
   usecases?: use case|use cases
+  (?:WiFi|wifi): Wi-Fi

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "prim",
-	"version": "0.0.5",
+	"version": "0.0.6",
 	"description": "A Vale-compatible prose style for non-native English speaker",
 	"scripts": {
 		"snapshot:update": "vitest rules --update",

test/fixtures/Ampersand/.vale.ini

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

test/fixtures/Ampersand/test.md

@@ -0,0 +1,3 @@
+# Ampersand
+
+He labored for the diploma day & night.

test/fixtures/PassiveVoice/.vale.ini

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

test/fixtures/PassiveVoice/test.md

@@ -0,0 +1,7 @@
+# Passive Voice
+
+Great expectations were formed of him.
+The house was filled with laughter.
+He was struck by her beauty.
+The streets were paved with gold.
+The cake was left on the table.

test/fixtures/RequiredAlternatives/test.md

@@ -43,6 +43,12 @@ The menu was hardcoded and could not be customized.
 <!-- HTTPs -->
 Always use HTTPs for secure online transactions.
 
+<!-- in depth -->
+The article provided an in depth analysis of the housing crash.
+
+<!-- on demand -->
+I prefer watching movies on demand.
+
 <!-- path -->
 Check the file path to locate the document.
 Copy and paste the full path names to navigate to the desired folder.
@@ -66,3 +72,7 @@ Hover on an URL to preview the page.
 <!-- usecase -->
 Can you provide a specific usecase where this technology would be beneficial?
 We analyzed the usecases to identify potential improvements.
+
+<!-- wifi -->
+The cafe offers free wifi for customers.
+I can't finish my work without WiFi.

test/snapshots/Ampersand.log

@@ -0,0 +1 @@
+test.md:3:28:Prim.Ampersand:Use 'and' as a separator instead of '&'.

test/snapshots/PassiveVoice.log

@@ -0,0 +1,5 @@
+test.md:3:20:Prim.PassiveVoice:'were formed' looks like passive voice.
+test.md:4:11:Prim.PassiveVoice:'was filled' looks like passive voice.
+test.md:5:4:Prim.PassiveVoice:'was struck' looks like passive voice.
+test.md:6:13:Prim.PassiveVoice:'were paved' looks like passive voice.
+test.md:7:10:Prim.PassiveVoice:'was left' looks like passive voice.

test/snapshots/RequiredAlternatives.log

@@ -15,15 +15,19 @@ test.md:35:34:Prim.RequiredAlternatives:Use 'dual-boot' instead of 'dual boot'.
 test.md:38:18:Prim.RequiredAlternatives:Use 'hardcopy' instead of 'hard copy'.
 test.md:41:14:Prim.RequiredAlternatives:Use 'hard-coded' instead of 'hardcoded'.
 test.md:44:12:Prim.RequiredAlternatives:Use 'HTTPS' instead of 'HTTPs'.
-test.md:47:11:Prim.RequiredAlternatives:Use 'path' or 'paths' instead of 'file path'.
-test.md:48:25:Prim.RequiredAlternatives:Use 'path' or 'paths' instead of 'path names'.
-test.md:51:9:Prim.RequiredAlternatives:Use 'scrollbar' or 'scrollbars' instead of 'scroll bar'.
-test.md:52:24:Prim.RequiredAlternatives:Use 'scrollbar' or 'scrollbars' instead of 'scroll-bars'.
-test.md:55:19:Prim.RequiredAlternatives:Use 'sync' instead of 'synch'.
-test.md:58:5:Prim.RequiredAlternatives:Use 'test case' or 'test cases' instead of 'testcase'.
-test.md:59:76:Prim.RequiredAlternatives:Use 'test case' or 'test cases' instead of 'testcases'.
-test.md:62:17:Prim.RequiredAlternatives:Use 'URL' instead of 'url'.
-test.md:63:5:Prim.RequiredAlternatives:Use 'URL of' instead of 'URL for'.
-test.md:64:10:Prim.RequiredAlternatives:Use 'a URL' instead of 'an URL'.
-test.md:67:28:Prim.RequiredAlternatives:Use 'use case' or 'use cases' instead of 'usecase'.
-test.md:68:17:Prim.RequiredAlternatives:Use 'use case' or 'use cases' instead of 'usecases'.
+test.md:47:25:Prim.RequiredAlternatives:Use 'in-depth' instead of 'in depth'.
+test.md:50:26:Prim.RequiredAlternatives:Use 'on-demand' instead of 'on demand'.
+test.md:53:11:Prim.RequiredAlternatives:Use 'path' or 'paths' instead of 'file path'.
+test.md:54:25:Prim.RequiredAlternatives:Use 'path' or 'paths' instead of 'path names'.
+test.md:57:9:Prim.RequiredAlternatives:Use 'scrollbar' or 'scrollbars' instead of 'scroll bar'.
+test.md:58:24:Prim.RequiredAlternatives:Use 'scrollbar' or 'scrollbars' instead of 'scroll-bars'.
+test.md:61:19:Prim.RequiredAlternatives:Use 'sync' instead of 'synch'.
+test.md:64:5:Prim.RequiredAlternatives:Use 'test case' or 'test cases' instead of 'testcase'.
+test.md:65:76:Prim.RequiredAlternatives:Use 'test case' or 'test cases' instead of 'testcases'.
+test.md:68:17:Prim.RequiredAlternatives:Use 'URL' instead of 'url'.
+test.md:69:5:Prim.RequiredAlternatives:Use 'URL of' instead of 'URL for'.
+test.md:70:10:Prim.RequiredAlternatives:Use 'a URL' instead of 'an URL'.
+test.md:73:28:Prim.RequiredAlternatives:Use 'use case' or 'use cases' instead of 'usecase'.
+test.md:74:17:Prim.RequiredAlternatives:Use 'use case' or 'use cases' instead of 'usecases'.
+test.md:77:22:Prim.RequiredAlternatives:Use 'Wi-Fi' instead of 'wifi'.
+test.md:78:32:Prim.RequiredAlternatives:Use 'Wi-Fi' instead of 'WiFi'.