Quick Start
Getting started
Quick start
Install the plugin, add a few rules to your Oxlint config, and run your first lint.
Install
Section titled “Install”Add small-rules and oxlint to your roblox-ts project as dev dependencies:
ni -D @pobammer-ts/small-rules oxlintpnpm add --save-dev @pobammer-ts/small-rules oxlintaube add --save-dev @pobammer-ts/small-rules oxlintvp add --dev @pobammer-ts/small-rules oxlintdeno add npm:@pobammer-ts/small-rules npm:oxlintbun add --dev @pobammer-ts/small-rules oxlintyarn add --dev @pobammer-ts/small-rules oxlintnpm install --save-dev @pobammer-ts/small-rules oxlintConfigure
Section titled “Configure”Register the plugin in your Oxlint configuration file, 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" }}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", },});Run the linter:
oxlint .If you want a package script, add one to package.json:
{ "scripts": { "lint": "oxlint" }}Then run:
nr lintpnpm run lintaube run lintvp run lintdeno task lintbun run lintyarn run lintnpm run lintAuto-fix
Section titled “Auto-fix”Some rules provide automatic fixes. Apply them with:
oxlint --fixWhere 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.