@getjerry/oxfmt-config

Usage

Install

pnpm i -D @getjerry/oxfmt-config

Create a config file

In oxfmt.config.ts:

import { getjerry } from '@getjerry/oxfmt-config';

export default getjerry({
  ignorePatterns: ['pnpm-lock.yaml', '**/CHANGELOG.md'],
  // override default options
});

Add scripts in package.json

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

Work together with eslint:

{
  "scripts": {
    "lint": "eslint . && oxfmt --check",
    "lint:fix": "eslint --fix . && oxfmt"
  }
}

Customizations

Override default config

import { getjerry } from '@getjerry/oxfmt-config';

export default getjerry({
  // override default rules (not recommended, better to keep prettier config consistent among projects)
  quoteProps: 'consistent',
});

Editor Integration

VSCode settings

Add the following settings to your .vscode/settings.json:

{
  "editor.defaultFormatter": "oxc.oxc-vscode",
  "editor.formatOnSave": true,
  "editor.insertSpaces": true,
  "editor.tabSize": 2,

  "files.encoding": "utf8",
  "files.eol": "\n",
  "files.trimFinalNewlines": true,
  "files.trimTrailingWhitespace": true,
  "[markdown]": {
    "files.trimTrailingWhitespace": false,
  },
}