https://github.com/alpheuscfg/oxfmt
A shareable Oxfmt configuration
https://github.com/alpheuscfg/oxfmt
config javascript oxc oxfmt shareable typescript
Last synced: about 1 month ago
JSON representation
A shareable Oxfmt configuration
- Host: GitHub
- URL: https://github.com/alpheuscfg/oxfmt
- Owner: alpheuscfg
- License: mit
- Created: 2026-03-19T07:29:23.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-06-12T00:10:15.000Z (about 1 month ago)
- Last Synced: 2026-06-12T02:07:19.941Z (about 1 month ago)
- Topics: config, javascript, oxc, oxfmt, shareable, typescript
- Language: TypeScript
- Homepage:
- Size: 348 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Oxfmt Configuration
A shareable Oxfmt configuration.
## Installation
Install these packages as a dev dependencies in the project:
```sh
# npm
npm i -D oxfmt @apst/oxfmt
# Yarn
yarn add -D oxfmt @apst/oxfmt
# pnpm
pnpm add -D oxfmt @apst/oxfmt
# Bun
bun add -D oxfmt @apst/oxfmt
```
## Usage
Implement the configuration into `oxfmt.config.ts`:
```ts
import { defineConfig } from "@apst/oxfmt";
export default defineConfig();
```
It is possible to override the default configuration by passing an object to the `defineConfig` function:
```ts
import { defineConfig } from "@apst/oxfmt";
import { IGNORE_PATTERNS_DEFAULT } from "@apst/oxfmt/constants/ignore-patterns";
export default defineConfig({
ignorePatterns: [
...IGNORE_PATTERNS_DEFAULT,
// ...
],
});
```
## License
This project is licensed under the terms of the MIT license.