mirror of https://github.com/astral-sh/ruff.git synced 2025-08-09 21:28:04 +00:00

History

Brent Westbrook fd335eb8b7 Move fix suggestion to subdiagnostic (#19464 ) Summary -- This PR tweaks Ruff's internal usage of the new diagnostic model to more closely match the intended use, as I understand it. Specifically, it moves the fix/help suggestion from the primary annotation's message to a subdiagnostic. In turn, it adds the secondary/noqa code as the new primary annotation message. As shown in the new `ruff_db` tests, this more closely mirrors Ruff's current diagnostic output. I also added `Severity::Help` to render the fix suggestion with a `help:` prefix instead of `info:`. These changes don't have any external impact now but should help a bit with #19415. Test Plan -- New full output format tests in `ruff_db` Rendered Diagnostics -- Full diagnostic output from `annotate-snippets` in this PR: ``` error[unused-import]: `os` imported but unused --> fib.py:1:8 \| 1 \| import os \| ^^ \| help: Remove unused import: `os` ``` Current Ruff output for the same code: ``` fib.py:1:8: F401 [] `os` imported but unused \| 1 \| import os \| ^^ F401 \| = help: Remove unused import: `os` ``` Proposed final output after #19415: ``` F401 [] `os` imported but unused --> fib.py:1:8 \| 1 \| import os \| ^^ \| help: Remove unused import: `os` ``` These are slightly updated from https://github.com/astral-sh/ruff/pull/19464#issuecomment-3097377634 below to remove the extra noqa codes in the primary annotation messages for the first and third cases.		2025-07-22 10:03:58 -04:00
..
src	Move fix suggestion to subdiagnostic (#19464 )	2025-07-22 10:03:58 -04:00
tests	Update salsa (#19258 )	2025-07-18 12:14:28 -04:00
Cargo.toml	Bump 0.12.4 (#19406 )	2025-07-17 12:14:01 -05:00
README.md	Publish wasm API to npm (#12317 )	2024-07-17 08:50:38 +02:00

README.md

Ruff WASM

⚠️ WARNING: This API is experimental and may change at any time

Docs | Playground

An extremely fast Python linter and code formatter, written in Rust.

This is a WASM version of the Ruff API which can be used to lint/format Python in a browser environment.

There are multiple versions for the different wasm-pack targets. See here for more info on targets.

Usage

This example uses the wasm-pack web target and is known to work with Vite.

import init, { Workspace, type Diagnostic } from '@astral-sh/ruff-api';

const exampleDocument = `print('hello'); print("world")`

await init(); // Initializes WASM module

// These are default settings just to illustrate configuring Ruff
// Settings info: https://docs.astral.sh/ruff/settings
const workspace = new Workspace({
  'line-length': 88,
  'indent-width': 4,
  format: {
    'indent-style': 'space',
    'quote-style': 'double',
  },
  lint: {
    select: [
      'E4',
      'E7',
      'E9',
      'F'
    ],
  },
});

// Will contain 1 diagnostic code for E702: Multiple statements on one line
const diagnostics: Diagnostic[] = workspace.check(exampleDocument);

const formatted = workspace.format(exampleDocument);