Format shell scripts

Author: porada

.oxlintrc.json

@@ -2,6 +2,7 @@
 	"plugins": [
 		"eslint",
 		"import",
+		"jsdoc",
 		"node",
 		"oxc",
 		"promise",

README.md

@@ -7,6 +7,7 @@
 Curated Prettier config for modern TypeScript projects.
 
 - Enables the [`oxc` parser](https://oxc.rs/docs/guide/usage/parser.html) for lightning-fast TypeScript formatting.
+- Formats shell scripts out of the box, including `git` hooks.
 - Sorts all JSON files, with curated order patterns for common config files: `package.json`, `tsconfig.json`, `.oxlintrc.json`, and more.
 
 ## Install

package.json

@@ -35,6 +35,7 @@
 		"@prettier/plugin-oxc": "^0.1.3",
 		"klona": "^2.0.6",
 		"prettier-plugin-packagejson": "2.5.20",
+		"prettier-plugin-sh": "^0.18.0",
 		"prettier-plugin-sort-json": "4.1.1"
 	},
 	"peerDependencies": {

src/config.test.ts

@@ -1,10 +1,14 @@
-import type { Config } from 'prettier';
+import type { Config, Options } from 'prettier';
 import { expectTypeOf, test } from 'vitest';
-import BASE_CONFIG from './config.ts';
+import { DEFAULT_CONFIG, DEFAULT_OPTIONS } from './config.ts';
 
 test('is a valid Prettier config', () => {
-	expectTypeOf(BASE_CONFIG).toExtend<Config>();
+	expectTypeOf(DEFAULT_CONFIG).toExtend<Config>();
+	expectTypeOf(DEFAULT_OPTIONS).toExtend<Options>();
 
 	/* @ts-expect-error */
-	BASE_CONFIG.quoteProps = 'all';
+	DEFAULT_CONFIG.quoteProps = 'all';
+
+	/* @ts-expect-error */
+	DEFAULT_OPTIONS.quoteProps = 'all';
 });

src/config.ts

@@ -1,56 +1,90 @@
-import type { Config } from 'prettier';
+import type { Config, Options } 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 * as pluginShell from 'prettier-plugin-sh';
 import prioritizeKeys from './prioritize-keys/index.ts';
 
-const config = {
+/**
+ * Shell files can’t be reliably identified by name alone—they’re recognized by
+ * the shebang, not the extension. As a result, shell formatting options
+ * (two-space indentation) must be defined as the global defaults.
+ *
+ * This requires overriding those options for other file types individually
+ * with what we consider the actual defaults. This object defines them.
+ */
+export const DEFAULT_OPTIONS = {
+	tabWidth: 4,
+	useTabs: true,
+} as const satisfies Options;
+
+export const DEFAULT_CONFIG = {
+	plugins: [pluginOxidation, pluginPackageJSON, pluginShell, pluginSortJSON],
 	bracketSpacing: true,
-	plugins: [pluginOxidation, pluginPackageJSON, pluginSortJSON],
 	printWidth: 80,
 	quoteProps: 'consistent',
 	singleQuote: true,
-	tabWidth: 4,
+	tabWidth: 2,
 	trailingComma: 'es5',
-	useTabs: true,
+	useTabs: false,
 	overrides: [
 		{
 			files: ['*.css', '*.scss'],
 			options: {
+				...DEFAULT_OPTIONS,
 				printWidth: 100,
 				singleQuote: false,
 			},
 		},
+		/**
+		 * Fish file formatting follows the output of `fish_indent`, which
+		 * defaults to four-space indentation.
+		 */
+		{
+			files: ['*.fish'],
+			options: {
+				tabWidth: 4,
+			},
+		},
 		{
-			files: ['*.html'],
+			files: ['*.graphql', '*.graphqls', '*.gql'],
 			options: {
+				...DEFAULT_OPTIONS,
+			},
+		},
+		{
+			files: ['*.html', '*.htm'],
+			options: {
+				...DEFAULT_OPTIONS,
 				printWidth: 100,
 			},
 		},
 		{
 			files: ['*.js', '*.jsx', '*.cjs', '*.mjs'],
 			options: {
+				...DEFAULT_OPTIONS,
 				parser: 'oxc',
 			},
 		},
 		{
-			files: ['*.json', '*.jsonc'],
+			files: ['*.json', '*.jsonc', '*.json5'],
 			options: {
+				...DEFAULT_OPTIONS,
 				jsonRecursiveSort: true,
 				jsonSortOrder: prioritizeKeys('$schema'),
 			},
 		},
 		{
-			files: ['*.ts', '*.tsx', '*.cts', '*.mts'],
+			files: ['*.md', '*.mdx'],
 			options: {
-				parser: 'oxc-ts',
+				...DEFAULT_OPTIONS,
 			},
 		},
 		{
-			files: ['*.yaml', '*.yml'],
+			files: ['*.ts', '*.tsx', '*.cts', '*.mts'],
 			options: {
-				tabWidth: 2,
-				useTabs: false,
+				...DEFAULT_OPTIONS,
+				parser: 'oxc-ts',
 			},
 		},
 		{
@@ -128,5 +162,3 @@ const config = {
 		},
 	],
 } as const satisfies Config;
-
-export default config;

src/define-config/index.test.ts

@@ -1,13 +1,13 @@
 import type { Config } from 'prettier';
 import { expect, expectTypeOf, test } from 'vitest';
-import BASE_CONFIG from '../config.ts';
+import { DEFAULT_CONFIG } from '../config.ts';
 import defineConfig from './index.ts';
 
 test('returns the base config by default', () => {
 	const result = defineConfig();
 
 	expectTypeOf(result).toEqualTypeOf<Config>();
-	expect(result).toStrictEqual(BASE_CONFIG);
+	expect(result).toStrictEqual(DEFAULT_CONFIG);
 });
 
 test('merges custom config with the base config', () => {
@@ -31,8 +31,8 @@ test('merges custom config with the base config', () => {
 	expect(result).toHaveProperty('useTabs', false);
 	expect(result).toHaveProperty('overrides', expect.any(Array));
 	expect(result).toStrictEqual({
-		...BASE_CONFIG,
+		...DEFAULT_CONFIG,
 		...config,
-		overrides: [...BASE_CONFIG.overrides, ...config.overrides],
+		overrides: [...DEFAULT_CONFIG.overrides, ...config.overrides],
 	});
 });

src/define-config/index.ts

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