@sister.software/oxfmt-config
v9.3.0
Published
Sister Software's oxfmt config
Readme
@sister.software/oxfmt-config
Sister Software's shared oxfmt formatter configuration.
Replaces @sister.software/prettier-config. oxfmt covers natively what previously needed three
Prettier plugins: import organization, JSDoc formatting, and package.json key ordering.
Install
yarn add -D @sister.software/oxfmt-config oxfmtoxfmt is a peer dependency.
Usage
oxfmt has no extends, so spread the config into your own oxfmt.config.ts (oxfmt auto-discovers
it):
import { sisterSoftwareOxfmtConfig } from "@sister.software/oxfmt-config"
export default {
...sisterSoftwareOxfmtConfig,
// per-repo tweaks, e.g. ignorePatterns
}What it sets
- Tabs, print width 120, no semicolons,
es5trailing commas, bracket spacing — ported from the prior Prettier config. sortImports— import organization (replacesprettier-plugin-organize-imports).jsdoc— JSDoc comment formatting (replacesprettier-plugin-jsdoc).sortPackageJson—package.jsonkey ordering (replacesprettier-plugin-packagejson).
To customize import grouping, pass an object to sortImports instead of the default — see oxfmt's
SortImportsUserConfig.
