Merge remote-tracking branch 'origin/main' into arewerslintyet

Author: ScriptedAlchemy

.github/actions/setup-go/action.yml

@@ -21,6 +21,7 @@ runs:
 
  - name: Clean Go module cache dir
  shell: bash
+ if: runner.os == 'linux'
  run: sudo rm -rf ~/go/pkg/mod/golang.org/toolchain*
 
  - name: Go cache

.github/workflows/ci.yml

@@ -19,9 +19,15 @@ env:
 jobs:
  test-go:
  name: Test Go
- runs-on: rspack-ubuntu-22.04-large
+ runs-on: ${{ matrix.runner }}
  strategy:
  matrix:
+ runner:
+ [
+ rspack-ubuntu-22.04-large,
+ rspack-windows-2022-large,
+ rspack-darwin-14-medium,
+ ]
  go-version: ['1.24.1']
  steps:
  - name: Checkout code
@@ -39,23 +45,27 @@ jobs:
  go-version: ${{ matrix.go-version }}
  cache-name: test-go
  - name: golangci-lint
+ if: runner.os == 'Linux'
  uses: golangci/golangci-lint-action@v8
  with:
  version: v2.3.0
  args: --timeout=5m ./cmd/... ./internal/...
  - name: go vet
+ if: runner.os == 'Linux'
  run: npm run lint:go
  - name: go fmt
+ if: runner.os == 'Linux'
  run: npm run format:go
  - name: Unit Test
  run: |
  go test -parallel 4 ./internal/...
 
  test-node:
  name: Test npm packages
- runs-on: rspack-ubuntu-22.04-large
+ runs-on: ${{ matrix.os }}
  strategy:
  matrix:
+ os: [rspack-ubuntu-22.04-large, windows-latest]
  go-version: ['1.24.1']
  steps:
  - name: Checkout code
@@ -73,16 +83,18 @@ jobs:
  uses: ./.github/actions/setup-node
 
  - name: Format
+ if: runner.os == 'Linux'
  run: pnpm format:check
 
  - name: Build
  run: pnpm build
 
  - name: TypeCheck
+ if: runner.os == 'Linux'
  run: pnpm typecheck
 
- - name: Install xvfb and dependencies
- if: ${{ runner.os == 'Linux' && runner.environment == 'self-hosted' }}
+ - name: Install xvfb and dependencies (Linux only)
+ if: runner.os == 'Linux'
  run: |
  sudo apt update
  sudo apt install -y libasound2 libgbm1 libgtk-3-0 libnss3 xvfb
@@ -91,9 +103,9 @@ jobs:
  uses: lynx-infra/cache@5c6160a6a4c7fca80a2f3057bb9dfc9513fcb732
  with:
  path: packages/vscode-extension/.vscode-test
- key: 'vscode-test'
+ key: vscode-test-${{ matrix.os }}
  restore-keys: |
- - 'vscode-test-'
+ vscode-test-${{ matrix.os }}-
 
  - name: Test on Linux
  if: runner.os == 'Linux'
@@ -104,17 +116,19 @@ jobs:
  run: pnpm -r test
 
  - name: Check Spell
+ if: runner.os == 'Linux'
  run: pnpm check-spell
 
  - name: Lint
+ if: runner.os == 'Linux'
  run: pnpm run lint
 
  done:
  needs:
  - test-go
  - test-node
  if: always()
- runs-on: rspack-ubuntu-22.04-large
+ runs-on: ubuntu-latest
  name: CI Done
  steps:
  - run: exit 1

.github/workflows/release.yml

@@ -41,8 +41,6 @@ on:
  - npm
  - extension
 permissions:
- # Provenance generation in GitHub Actions requires "write" access to the "id-token"
- id-token: write
  contents: read
 env:
  GO_VERSION: '1.24.1'
@@ -54,6 +52,11 @@ jobs:
  needs: [build]
  runs-on: ubuntu-22.04
  environment: npm
+ permissions:
+ # For push git tags
+ contents: write
+ # For Trusted Publish
+ id-token: write
  steps:
  - name: Show dry-run status
  run: |
@@ -95,13 +98,15 @@ jobs:
 
  - name: Move binaries
  uses: ./.github/actions/move-artifacts
-
  - name: Publish npm packages
  if: ${{ inputs.dry_run == false }}
- env:
- NPM_TOKEN: ${{ secrets.RSLINT_NPM_TOKEN }}
  run: |
  pnpm -r publish --no-git-checks --tag ${{ github.event.inputs.npm_tag }} --publish-branch ${{ github.event.inputs.branch }}
+ git config --global user.email "github-actions[bot]@users.noreply.github.com"
+ git config --global user.name "github-actions"
+ echo git tag v$(jq -r .version package.json)
+ git tag v$(jq -r .version package.json)
+ git push origin --follow-tags
 
  publish-extension-vscode:
  if: ${{ inputs.to_release == 'all' || inputs.to_release == 'extension' }}

