test: switch to snapshot tests

naiyerasif · naiyerasif · commit 10ac0c1a93f9 · 2024-03-24T08:08:06.000+05:30
diff --git a/README.md b/README.md
@@ -37,8 +37,8 @@ To sync the latest updates, run `vale sync`.
 ## Development
 
 - [Rules](./Prim/) 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.
+- 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
 
@@ -53,8 +53,8 @@ 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 `Prim/<RuleName>.yml` file, or modify an existing rule in the existing `Prim/<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.
+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/package.json b/package.json
@@ -3,6 +3,7 @@
 	"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 Prim.zip Prim -x \"*.DS_Store\""
 	},
diff --git a/test/expectations/Semicolon.log b/test/expectations/Semicolon.log
diff --git a/test/expectations/WordRepitition.log b/test/expectations/WordRepitition.log
diff --git a/test/fixtures/AMPM/.vale.ini b/test/fixtures/AMPM/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/AMPM/test.md b/test/fixtures/AMPM/test.md
diff --git a/test/fixtures/AbbreviationPeriods/.vale.ini b/test/fixtures/AbbreviationPeriods/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/AbbreviationPeriods/test.md b/test/fixtures/AbbreviationPeriods/test.md
diff --git a/test/fixtures/Ambiguity/.vale.ini b/test/fixtures/Ambiguity/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Ambiguity/test.md b/test/fixtures/Ambiguity/test.md
diff --git a/test/fixtures/Contractions/.vale.ini b/test/fixtures/Contractions/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Contractions/test.md b/test/fixtures/Contractions/test.md
diff --git a/test/fixtures/Ellipsis/.vale.ini b/test/fixtures/Ellipsis/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Ellipsis/test.md b/test/fixtures/Ellipsis/test.md
diff --git a/test/fixtures/EmDash/.vale.ini b/test/fixtures/EmDash/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/EmDash/test.md b/test/fixtures/EmDash/test.md
diff --git a/test/fixtures/EnDash/.vale.ini b/test/fixtures/EnDash/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/EnDash/test.md b/test/fixtures/EnDash/test.md
diff --git a/test/fixtures/Latin/.vale.ini b/test/fixtures/Latin/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Latin/test.md b/test/fixtures/Latin/test.md
diff --git a/test/fixtures/OptionalPlurals/.vale.ini b/test/fixtures/OptionalPlurals/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/OptionalPlurals/test.md b/test/fixtures/OptionalPlurals/test.md
diff --git a/test/fixtures/Ordinal/.vale.ini b/test/fixtures/Ordinal/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Ordinal/test.md b/test/fixtures/Ordinal/test.md
diff --git a/test/fixtures/OxfordComma/.vale.ini b/test/fixtures/OxfordComma/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/OxfordComma/test.md b/test/fixtures/OxfordComma/test.md
diff --git a/test/fixtures/Percentages/.vale.ini b/test/fixtures/Percentages/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Percentages/test.md b/test/fixtures/Percentages/test.md
diff --git a/test/fixtures/PreferredAlternatives/.vale.ini b/test/fixtures/PreferredAlternatives/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/PreferredAlternatives/test.md b/test/fixtures/PreferredAlternatives/test.md
diff --git a/test/fixtures/RequiredAlternatives/.vale.ini b/test/fixtures/RequiredAlternatives/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/RequiredAlternatives/test.md b/test/fixtures/RequiredAlternatives/test.md
diff --git a/test/fixtures/Semicolon/.vale.ini b/test/fixtures/Semicolon/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Semicolon/test.md b/test/fixtures/Semicolon/test.md
diff --git a/test/fixtures/SentenceLength/.vale.ini b/test/fixtures/SentenceLength/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/SentenceLength/test.md b/test/fixtures/SentenceLength/test.md
diff --git a/test/fixtures/SimplerAlternatives/.vale.ini b/test/fixtures/SimplerAlternatives/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/SimplerAlternatives/test.md b/test/fixtures/SimplerAlternatives/test.md
diff --git a/test/fixtures/Space/.vale.ini b/test/fixtures/Space/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/Space/test.md b/test/fixtures/Space/test.md
diff --git a/test/fixtures/WordRepitition/.vale.ini b/test/fixtures/WordRepitition/.vale.ini
@@ -1,4 +1,4 @@
-StylesPath = ../../
+StylesPath = ../../../
 
 MinAlertLevel = suggestion
 
diff --git a/test/fixtures/WordRepitition/test.md b/test/fixtures/WordRepitition/test.md
diff --git a/test/rules.parameters.js b/test/rules.parameters.js
@@ -1,27 +1,17 @@
 import fs from "fs";
 import path from "path";
 
-function* walkSync(dir) {
-	const files = fs.readdirSync(dir, { withFileTypes: true });
-	for (const file of files) {
-		if (file.isDirectory()) {
-			yield* walkSync(path.join(dir, file.name));
-		} else {
-			yield path.join(dir, file.name);
-		}
-	}
-}
+const testDirectory = "test";
+const fixturesDirectory = "fixtures";
 
-const dir = path.resolve(process.cwd(), "test", "expectations");
-const extension = ".log";
-const parameters = [];
+const fixturesRoot = path.resolve(process.cwd(), testDirectory, fixturesDirectory);
+const parameters = fs.readdirSync(fixturesRoot, {
+	withFileTypes: false,
+	recursive: false
+}).map(fpath => path.basename(fpath));
 
-for (const filePath of walkSync(dir)) {
-  if (path.extname(filePath).toLowerCase() === extension) {
-		const fileName = path.basename(filePath).replace(extension, "");
-		const fileContent = fs.readFileSync(filePath).toString().trim();
-		parameters.push([fileName, fileContent]);
-	}
-}
-
-export default parameters;
+export {
+	parameters as default,
+	testDirectory,
+	fixturesDirectory
+};
diff --git a/test/rules.test.js b/test/rules.test.js
@@ -1,7 +1,7 @@
 import path from "path";
 import { execa } from "execa";
-import { expect, test } from "vitest";
-import scenario from "./rules.parameters.js";
+import { expect, it } from "vitest";
+import scenario, { testDirectory, fixturesDirectory } from "./rules.parameters.js";
 
 const command = "vale";
 const args = [
@@ -11,17 +11,18 @@ const args = [
 	"--relative",
 	"test.md"
 ]
-const fixturesDirectory = "fixtures";
+const snapshotsDirectory = "snapshots";
 
-test.each(scenario)(`Test: %s`, async (rule, expected) => {
+it.each(scenario)(`Test: %s`, async (rule) => {
 	let result;
 	try {
-		const cwd = path.resolve(process.cwd(), fixturesDirectory, rule);
-		const output = await execa(command, args, { cwd: cwd });
+		const fixtureLocation = path.resolve(process.cwd(), testDirectory, fixturesDirectory, rule);
+		const output = await execa(command, args, { cwd: fixtureLocation });
 		result = output.stdout;
 	} catch (error) {
 		result = error.stdout;
 	}
 
-	expect.soft(result.trim()).toBe(expected);
+	const snapshotFile = path.resolve(process.cwd(), testDirectory, snapshotsDirectory, `${rule}.log`);
+	await expect(result).toMatchFileSnapshot(snapshotFile);
 });
diff --git a/test/snapshots/AMPM.log b/test/snapshots/AMPM.log
@@ -2,4 +2,4 @@ test.md:3:24:Prim.AMPM:Use 'am' or 'pm' else 'a.m.' or 'p.m.' (preceded by a spa
 test.md:4:33:Prim.AMPM:Use 'am' or 'pm' else 'a.m.' or 'p.m.' (preceded by a space).
 test.md:4:41:Prim.AMPM:Use 'am' or 'pm' else 'a.m.' or 'p.m.' (preceded by a space).
 test.md:5:33:Prim.AMPM:Use 'am' or 'pm' else 'a.m.' or 'p.m.' (preceded by a space).
-test.md:6:30:Prim.AMPM:Use 'am' or 'pm' else 'a.m.' or 'p.m.' (preceded by a space).
+test.md:6:30:Prim.AMPM:Use 'am' or 'pm' else 'a.m.' or 'p.m.' (preceded by a space).
diff --git a/test/snapshots/AbbreviationPeriods.log b/test/snapshots/AbbreviationPeriods.log
@@ -1 +1 @@
-test.md:3:45:Prim.AbbreviationPeriods:Don't use periods with abbreviations such as 'H.T.T.P.S.'.
+test.md:3:45:Prim.AbbreviationPeriods:Don't use periods with abbreviations such as 'H.T.T.P.S.'.
diff --git a/test/snapshots/Ambiguity.log b/test/snapshots/Ambiguity.log
@@ -1 +1 @@
-test.md:3:49:Prim.Ambiguity:Avoid ambiguity. Don't use 'and/or'.
+test.md:3:49:Prim.Ambiguity:Avoid ambiguity. Don't use 'and/or'.
diff --git a/test/snapshots/Contractions.log b/test/snapshots/Contractions.log
@@ -103,4 +103,4 @@ test.md:267:14:Prim.Contractions:Avoid contractions. Use 'you are' instead of 'y
 test.md:270:1:Prim.Contractions:Avoid contractions. Use 'You had' or 'You would' instead of 'You'd'.
 test.md:271:4:Prim.Contractions:Avoid contractions. Use 'you had' or 'you would' instead of 'you'd'.
 test.md:274:7:Prim.Contractions:Avoid contractions. Use 'you have' instead of 'you've'.
-test.md:277:1:Prim.Contractions:Avoid contractions. Use 'You will' instead of 'You'll'.
+test.md:277:1:Prim.Contractions:Avoid contractions. Use 'You will' instead of 'You'll'.
diff --git a/test/snapshots/Ellipsis.log b/test/snapshots/Ellipsis.log
@@ -1,2 +1,2 @@
 test.md:3:23:Prim.Ellipsis:In general, don't use an ellipsis.
-test.md:4:22:Prim.Ellipsis:In general, don't use an ellipsis.
+test.md:4:22:Prim.Ellipsis:In general, don't use an ellipsis.
diff --git a/test/snapshots/EmDash.log b/test/snapshots/EmDash.log
@@ -1,2 +1,2 @@
 test.md:3:16:Prim.EmDash:Add spaces around '—'.
-test.md:3:45:Prim.EmDash:Add spaces around '—'.
+test.md:3:45:Prim.EmDash:Add spaces around '—'.
diff --git a/test/snapshots/EnDash.log b/test/snapshots/EnDash.log
@@ -1,3 +1,3 @@
 test.md:3:47:Prim.EnDash:Remove the spaces around '–'.
 test.md:4:31:Prim.EnDash:Remove the spaces around '–'.
-test.md:5:42:Prim.EnDash:Remove the spaces around '–'.
+test.md:5:42:Prim.EnDash:Remove the spaces around '–'.
diff --git a/test/snapshots/Latin.log b/test/snapshots/Latin.log
@@ -9,4 +9,4 @@ test.md:21:33:Prim.Latin:Avoid latin. Use 'that is' instead of 'ie,'.
 test.md:24:22:Prim.Latin:Avoid latin. Use 'against' instead of 'vs.'.
 test.md:27:26:Prim.Latin:Avoid latin. Use 'against' instead of 'versus'.
 test.md:30:33:Prim.Latin:Avoid latin. Use 'over' or 'through' instead of 'via'.
-test.md:33:31:Prim.Latin:Avoid latin. Use 'namely' instead of 'viz.'.
+test.md:33:31:Prim.Latin:Avoid latin. Use 'namely' instead of 'viz.'.
diff --git a/test/snapshots/OptionalPlurals.log b/test/snapshots/OptionalPlurals.log
@@ -1,2 +1,2 @@
 test.md:3:23:Prim.OptionalPlurals:Don't use plurals in parentheses such as in 'extension(s)'.
-test.md:4:5:Prim.OptionalPlurals:Don't use plurals in parentheses such as in 'checkbox(es)'.
+test.md:4:5:Prim.OptionalPlurals:Don't use plurals in parentheses such as in 'checkbox(es)'.
diff --git a/test/snapshots/Ordinal.log b/test/snapshots/Ordinal.log
@@ -1,3 +1,3 @@
 test.md:3:1:Prim.Ordinal:Don't add -ly to an ordinal number.
 test.md:3:45:Prim.Ordinal:Don't add -ly to an ordinal number.
-test.md:3:84:Prim.Ordinal:Don't add -ly to an ordinal number.
+test.md:3:84:Prim.Ordinal:Don't add -ly to an ordinal number.
diff --git a/test/snapshots/OxfordComma.log b/test/snapshots/OxfordComma.log
@@ -1,2 +1,2 @@
 test.md:3:41:Prim.OxfordComma:Use the Oxford comma in 'flour, sugar, eggs and butter.'.
-test.md:5:20:Prim.OxfordComma:Use the Oxford comma in 'clothes, toiletries or books?'.
+test.md:5:20:Prim.OxfordComma:Use the Oxford comma in 'clothes, toiletries or books?'.
diff --git a/test/snapshots/Percentages.log b/test/snapshots/Percentages.log
@@ -1 +1 @@
-test.md:3:28:Prim.Percentages:Use a numeral to represent a percentage.
+test.md:3:28:Prim.Percentages:Use a numeral to represent a percentage.
diff --git a/test/snapshots/PreferredAlternatives.log b/test/snapshots/PreferredAlternatives.log
@@ -1,3 +1,3 @@
 test.md:4:36:Prim.PreferredAlternatives:Prefer using 'Zero-day' over '0-day'.
 test.md:7:39:Prim.PreferredAlternatives:Prefer using 'Midnight' over '12 am'.
-test.md:10:30:Prim.PreferredAlternatives:Prefer using 'Noon' over '12 pm'.
+test.md:10:30:Prim.PreferredAlternatives:Prefer using 'Noon' over '12 pm'.
diff --git a/test/snapshots/RequiredAlternatives.log b/test/snapshots/RequiredAlternatives.log
@@ -3,4 +3,4 @@ test.md:7:27:Prim.RequiredAlternatives:Use '3D' instead of '3-D'.
 test.md:10:19:Prim.RequiredAlternatives:Use 'sync' instead of 'synch'.
 test.md:13:17:Prim.RequiredAlternatives:Use 'URL' instead of 'url'.
 test.md:14:5:Prim.RequiredAlternatives:Use 'URL of' instead of 'URL for'.
-test.md:15:10:Prim.RequiredAlternatives:Use 'a URL' instead of 'an URL'.
+test.md:15:10:Prim.RequiredAlternatives:Use 'a URL' instead of 'an URL'.
diff --git a/test/snapshots/Semicolon.log b/test/snapshots/Semicolon.log
@@ -0,0 +1 @@
+test.md:3:33:Prim.Semicolon:Try to simplify this sentence.
diff --git a/test/snapshots/SentenceLength.log b/test/snapshots/SentenceLength.log
@@ -1 +1 @@
-test.md:3:1:Prim.SentenceLength:Try to keep sentences short (< 30 words).
+test.md:3:1:Prim.SentenceLength:Try to keep sentences short (< 30 words).
diff --git a/test/snapshots/SimplerAlternatives.log b/test/snapshots/SimplerAlternatives.log
@@ -1 +1 @@
-test.md:4:31:Prim.SimplerAlternatives:Use 'about' instead of 'approximately'.
+test.md:4:31:Prim.SimplerAlternatives:Use 'about' instead of 'approximately'.
diff --git a/test/snapshots/Space.log b/test/snapshots/Space.log
@@ -3,4 +3,4 @@ test.md:4:35:Prim.Space:'door. It' should have one space between them.
 test.md:5:18:Prim.Space:'melody.It' should have one space between them.
 test.md:6:29:Prim.Space:'ruins? They' should have one space between them.
 test.md:7:32:Prim.Space:', marveling' should have one space between them.
-test.md:8:1:Prim.Space:'Whoa! This' should have one space between them.
+test.md:8:1:Prim.Space:'Whoa! This' should have one space between them.
diff --git a/test/snapshots/WordRepitition.log b/test/snapshots/WordRepitition.log
@@ -0,0 +1 @@
+test.md:3:14:Prim.WordRepitition:'zoom' is repeated.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-StylesPath = ../../`
	`1`	`+StylesPath = ../../../`
