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.

Install

Section titled “Install”

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

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

Configure

Section titled “Configure”

Register the plugin in .oxlintrc.json, then enable the rules you want to try:

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

Terminal window
oxlint .

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

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

Then run:

Terminal window
aube run lint

Auto-fix

Section titled “Auto-fix”

Some rules provide automatic fixes. Apply them with:

Terminal window
oxlint --fix

Where to go next

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