.github/workflows/update-rule-manifest.yml

@@ -0,0 +1,42 @@
+name: Update Rule Manifest
+
+on:
+ push:
+ branches:
+ - main
+
+jobs:
+ update-rule-manifest:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: 20
+
+ - name: Check for rule changes
+ id: diff
+ run: |
+ git fetch origin main
+ git diff --name-only HEAD~10 HEAD | grep '^internal/rules/' || echo '' > changed_rules.txt
+ git diff --name-status HEAD~10 HEAD | grep '^internal/rules/' || echo '' > changed_rules_status.txt
+
+ - name: Generate rule-manifest.json if rules changed
+ if: ${{ hashFiles('changed_rules.txt') != '' }}
+ run: |
+ node scripts/gen-rule-manifest.js
+
+ - name: Create Pull Request if rule-manifest.json changed
+ uses: peter-evans/create-pull-request@v5
+ with:
+ commit-message: 'chore: update rule-manifest.json [auto]'
+ title: 'chore: update rule-manifest.json [auto]'
+ body: 'Auto-generated PR to update rule-manifest.json when rules change.'
+ branch: auto/update-rule-manifest
+ add-paths: packages/rslint-test-tools/rule-manifest.json
+ author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

.prettierignore

@@ -13,4 +13,5 @@ packages/vscode-extension/.vscode-test
 packages/rslint-test-tools/tests/typescript-eslint/fixtures
 packages/rslint-test-tools/tests/typescript-eslint/rules
 packages/rslint/pkg/
+website/doc_build
 pnpm-lock.yaml

README.md

@@ -1,3 +1,7 @@
+<picture>
+ <img alt="Rslint Banner" src="https://assets.rspack.rs/rslint/rslint-banner.png">
+</picture>
+
 # Rslint
 
 <p>