`2`	`2`
`3`	`3`	`MinAlertLevel = suggestion`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-test.md:3:45:Prim.AbbreviationPeriods:Don't use periods with abbreviations such as 'H.T.T.P.S.'.`
	`1`	`+test.md:3:45:Prim.AbbreviationPeriods:Don't use periods with abbreviations such as 'H.T.T.P.S.'.`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-test.md:3:49:Prim.Ambiguity:Avoid ambiguity. Don't use 'and/or'.`
	`1`	`+test.md:3:49:Prim.Ambiguity:Avoid ambiguity. Don't use 'and/or'.`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`test.md:3:23:Prim.Ellipsis:In general, don't use an ellipsis.`
`2`		`-test.md:4:22:Prim.Ellipsis:In general, don't use an ellipsis.`
	`2`	`+test.md:4:22:Prim.Ellipsis:In general, don't use an ellipsis.`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`test.md:3:16:Prim.EmDash:Add spaces around '—'.`
`2`		`-test.md:3:45:Prim.EmDash:Add spaces around '—'.`
	`2`	`+test.md:3:45:Prim.EmDash:Add spaces around '—'.`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`test.md:3:23:Prim.OptionalPlurals:Don't use plurals in parentheses such as in 'extension(s)'.`
`2`		`-test.md:4:5:Prim.OptionalPlurals:Don't use plurals in parentheses such as in 'checkbox(es)'.`
	`2`	`+test.md:4:5:Prim.OptionalPlurals:Don't use plurals in parentheses such as in 'checkbox(es)'.`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`test.md:3:41:Prim.OxfordComma:Use the Oxford comma in 'flour, sugar, eggs and butter.'.`
`2`		`-test.md:5:20:Prim.OxfordComma:Use the Oxford comma in 'clothes, toiletries or books?'.`
	`2`	`+test.md:5:20:Prim.OxfordComma:Use the Oxford comma in 'clothes, toiletries or books?'.`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-test.md:3:28:Prim.Percentages:Use a numeral to represent a percentage.`
	`1`	`+test.md:3:28:Prim.Percentages:Use a numeral to represent a percentage.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+test.md:3:33:Prim.Semicolon:Try to simplify this sentence.`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-test.md:3:1:Prim.SentenceLength:Try to keep sentences short (< 30 words).`
	`1`	`+test.md:3:1:Prim.SentenceLength:Try to keep sentences short (< 30 words).`