Microflash · naiyerasif · Mar 24, 2024 · Mar 23, 2024 · Mar 23, 2024 · Mar 23, 2024
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .workspace
 node_modules
 .DS_Store
+Prim.zip
diff --git a/.vale.ini b/.vale.ini
@@ -1,4 +1,4 @@
 StylesPath = .
 
 [*.md]
-BasedOnStyles = compris
+BasedOnStyles = Prim
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,11 +1,11 @@
 # Contribution manual
 
-Thank you for your interest in contributing to **compris**. There are many ways to contribute and we appreciate all of them.
+Thank you for your interest in contributing to **Prim**. There are many ways to contribute and we appreciate all of them.
 
 > [!TIP]
 > **For new contributors**: Visit <https://github.com/firstcontributions/first-contributions> for helpful information on contributing to open source projects 
 
-- [Create an issue](https://github.com/Microflash/compris/issues/new) to discuss a change before you start working on it.
+- [Create an issue](https://github.com/Microflash/Prim/issues/new) to discuss a change before you start working on it.
 
 ## Commit messages
 

diff --git a/CREDITS.md b/CREDITS.md
@@ -0,0 +1,2 @@
+- [Joseph Kato](https://github.com/jdkato) for building [Vale](https://vale.sh/)
+- [Oxford 3000](https://www.oxfordlearnersdictionaries.com/us/wordlists/oxford3000-5000) for most commonly used English words
diff --git a/compris/AMPM.yml → Prim/AMPM.yml b/compris/AMPM.yml → Prim/AMPM.yml
diff --git a/compris/AbbreviationPeriods.yml → Prim/AbbreviationPeriods.yml b/compris/AbbreviationPeriods.yml → Prim/AbbreviationPeriods.yml
diff --git a/compris/Ambiguity.yml → Prim/Ambiguity.yml b/compris/Ambiguity.yml → Prim/Ambiguity.yml
@@ -1,6 +1,6 @@
 extends: existence
 message: "Avoid ambiguity. Don't use '%s'."
 level: error
-# ignorecase: true
+ignorecase: true
 tokens:
   - and/or
diff --git a/compris/Contractions.yml → Prim/Contractions.yml b/compris/Contractions.yml → Prim/Contractions.yml
diff --git a/compris/Ellipsis.yml → Prim/Ellipsis.yml b/compris/Ellipsis.yml → Prim/Ellipsis.yml
diff --git a/compris/EmDash.yml → Prim/EmDash.yml b/compris/EmDash.yml → Prim/EmDash.yml
diff --git a/compris/EnDash.yml → Prim/EnDash.yml b/compris/EnDash.yml → Prim/EnDash.yml
diff --git a/compris/Latin.yml → Prim/Latin.yml b/compris/Latin.yml → Prim/Latin.yml
diff --git a/compris/OptionalPlurals.yml → Prim/OptionalPlurals.yml b/compris/OptionalPlurals.yml → Prim/OptionalPlurals.yml
diff --git a/compris/Ordinal.yml → Prim/Ordinal.yml b/compris/Ordinal.yml → Prim/Ordinal.yml
diff --git a/compris/OxfordComma.yml → Prim/OxfordComma.yml b/compris/OxfordComma.yml → Prim/OxfordComma.yml
diff --git a/compris/Percentages.yml → Prim/Percentages.yml b/compris/Percentages.yml → Prim/Percentages.yml
diff --git a/compris/PreferredAlternatives.yml → Prim/PreferredAlternatives.yml b/compris/PreferredAlternatives.yml → Prim/PreferredAlternatives.yml
@@ -8,3 +8,4 @@ swap:
   0-day: zero-day
   12 am: midnight
   12 pm: noon
+  open-source: open source
diff --git a/compris/RequiredAlternatives.yml → Prim/RequiredAlternatives.yml b/compris/RequiredAlternatives.yml → Prim/RequiredAlternatives.yml
@@ -6,4 +6,10 @@ action:
   name: replace
 swap:
   24/7: 24x7
+  3\-D: 3D
+  Ajax: AJAX
+  autodetect: auto-detect
   synch: sync
+  url:  URL
+  URL for: URL of
+  an URL: a URL
diff --git a/compris/Semicolon.yml → Prim/Semicolon.yml b/compris/Semicolon.yml → Prim/Semicolon.yml
diff --git a/compris/SentenceLength.yml → Prim/SentenceLength.yml b/compris/SentenceLength.yml → Prim/SentenceLength.yml
diff --git a/compris/SimplerAlternatives.yml → Prim/SimplerAlternatives.yml b/compris/SimplerAlternatives.yml → Prim/SimplerAlternatives.yml
diff --git a/compris/Space.yml → Prim/Space.yml b/compris/Space.yml → Prim/Space.yml
diff --git a/compris/WordRepitition.yml → Prim/WordRepitition.yml b/compris/WordRepitition.yml → Prim/WordRepitition.yml
diff --git a/Prim/meta.json b/Prim/meta.json
@@ -0,0 +1,4 @@
+{
+	"feed": "https://github.com/Microflash/Prim/releases.atom",
+	"vale_version": ">=1.0.0"
+}
diff --git a/README.md b/README.md
@@ -1,26 +1,27 @@
-# compris
+# Prim
 
-[![Regression tests](https://github.com/Microflash/compris/actions/workflows/regression.yml/badge.svg)](https://github.com/Microflash/compris/actions/workflows/regression.yml)
+[![Regression tests](https://github.com/Microflash/Prim/actions/workflows/regression.yml/badge.svg)](https://github.com/Microflash/Prim/actions/workflows/regression.yml)
 
 A [Vale](https://vale.sh)-compatible prose style for non-native English speakers. Tailored for technical documentation.
 
 ## Status: alpha
 
-**compris** is still in its early stages. It is usable but expect massive and frequent changes before it becomes stable.
+> [!IMPORTANT]
+> **Prim** is still in its early stages. It is usable but expect massive and frequent changes before it becomes stable.
 
 ## Usage
 
-Add <https://github.com/Microflash/compris/releases/download/latest/compris.zip> to the list of `Packages` in the `.vale.ini` file.
+Add <https://github.com/Microflash/Prim/releases/download/latest/Prim.zip> to the list of `Packages` in the `.vale.ini` file.
 
 ```ini
 StylesPath = .github/styles
 MinAlertLevel = suggestion
 
 Packages = proselint, \
-https://github.com/Microflash/compris/releases/download/latest/compris.zip
+https://github.com/Microflash/Prim/releases/download/latest/Prim.zip
 
 [README.md]
-BasedOnStyles = Vale, compris, proselint
+BasedOnStyles = Vale, Prim, proselint
 ```
 
 To sync the latest updates, run `vale sync`.
@@ -35,9 +36,9 @@ To sync the latest updates, run `vale sync`.
 
 ## Development
 
-- [Rules](./compris/) are written in `yml` files using the syntax described by [Vale docs](https://vale.sh/docs/).
-- Every rule has a [fixture](./fixtures/) against which you can run tests.
-- Tests are run against the [log output](./test/expectations/) of Vale.
+- [Rules](./Prim/) are written in `yml` files using the syntax described by [Vale docs](https://vale.sh/docs/).
+- Every rule has a [fixture](./test/fixtures/) against which you can run tests.
+- Tests are run against the [log output snapshots](./test/snapshots/) of Vale.
 
 ### Prerequisites
 
@@ -51,9 +52,9 @@ Run `pnpm i` to download the test dependencies; you would need them to run the t
 
 A typical workflow looks like this.
 
-1. Add a new rule by creating a new `compris/<RuleName>.yml` file, or modify an existing rule in the existing `compris/<RuleName>.yml` file.
-2. Add or update the fixtures in the `fixtures/<RuleName>/test.md` directory.
-3. Add the expected logs in the `test/expectations/<RuleName>.log` file.
+1. Add a new rule by creating a new `Prim/<RuleName>.yml` file, or modify an existing rule in the existing `Prim/<RuleName>.yml` file.
+2. Add or update the fixtures in the `test/fixtures/<RuleName>/test.md` directory.
+3. Generate or update a snapshot with `pnpm snapshot:update`
 4. Run `pnpm test` to run the tests.
 
 ## License

diff --git a/compris/meta.json b/compris/meta.json
diff --git a/fixtures/AMPM/.vale.ini b/fixtures/AMPM/.vale.ini
diff --git a/fixtures/AbbreviationPeriods/.vale.ini b/fixtures/AbbreviationPeriods/.vale.ini
diff --git a/fixtures/Ambiguity/.vale.ini b/fixtures/Ambiguity/.vale.ini
diff --git a/fixtures/Contractions/.vale.ini b/fixtures/Contractions/.vale.ini
diff --git a/fixtures/Ellipsis/.vale.ini b/fixtures/Ellipsis/.vale.ini
diff --git a/fixtures/EmDash/.vale.ini b/fixtures/EmDash/.vale.ini
diff --git a/fixtures/EnDash/.vale.ini b/fixtures/EnDash/.vale.ini
diff --git a/fixtures/Latin/.vale.ini b/fixtures/Latin/.vale.ini
diff --git a/fixtures/OptionalPlurals/.vale.ini b/fixtures/OptionalPlurals/.vale.ini
diff --git a/fixtures/Ordinal/.vale.ini b/fixtures/Ordinal/.vale.ini
diff --git a/fixtures/OxfordComma/.vale.ini b/fixtures/OxfordComma/.vale.ini
diff --git a/fixtures/Percentages/.vale.ini b/fixtures/Percentages/.vale.ini
diff --git a/fixtures/PreferredAlternatives/.vale.ini b/fixtures/PreferredAlternatives/.vale.ini
diff --git a/fixtures/RequiredAlternatives/.vale.ini b/fixtures/RequiredAlternatives/.vale.ini
diff --git a/fixtures/RequiredAlternatives/test.md b/fixtures/RequiredAlternatives/test.md
diff --git a/fixtures/Semicolon/.vale.ini b/fixtures/Semicolon/.vale.ini
diff --git a/fixtures/SentenceLength/.vale.ini b/fixtures/SentenceLength/.vale.ini
diff --git a/fixtures/SimplerAlternatives/.vale.ini b/fixtures/SimplerAlternatives/.vale.ini
diff --git a/fixtures/Space/.vale.ini b/fixtures/Space/.vale.ini
diff --git a/fixtures/WordRepitition/.vale.ini b/fixtures/WordRepitition/.vale.ini
diff --git a/package.json b/package.json
@@ -1,10 +1,11 @@
 {
-	"name": "compris",
-	"version": "0.0.2",
+	"name": "prim",
+	"version": "0.0.3",
 	"description": "A Vale-compatible prose style for non-native English speaker",
 	"scripts": {
+		"snapshot:update": "vitest rules --update",
 		"test": "vitest rules",
-		"dist": "zip -r compris.zip compris -x \"*.DS_Store\""
+		"dist": "zip -r Prim.zip Prim -x \"*.DS_Store\""
 	},
 	"devDependencies": {
 		"execa": "^8.0.1",

diff --git a/test/expectations/AMPM.log b/test/expectations/AMPM.log
diff --git a/test/expectations/AbbreviationPeriods.log b/test/expectations/AbbreviationPeriods.log
diff --git a/test/expectations/Ambiguity.log b/test/expectations/Ambiguity.log
diff --git a/test/expectations/Contractions.log b/test/expectations/Contractions.log
diff --git a/test/expectations/Ellipsis.log b/test/expectations/Ellipsis.log
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- [Joseph Kato](https://github.com/jdkato) for building [Vale](https://vale.sh/)
		- [Oxford 3000](https://www.oxfordlearnersdictionaries.com/us/wordlists/oxford3000-5000) for most commonly used English words