@@ -32,7 +36,7 @@ Rslint is a fork of [tsgolint](https://github.com/typescript-eslint/tsgolint), b
 
 ## 🚀 Getting Started
 
-See [Guide](./GUIDE.md).
+See [Guide](./website/docs/guide/index.md).
 
 ## 📖 Architecture Overview
 

architecture.md

@@ -43,51 +43,51 @@ Rslint is a high-performance JavaScript and TypeScript linter written in Go, des
 
 ```
 ┌─────────────────────────────────────────────────────────────────┐
-│ RSLINT SYSTEM │
+│ RSLINT SYSTEM  │
 ├─────────────────────────────────────────────────────────────────┤
 │ │
 │ ┌─────────────┐ ┌──────────────┐ ┌─────────────────────────┐ │
 │ │ CLI │ │ API │ │ LSP Server │ │
-│ │  (cmd/rslint)│ │ (internal/ │ │ (internal/lsp) │ │
+│ │ (cmd/rslint)│ │ (internal/ │ │ (internal/lsp) │ │
 │ │ │ │ api) │ │ │ │
 │ └─────┬───────┘ └──────┬───────┘ └──────────┬──────────────┘ │
 │ │ │ │ │
 │ └─────────────────┼─────────────────────┘ │
 │ │ │
-│ ┌─────────────────────┬─▼──────────────────────────────────────┐ │
-│ │ │ LINTER CORE  │ │
-│ │  ┌─────────────────┐│ (internal/linter) │ │
-│ │  │ CONFIG  ││ │ │
-│ │  │ LOADER ││ ┌──────────────┐ ┌─────────────────┐│ │
-│ │  │(internal/config)││ │ PROJECT │ │ RULE ENGINE ││ │
-│ │  │ ││ │ DISCOVERY │ │  (internal/rule) ││ │
-│ │  └─────────────────┘│ │ │ │ ││ │
+│ ┌─────────────────────┬─▼────────────────────────────────────┐ │
+│ │ │ LINTER CORE │ │
+│ │ ┌─────────────────┐ │ (internal/linter) │ │
+│ │ │  CONFIG │ │ │ │
+│ │ │ LOADER │ │ ┌──────────────┐ ┌─────────────────┐│ │
+│ │ │(internal/config)│ │ │ PROJECT │ │ RULE ENGINE ││ │
+│ │ │ │ │ │ DISCOVERY │ │ (internal/rule) ││ │
+│ │ └─────────────────┘ │ │ │ │ ││ │
 │ │ │ └──────────────┘ └─────────────────┘│ │
-│ └─────────────────────┴───────────────────────────────────────┘ │
+│ └─────────────────────┴──────────────────────────────────────┘ │
 │ │ │
-│ ┌─────────────────────┬─▼──────────────────────────────────────┐ │
+│ ┌─────────────────────┬─▼────────────────────────────────────┐ │
 │ │ │ TYPESCRIPT-GO │ │
-│ │  ┌─────────────────┐│ (typescript-go submodule) │ │
-│ │  │ RULES ││ │ │
-│ │  │ (internal/rules)││  ┌──────────┐ ┌──────────┐ ┌─────────┐│ │
-│ │  │ ││  │ LEXER │ │ PARSER │ │ CHECKER ││ │
-│ │  │ - no_unused_vars││  │ │ │ │ │ ││ │
-│ │  │ - array_type ││  │ │ │ │ │ ││ │
-│ │  │ - await_thenable││  │ │ │ │ │ ││ │
-│ │  │ - ... ││  └──────────┘ └──────────┘ └─────────┘│ │
-│ │  └─────────────────┘│ │ │
-│ └─────────────────────┴───────────────────────────────────────┘ │
+│ │ ┌─────────────────┐ │ (typescript-go submodule) │ │
+│ │ │ RULES │ │ │ │
+│ │ │ (internal/rules)│ │ ┌──────────┐ ┌──────────┐ ┌─────────┐│ │
+│ │ │ │ │ │ LEXER │ │ PARSER │ │ CHECKER ││ │
+│ │ │ - no_unused_vars│ │ │ │ │ │ │ ││ │
+│ │ │ - array_type │ │ │ │ │ │ │ ││ │
+│ │ │ - await_thenable│ │ │ │ │ │ │ ││ │
+│ │ │ - ... │ │ └──────────┘ └──────────┘ └─────────┘│ │
+│ │ └─────────────────┘ │ │ │
+│ └─────────────────────┴──────────────────────────────────────┘ │
 │ │
-│ ┌─────────────────────────────────────────────────────────────┐ │
+│ ┌────────────────────────────────────────────────────────────┐ │
 │ │ NODE.JS PACKAGES │ │
-│ │  │ │
-│ │ ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │ │
-│ │ │ @rslint │ │ VS Code │ │ Testing Tools │ │ │
-│ │ │ /core │ │ Extension │ │ │ │ │
-│ │ │ │ │ │ │ - rslint-test-tools │ │ │
-│ │ │ │ │ │ │ - rule-tester │ │ │
-│ │ └─────────────┘ └─────────────┘ └─────────────────────────┘ │ │
-│ └─────────────────────────────────────────────────────────────┘ │
+│ │ │ │
+│ │┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │ │
+│ ││ @rslint │ │ VS Code │ │ Testing Tools │ │ │
+│ ││ /core │ │ Extension │ │ │ │ │
+│ ││ │ │ │ │ - rslint-test-tools │ │ │
+│ ││ │ │ │ │ - rule-tester │ │ │
+│ │└─────────────┘ └─────────────┘ └─────────────────────────┘ │ │
+│ └────────────────────────────────────────────────────────────┘ │
 └─────────────────────────────────────────────────────────────────┘
 ```
 

cmd/rslint/api.go

@@ -48,11 +48,14 @@ func (h *IPCHandler) HandleLint(req api.LintRequest) (*api.LintResponse, error)
 allowedFiles := []string{}
 // Apply file contents if provided
 if len(req.FileContents) > 0 {
-fs = utils.NewOverlayVFS(fs, req.FileContents)
-for file := range req.FileContents {
-
-allowedFiles = append(allowedFiles, file) // Collect allowed files from request
+fileContents := make(map[string]string, len(req.FileContents))
+for k, v := range req.FileContents {
+normalizePath := tspath.NormalizePath(k)
+fileContents[normalizePath] = v
+allowedFiles = append(allowedFiles, normalizePath)
 }
+fs = utils.NewOverlayVFS(fs, fileContents)
+
 }
 
 // Initialize rule registry with all available rules

cmd/rslint/cmd.go

@@ -314,6 +314,7 @@ Usage:
  rslint [OPTIONS]
 
 Options:
+ --init	Initialize a default config in the current directory.
  --config PATH Which rslint config file to use. Defaults to rslint.json.
  --format FORMAT Output format: default | jsonline
  --fix Automatically fix problems
@@ -328,6 +329,7 @@ func runCMD() int {
 flag.Usage = func() { fmt.Fprint(os.Stderr, usage) }
 
 var (
+init bool
 help bool
 config string
 fix bool
@@ -343,6 +345,7 @@ func runCMD() int {
 )
 flag.StringVar(&format, "format", "default", "output format")
 flag.StringVar(&config, "config", "", "which rslint config to use")
+flag.BoolVar(&init, "init", false, "initialize a default config in the current directory")
 flag.BoolVar(&fix, "fix", false, "automatically fix problems")
 flag.BoolVar(&help, "help", false, "show help")
 flag.BoolVar(&help, "h", false, "show help")
@@ -405,6 +408,14 @@ func runCMD() int {
 }
 currentDirectory = tspath.NormalizePath(currentDirectory)
 
+if init {
+if err := rslintconfig.InitDefaultConfig(currentDirectory); err != nil {
+fmt.Fprintf(os.Stderr, "error initializing config: %v\n", err)
+return 1
+}
+return 0
+}
+
 fs := bundled.WrapFS(cachedvfs.From(osvfs.FS()))
 
 // Initialize rule registry with all available rules