Skip to content
small-rules

Quick Start

Getting started

Quick Start

Install the plugin, add a few rules to .oxlintrc.json, and run your first lint in under two minutes.

Install

Section titled “Install”

Add small-rules and oxlint to your roblox-ts project. Since they are only needed during development, install them as dev dependencies:

Terminal window
aube add -D @pobammer-ts/small-rules oxlint

Configure

Section titled “Configure”

Create or update your .oxlintrc.json to register the plugin and enable rules:

{
  "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"
  }
}

Run

Section titled “Run”

Run the linter manually:

Terminal window
oxlint .

Or add it to your package.json scripts:

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

Then run:

Terminal window
aube run lint

Auto-fix

Section titled “Auto-fix”

Many rules provide automatic fixes. Apply them with:

Terminal window
oxlint --fix

Next Steps

Section titled “Next Steps”
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.