feat(prettier-config): update to Prettier v3

BREAKING CHANGE: This package now depends on [Prettier v3](https://prettier.io/blog/2023/07/05/3.0.0.html). The config as exported by this package is now an EcmaScript Module, which means that it can no longer be imported in CJS with `require`. You should update your prettier config to use ESM instead.

Author: favna

.prettierrc.js

@@ -0,0 +1,3 @@
+import prettierConfig from "./packages/prettier-config/dist/index.mjs";
+
+export default prettierConfig;

.prettierrc.mjs

@@ -29,21 +29,20 @@
 		"@types/lodash": "^4.14.195",
 		"@types/node": "^18.16.19",
 		"@types/ws": "^8.5.5",
-		"@typescript-eslint/eslint-plugin": "^5.62.0",
-		"@typescript-eslint/parser": "^5.62.0",
+		"@typescript-eslint/eslint-plugin": "^6.0.0",
+		"@typescript-eslint/parser": "^6.0.0",
 		"@vitest/coverage-v8": "^0.33.0",
 		"cz-conventional-changelog": "^3.3.0",
 		"discord-api-types": "^0.37.48",
 		"discord.js": "^14.11.0",
 		"eslint": "^8.45.0",
 		"eslint-config-prettier": "^8.8.0",
-		"eslint-plugin-prettier": "^4.2.1",
+		"eslint-plugin-prettier": "^5.0.0",
 		"husky": "^8.0.3",
 		"lint-staged": "^13.2.3",
 		"lodash": "^4.17.21",
 		"nock": "^13.3.2",
-		"prettier": "^2.8.8",
-		"pretty-quick": "^3.1.3",
+		"prettier": "^3.0.0",
 		"rimraf": "^5.0.1",
 		"tslib": "^2.6.0",
 		"tsup": "^7.1.0",
@@ -67,6 +66,7 @@
 		]
 	},
 	"lint-staged": {
+		"*": "prettier --ignore-unknown --write",
 		"*.{mjs,js,ts}": "eslint --fix --ext mjs,js,ts"
 	},
 	"config": {

package.json

@@ -4,33 +4,33 @@
 	"description": "Standard Prettier config for the Sapphire Community",
 	"author": "@sapphire",
 	"license": "MIT",
-	"main": "dist/index.js",
+	"main": "dist/index.mjs",
+	"module": "dist/index.mjs",
+	"type": "module",
 	"exports": {
-		"import": "./dist/index.js",
-		"require": "./dist/index.js"
+		"import": "./dist/index.mjs",
+		"require": "./dist/index.mjs"
 	},
 	"sideEffects": false,
 	"homepage": "https://github.com/sapphiredev/utilities/tree/main/packages/prettier-config",
 	"scripts": {
 		"test": "vitest run",
 		"lint": "yarn test && yarn build && eslint src tests --ext ts --fix -c ../../.eslintrc",
-		"build": "tsup",
+		"build": "tsc -b src",
 		"prepack": "yarn build",
 		"bump": "cliff-jumper",
 		"check-update": "cliff-jumper --dry-run"
 	},
 	"dependencies": {
-		"prettier": "^2.8.8"
+		"prettier": "^3.0.0"
 	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/sapphiredev/utilities.git",
 		"directory": "packages/prettier-config"
 	},
 	"files": [
-		"dist/**/*.js*",
-		"dist/**/*.mjs*",
-		"dist/**/*.d*"
+		"dist/"
 	],
 	"engines": {
 		"node": ">=v14.0.0",
@@ -55,8 +55,8 @@
 	"devDependencies": {
 		"@favware/cliff-jumper": "^2.1.1",
 		"@vitest/coverage-v8": "^0.33.0",
-		"tsup": "^7.1.0",
 		"typedoc-json-parser": "^8.2.0",
+		"typescript": "^5.1.6",
 		"vitest": "^0.33.0"
 	}
 }

packages/prettier-config/package.json

@@ -1,4 +1,5 @@
-import type { PrettierSchema } from './schema';
+import type { Config } from 'prettier';
+
 /**
  * Standard Prettier config for the Sapphire Community
  * @example
@@ -8,8 +9,7 @@ import type { PrettierSchema } from './schema';
  * }
  * ```
  */
-const prettierConfig: PrettierSchema = {
-	$schema: 'http://json.schemastore.org/prettierrc',
+const prettierConfig: Config = {
 	endOfLine: 'lf',
 	printWidth: 150,
 	quoteProps: 'as-needed',
@@ -29,4 +29,4 @@ const prettierConfig: PrettierSchema = {
 	]
 };
 
-module.exports = prettierConfig;
+export default prettierConfig;

packages/prettier-config/src/index.ts packages/prettier-config/src/index.mts

@@ -3,7 +3,11 @@
 	"compilerOptions": {
 		"rootDir": "./",
 		"outDir": "../dist",
-		"incremental": false
+		"incremental": false,
+		"declaration": false,
+		"sourceMap": false,
+		"declarationMap": false,
+		"moduleResolution": "Node16"
 	},
 	"include": ["."]
 }

packages/prettier-config/src/schema.d.ts

@@ -2,7 +2,6 @@
 
 exports[`Prettier Config > should export rules 1`] = `
 {
-  "$schema": "http://json.schemastore.org/prettierrc",
   "endOfLine": "lf",
   "overrides": [
     {

packages/prettier-config/src/tsconfig.json

@@ -1,9 +1,7 @@
-// @ts-expect-error TS considers the src to not be a module because it uses module.exports but vitest transpiles it just fine for this
-import prettierConfig from '../src';
+import prettierConfig from '../src/index.mjs';
 
 describe('Prettier Config', () => {
 	test('should export rules', () => {
-		expect(prettierConfig.$schema).toBe('http://json.schemastore.org/prettierrc');
 		expect(prettierConfig.useTabs).toBe(true);
 		expect(prettierConfig).toMatchSnapshot();
 	});

packages/prettier-config/tests/__snapshots__/prettier.test.ts.snap

@@ -3,6 +3,7 @@
 	"compilerOptions": {
 		"noEmit": true,
 		"incremental": false,
+		"moduleResolution": "Node16",
 		"types": ["vitest/globals"]
 	},
 	"include": ["./"]