#Getting Started

Rslint is a high-performance JavaScript and TypeScript linter written in Go.

#Installation

npm install @rslint/core -D

yarn add @rslint/core -D

pnpm add @rslint/core -D

bun add @rslint/core -D

deno add npm:@rslint/core -D

#Quick Start

#Initialize Configuration

Run the following command to generate a default configuration file:

npx rslint --init

This creates a rslint.config.ts (or .js / .mjs depending on your project setup) with recommended rules enabled.

#Run the Linter

# Lint all files
npx rslint .

# Lint with auto-fix
npx rslint --fix .

# Lint with TypeScript type checking (replaces tsc --noEmit)
npx rslint --type-check .

#Configuration Preview

The generated config uses the flat config format (an array of config entries), similar to ESLint v10:

import { defineConfig, ts } from '@rslint/core';

export default defineConfig([
  ts.configs.recommended,
  {
    rules: {
      '@typescript-eslint/no-unused-vars': 'error',
    },
  },
]);

For full configuration options, see the Configuration page.

#Editor Integration

Install the official VSCode Extension for real-time diagnostics, code actions, and auto-fix on save.