Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (43 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

66 lines (43 loc) · 1.16 KB

Rslint contribution guide

Thank you for your interest in contributing to Rslint! Before you start your contribution, please take a moment to read the following guidelines.

Setup the environment

Install Node.js and Go first.

Build locally

Build the project:

# init typescript-go submodule
git submodule update --init --recursive
pnpm install
pnpm build

Test the setup:

# Run all tests
pnpm test

# Run Go tests only
pnpm run test:go

# Run linting
pnpm run lint

# Run type checking
pnpm run typecheck

# Check code formatting
pnpm run format:check

Test the CLI

After building, you can test the rslint CLI:

# Test the binary
./packages/rslint/bin/rslint --help


# Lint the project itself
./packages/rslint/bin/rslint --config rslint.json

Debugging VSCode Extension

To Debug the VSCode Extension:

  1. Setup launch configuration
cp .vscode/launch.template.json .vscode/launch.json
  1. Start debugging
  • Open the Command Palette (Cmd+Shift+P)
  • Run Debug: Start Debugging or press F5
  • Alternatively, go to the Run and Debug sidebar and select Run Extension