@standard-config/prettier 1.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright © Dom Porada <dom@dom.engineering> (https://dom.engineering)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,36 @@
+# @standard-config/prettier
+
+Curated Prettier config for modern TypeScript projects.
+
+- Enables the [`oxc` parser](https://oxc.rs/docs/guide/usage/parser.html) for lightning-fast TypeScript formatting.
+- Sorts all JSON files, with curated order patterns for common config files: `package.json`, `tsconfig.json`, `.oxlintrc.json`, and more.
+
+## Install
+
+```sh
+npm install --save-dev @standard-config/prettier
+```
+
+```sh
+pnpm add --save-dev @standard-config/prettier
+```
+
+## Usage
+
+Create your `prettier.config.ts`:
+
+```ts
+import { defineConfig } from '@standard-config/prettier';
+
+export default defineConfig();
+```
+
+Optionally, pass your own [config options](https://prettier.io/docs/options) to overwrite the [package defaults](src/config.ts):
+
+```ts
+import { defineConfig } from '@standard-config/prettier';
+
+export default defineConfig({
+	semi: false,
+});
+```

package/package.json

@@ -0,0 +1,61 @@
+{
+	"name": "@standard-config/prettier",
+	"version": "1.0.0",
+	"description": "Curated Prettier config for modern TypeScript projects",
+	"license": "MIT",
+	"author": {
+		"name": "Dom Porada",
+		"email": "dom@dom.engineering",
+		"url": "https://dom.engineering"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/standard-config/prettier.git"
+	},
+	"keywords": [
+		"json-sorting",
+		"oxc",
+		"oxc-parser",
+		"prettier-config",
+		"standard-config",
+		"typescript"
+	],
+	"files": [
+		"src/**/*.ts",
+		"!**/*.test.ts"
+	],
+	"type": "module",
+	"sideEffects": false,
+	"exports": "./src/index.ts",
+	"engines": {
+		"node": ">=24"
+	},
+	"packageManager": "pnpm@10.27.0",
+	"dependencies": {
+		"@prettier/plugin-oxc": "^0.1.3",
+		"klona": "^2.0.6",
+		"prettier-plugin-packagejson": "2.5.20",
+		"prettier-plugin-sort-json": "4.1.1"
+	},
+	"peerDependencies": {
+		"prettier": ">=3.7"
+	},
+	"devDependencies": {
+		"@standard-config/tsconfig": "^1.0.0",
+		"@vitest/coverage-v8": "~4.0.16",
+		"oxlint": "~1.38.0",
+		"oxlint-tsgolint": "~0.10.1",
+		"prettier": "^3.7.4",
+		"typescript": "^5.9.3",
+		"vitest": "~4.0.16"
+	},
+	"scripts": {
+		"format": "prettier --write --ignore-unknown .",
+		"format:ci": "prettier --check --ignore-unknown .",
+		"lint": "oxlint --fix --type-aware --type-check --deny-warnings --report-unused-disable-directives",
+		"lint:ci": "oxlint --type-aware --type-check --deny-warnings --report-unused-disable-directives",
+		"prepack": "pnpm run '/^(format:ci|lint:ci|test|typecheck)$/'",
+		"test": "vitest run",
+		"typecheck": "tsc --noEmit"
+	}
+}

package/src/config.ts

@@ -0,0 +1,138 @@
+import type { Config } from 'prettier';
+import * as pluginOxidation from '@prettier/plugin-oxc';
+import * as pluginPackageJSON from 'prettier-plugin-packagejson';
+import * as pluginSortJSON from 'prettier-plugin-sort-json';
+import prioritizeKeys from './prioritize-keys/index.ts';
+
+const config = {
+	bracketSpacing: true,
+	printWidth: 80,
+	quoteProps: 'consistent',
+	singleQuote: true,
+	tabWidth: 4,
+	trailingComma: 'es5',
+	useTabs: true,
+	overrides: [
+		{
+			files: ['*.css', '*.scss'],
+			options: {
+				printWidth: 100,
+				singleQuote: false,
+			},
+		},
+		{
+			files: ['*.html'],
+			options: {
+				printWidth: 100,
+				singleQuote: false,
+			},
+		},
+		{
+			files: ['*.js', '*.jsx', '*.cjs', '*.mjs'],
+			options: {
+				plugins: [pluginOxidation],
+				parser: 'oxc',
+			},
+		},
+		{
+			files: ['*.json', '*.jsonc'],
+			options: {
+				plugins: [pluginSortJSON],
+				jsonRecursiveSort: true,
+				jsonSortOrder: prioritizeKeys('$schema'),
+			},
+		},
+		{
+			files: ['*.ts', '*.tsx', '*.cts', '*.mts'],
+			options: {
+				plugins: [pluginOxidation],
+				parser: 'oxc-ts',
+			},
+		},
+		{
+			files: ['*.yaml', '*.yml'],
+			options: {
+				tabWidth: 2,
+				useTabs: false,
+			},
+		},
+		{
+			files: [
+				'jsconfig.json',
+				'jsconfig.*.json',
+				'tsconfig.json',
+				'tsconfig.*.json',
+			],
+			options: {
+				plugins: [pluginSortJSON],
+				jsonSortOrder: prioritizeKeys(
+					'extends',
+					'compilerOptions',
+					'files',
+					'include',
+					'exclude'
+				),
+			},
+		},
+		{
+			files: ['package.json'],
+			options: {
+				plugins: [pluginSortJSON, pluginPackageJSON],
+				packageSortOrder: [
+					'name',
+					'private',
+					'version',
+					'description',
+					'license',
+					'author',
+					'repository',
+					'keywords',
+					'directories',
+					'files',
+					'type',
+					'sideEffects',
+					'main',
+					'exports',
+					'types',
+					'bin',
+					'imports',
+					'engines',
+					'packageManager',
+					'dependencies',
+					'peerDependencies',
+					'peerDependenciesMeta',
+					'devDependencies',
+					'scripts',
+				],
+			},
+		},
+		{
+			files: [
+				'oxlintrc.json',
+				'oxlintrc.jsonc',
+				'oxlintrc.*.json',
+				'oxlintrc.*.jsonc',
+				'.oxlintrc.json',
+				'.oxlintrc.jsonc',
+				'.oxlintrc.*.json',
+				'.oxlintrc.*.jsonc',
+			],
+			options: {
+				plugins: [pluginSortJSON],
+				jsonSortOrder: prioritizeKeys(
+					'$schema',
+					'files',
+					'extends',
+					'plugins',
+					'categories',
+					'env',
+					'settings',
+					'rules',
+					'overrides'
+				),
+			},
+		},
+	],
+} as const satisfies Config;
+
+export default config;

package/src/define-config/index.ts

@@ -0,0 +1,7 @@
+import type { Config } from 'prettier';
+import BASE_CONFIG from '../config.ts';
+import mergeConfig from '../merge-config/index.ts';
+
+export default function defineConfig(config: Config = {}): Config {
+	return mergeConfig(BASE_CONFIG, config);
+}

package/src/index.ts

@@ -0,0 +1,5 @@
+/* oxlint-disable-next-line import/no-unassigned-import */
+import './types/index.d.ts';
+
+export { default as defineConfig } from './define-config/index.ts';
+export { default as prioritizeKeys } from './prioritize-keys/index.ts';

package/src/merge-config/index.ts

@@ -0,0 +1,38 @@
+import type { Config } from 'prettier';
+import { klona as clone } from 'klona/lite';
+
+export default function mergeConfig(
+	baseConfig: Config,
+	extensionConfig: Config
+): Config {
+	if (
+		!(typeof baseConfig === 'object' && typeof extensionConfig === 'object')
+	) {
+		throw new TypeError(
+			'Prettier config error: expected config to be an object'
+		);
+	}
+
+	const result = clone(baseConfig);
+
+	for (const [key, value] of Object.entries(clone(extensionConfig))) {
+		if (value === undefined) {
+			/* oxlint-disable-next-line typescript/no-dynamic-delete */
+			delete result[key];
+			continue;
+		}
+
+		if (isArray(value) && isArray(result[key])) {
+			result[key] = [...result[key], ...value];
+			continue;
+		}
+
+		result[key] = value;
+	}
+
+	return result;
+}
+
+function isArray(value: unknown): value is unknown[] {
+	return Array.isArray(value);
+}

package/src/prioritize-keys/index.ts

@@ -0,0 +1,14 @@
+export default function prioritizeKeys(...keys: ReadonlyArray<string>): string {
+	/* oxlint-disable-next-line typescript/no-restricted-types */
+	const order: Record<string, null> = {};
+
+	for (const key of keys) {
+		order[String(key)] = null;
+	}
+
+	return JSON.stringify({
+		...order,
+		/* oxlint-disable-next-line typescript/no-explicit-any */
+		[/.*/ as any]: 'lexical',
+	});
+}

package/src/types/index.d.ts

@@ -0,0 +1,14 @@
+import './vendor.d.ts';
+
+declare module 'prettier' {
+	interface Options {
+		// Pending pull request:
+		// https://github.com/Gudahtt/prettier-plugin-sort-json/pull/292
+		jsonRecursiveSort?: boolean | undefined;
+		jsonSortOrder?: string | undefined;
+
+		// Pending pull request:
+		// https://github.com/matzkoh/prettier-plugin-packagejson/pull/270
+		packageSortOrder?: string[] | undefined;
+	}
+}

package/src/types/vendor.d.ts

@@ -0,0 +1,10 @@
+// Pending pull request:
+// https://github.com/matzkoh/prettier-plugin-packagejson/pull/270
+declare module 'prettier-plugin-packagejson' {
+	import type { Plugin } from 'prettier';
+
+	export const testPath: (path: string) => boolean;
+
+	export const options: NonNullable<Plugin['options']>;
+	export const parsers: NonNullable<Plugin['parsers']>;
+}