OXfmt Config

Opinionated, shared OXFmt configuration for my projects.

Install

pnpm add -D @mheob/oxfmt-config oxfmt

Usage

Create an oxfmt.config.ts at the root of your project and spread the provided config:

// oxfmt.config.ts
import { baseConfig } from '@mheob/oxfmt-config';
import { defineConfig } from 'oxfmt';

export default defineConfig({
	...baseConfig,
});

Add project-specific overrides on top:

// oxfmt.config.ts
import { baseConfig } from '@mheob/oxfmt-config';
import { defineConfig } from 'oxfmt';

export default defineConfig({
	...baseConfig,
	printWidth: 100,
});

Available configs

baseConfig

The foundation for all projects. Applies the following formatting defaults:

| Option | Value | Description | | --- | --- | --- | | proseWrap | always | Wraps prose in Markdown files | | singleQuote | true | Uses single quotes instead of double quotes | | useTabs | true | Indents with tabs instead of spaces | | sortImports | enabled | Groups imports: types, builtin, external, internal, relative, styles | | sortPackageJson | enabled | Sorts package.json fields, including scripts | | sortTailwindcss | true | Sorts Tailwind CSS classes |

Also ships with file-specific overrides:

| Files | Override | | -------------------------- | -------------------------------------------------- | | {.cspell,tsconfig}*.json | Uses jsonc parser to support comments | | *.md | Sets proseWrap: 'never' (one line per paragraph) | | *.{yaml,yml} | Sets printWidth: 130, double quotes, spaces |

Editor integration

VS Code

Install the OXC VS Code extension and add to .vscode/settings.json:

{
	"editor.defaultFormatter": "oxc.oxc-vscode",
	"editor.formatOnSave": true,
}

Zed

Add to .zed/settings.json:

{
	"formatter": {
		"external": {
			"command": "oxfmt",
			"arguments": ["--stdin-filepath", "{buffer_path}"],
		},
	},
	"format_on_save": "on",
}

Scripts

Add to your package.json:

{
	"scripts": {
		"format": "oxfmt",
		"format:check": "oxfmt --check"
	}
}