Switch from prettier to dprint (#52)

Author: kevgo

.prettierignore

@@ -0,0 +1,23 @@
+{
+  "typescript": {
+    "semiColons": "asi",
+    "lineWidth": 120,
+    "trailingCommas": "never"
+  },
+  "json": {
+    "trailingCommas": "never"
+  },
+  "markdown": {
+    "textWrap": "always"
+  },
+  "markup": {},
+  "yaml": {},
+  "excludes": ["dist/", "node_modules", "package-lock.json"],
+  "plugins": [
+    "https://plugins.dprint.dev/typescript-0.94.0.wasm",
+    "https://plugins.dprint.dev/json-0.20.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.18.0.wasm",
+    "https://plugins.dprint.dev/g-plane/markup_fmt-v0.19.0.wasm",
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.0.wasm"
+  ]
+}

.prettierrc.json

@@ -13,22 +13,22 @@ export default [
       globals: {
         console: "readonly",
         module: "readonly",
-        process: "readonly",
+        process: "readonly"
       },
       parser: tsParser,
       parserOptions: {
-        project: "./tsconfig.json",
+        project: "./tsconfig.json"
       },
-      sourceType: "module",
+      sourceType: "module"
     },
     plugins: {
-      "@typescript-eslint": tslintPlugin,
+      "@typescript-eslint": tslintPlugin
     },
     rules: {
       ...tslintPlugin.configs.recommended.rules,
       "no-empty-function": "error",
-      "prefer-const": "error",
-    },
+      "prefer-const": "error"
+    }
   },
-  perfectionist.configs["recommended-natural"],
+  perfectionist.configs["recommended-natural"]
 ]

dprint.json

@@ -18,8 +18,8 @@
     "clean": "rm -rf dist",
     "coverage": "node --test --import tsx --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=lcov.info -- test/*.test.ts",
     "doc": "text-runner",
-    "fix": "prettier --write . && eslint --fix && sort-package-json",
-    "lint": "eslint && prettier --list-different . && tsc --noEmit && sort-package-json --check",
+    "fix": "dprint fmt && eslint --fix && sort-package-json",
+    "lint": "eslint && dprint check && tsc --noEmit && sort-package-json --check",
     "prepublishOnly": "tsc",
     "setup": "npm install",
     "test": "npm run lint && npm run unit && npm run doc",
@@ -35,9 +35,9 @@
     "@types/diff": "5.0.0",
     "@types/node": "22.13.10",
     "@typescript-eslint/eslint-plugin": "8.26.1",
+    "dprint": "0.49.0",
     "eslint": "9.22.0",
     "eslint-plugin-perfectionist": "4.10.1",
-    "prettier": "2.3.1",
     "sort-package-json": "1.57.0",
     "strip-ansi": "6.0.0",
     "text-runner": "7.1.0",

eslint.config.mjs

@@ -5,7 +5,11 @@ import * as diff from "diff"
  * Checks the two given strings character-by-character for equality.
  * If there are any differences, it throws an exception with a Bash-colored diff as the error message.
  */
-export function chars(actual: string, expected: string, message = "mismatching strings"): void {
+export function chars(
+  actual: string,
+  expected: string,
+  message = "mismatching strings"
+) {
   if (actual == null) {
     throw new Error("AssertNoDiff: actual value not provided")
   }
@@ -26,7 +30,7 @@ export function json(
   actual: Record<string, unknown> | string[],
   expected: Record<string, unknown> | string[],
   message = "mismatching objects"
-): void {
+) {
   if (!actual) {
     throw new Error("AssertNoDiff: actual value not provided")
   }
@@ -44,7 +48,11 @@ export function json(
  * Extra whitespace is ignored.
  * If there are any differences, it throws an exception with a Bash-colored diff as the error message.
  */
-export function trimmedLines(actual: string, expected: string, message = "mismatching lines"): void {
+export function trimmedLines(
+  actual: string,
+  expected: string,
+  message = "mismatching lines"
+) {
   if (actual == null) {
     throw new Error("AssertNoDiff: actual value not provided")
   }
@@ -61,7 +69,11 @@ export function trimmedLines(actual: string, expected: string, message = "mismat
  * Checks the two given strings word-by-word for equality treating whitespace as significant.
  * If there are any differences, it throws an exception with a Bash-colored diff as the error message.
  */
-export function wordsWithSpace(actual: string, expected: string, message = "mismatching words"): void {
+export function wordsWithSpace(
+  actual: string,
+  expected: string,
+  message = "mismatching words"
+) {
   if (actual == null) {
     throw new Error("AssertNoDiff: actual value not provided")
   }

package-lock.json

@@ -1,45 +1,45 @@
+import chalk from "chalk"
 import assert from "node:assert/strict"
 import { suite, test } from "node:test"
-import chalk from "chalk"
 import stripAnsi from "strip-ansi"
 import * as assertNoDiff from "../src/index"
 
-suite("assertNoDiff.chars()", function () {
-  test("matching data", function () {
+suite("assertNoDiff.chars()", function() {
+  test("matching data", function() {
     const data = "Jean-Luc Picard"
     assertNoDiff.chars(data, data)
   })
 
-  test("mismatching data", function () {
+  test("mismatching data", function() {
     const obj1 = "Jean-Luc Picard"
     const obj2 = "Captain Picard"
     const expected = chalk`mismatching strings:
 
 {red Je}{green C}{grey a}{green ptai}{grey n}{red -Luc}{grey  Picard}`
     assert.throws(
-      function () {
+      function() {
         assertNoDiff.chars(obj2, obj1)
       },
       new Error(expected),
       "should throw color-coded diff"
     )
   })
 
-  test("no expected value", function () {
-    assert.throws(function () {
+  test("no expected value", function() {
+    assert.throws(function() {
       // @ts-ignore: intentional call without second argument
       assertNoDiff.chars("foo")
     }, new Error("AssertNoDiff: expected value not provided"))
   })
 
-  test("no actual value", function () {
-    assert.throws(function () {
+  test("no actual value", function() {
+    assert.throws(function() {
       // @ts-ignore: intentional call without arguments
       assertNoDiff.chars()
     }, new Error("AssertNoDiff: actual value not provided"))
   })
 
-  test("providing a custom message", function () {
+  test("providing a custom message", function() {
     try {
       assertNoDiff.chars("one", "two", "custom message")
     } catch (e) {
@@ -50,7 +50,7 @@ suite("assertNoDiff.chars()", function () {
     throw new Error("assertNoDiff.chars didn't throw")
   })
 
-  test("diffing against empty strings", function () {
+  test("diffing against empty strings", function() {
     assertNoDiff.chars("", "")
   })
 })