Quick Start

Getting started

Quick start

Install the plugin, add a few rules to your Oxlint config, and run your first lint.

Install

Add small-rules and oxlint to your roblox-ts project as dev dependencies:

aube

aube add --save-dev @pobammer-ts/small-rules oxlint

npm

npm install --save-dev @pobammer-ts/small-rules oxlint

pnpm

pnpm add --save-dev @pobammer-ts/small-rules oxlint

yarn

yarn add --dev @pobammer-ts/small-rules oxlint

bun

bun add --dev @pobammer-ts/small-rules oxlint

deno

deno add npm:@pobammer-ts/small-rules npm:oxlint

vp

vp add --dev @pobammer-ts/small-rules oxlint

ni

ni -D @pobammer-ts/small-rules oxlint

Configure

Register the plugin in your Oxlint configuration file, then enable the rules you want to try:

.oxlintrc.json

{
  "jsPlugins": [
    "@pobammer-ts/small-rules"
  ],
  "rules": {
    "small-rules/no-print": "error",
    "small-rules/no-warn": "error",
    "small-rules/ban-react-fc": "error",
    "small-rules/no-task-wait": "error",
    "small-rules/prefer-early-return": "warn"
  }
}

oxlint.config.ts

import { defineConfig } from "oxlint";

export default defineConfig({
  jsPlugins: ["@pobammer-ts/small-rules"],
  rules: {
    "small-rules/no-print": "error",
    "small-rules/no-warn": "error",
    "small-rules/ban-react-fc": "error",
    "small-rules/no-task-wait": "error",
    "small-rules/prefer-early-return": "warn",
  },
});

Note

Start with a few rules, run them against the codebase, and add more once the noise level is clear. error fails the lint check. warn reports a problem without failing it.

Run

Run the linter:

oxlint .

If you want a package script, add one to package.json:

{
  "scripts": {
    "lint": "oxlint"
  }
}

Then run:

aube

aube run lint

npm

npm run lint

pnpm

pnpm run lint

yarn

yarn run lint

bun

bun run lint

deno

deno task lint

vp

vp run lint

ni

nr lint

Auto-fix

Some rules provide automatic fixes. Apply them with:

oxlint --fix

Caution

Review auto-fixes before committing. The fixes aim to be safe, but code fixes can still meet an edge case.

Where to go next

ConfigurationLearn about all configuration options and rule severities.

React RulesExplore the React rule category.

Roblox RulesExplore the Roblox rule category.

ChangelogSee what changed in recent releases.