https://github.com/dethdkn/ox-config

⚓ My Opinionated OX Config
https://github.com/dethdkn/ox-config

Last synced: 4 months ago
JSON representation

⚓ My Opinionated OX Config

• Host: GitHub
• URL: https://github.com/dethdkn/ox-config
• Owner: dethdkn
• License: mit
• Created: 2025-12-02T17:46:45.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2026-01-07T13:04:41.000Z (5 months ago)
• Last Synced: 2026-01-13T21:21:18.084Z (5 months ago)
• Language: TypeScript
• Size: 78.1 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
@dethdkn/ox-config

⚓️ My Opinionated OX Config




   

      

   

   

      

  

   

      

   



## 🚀 Setup

1. Install with your favorite package manager:

   - **bun** : `bun add -D @dethdkn/ox-config`

   - npm : `npm i -D @dethdkn/ox-config`

   - pnpm : `pnpm add -D @dethdkn/ox-config`

   - yarn : `yarn add -D @dethdkn/ox-config`

2. Create a `.oxfmtrc.json` file in the project root and copy the configuration from [github.com/dethdkn/ox-config/.oxfmtrc.json](https://github.com/dethdkn/ox-config/blob/main/.oxfmtrc.json).

3. Create a `.oxlintrc.json` in the project root:

```json

{

  "extends": ["./node_modules/@dethdkn/ox-config/.oxlintrc.json"]

}

```

4. Add lint scripts to `package.json`:

```json

{

  "scripts": {

    "fmt": "oxfmt --check",

    "fmt:fix": "oxfmt",

    "lint": "oxlint --type-aware",

    "lint:fix": "oxlint --type-aware --fix"

  }

}

```

4. Install the [OXC VS Code extension](https://marketplace.visualstudio.com/items?itemName=oxc.oxc-vscode).

5. Add the following configuration to `.vscode/settings.json`:

```json

{

  // Use OXC as the default code formatter in VSCode

  "editor.defaultFormatter": "oxc.oxc-vscode",

  // Automatically format files whenever you save them

  "editor.formatOnSave": true,

  // Apply OXC auto-fix actions on save (only when explicitly configured)

  "editor.codeActionsOnSave": {

    "source.fixAll.oxc": "explicit"

  },

  // Enable type-aware linting

  "oxc.typeAware": true,

  // Run OXC linter automatically on type

  "oxc.lint.run": "onType"

}

```

## 📝 License

Copyright © 2026 [Gabriel 'DethDKN' Rosa](https://github.com/dethdkn)\

This project is under [MIT license](https://github.com/dethdkn/ox-config/blob/main/LICENSE)