mirrors/ruff
1
0
Fork 0
mirror of https://github.com/astral-sh/ruff.git synced 2025-11-13 09:12:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Point LSP, VS Code, and pre-commut URLs to Astral org (#4562)

Browse source
This commit is contained in:
Charlie Marsh 2023-05-21 15:27:35 -04:00 • committed by GitHub
parent 8ca3977602
commit f22c269ccf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 21 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/release.yaml vendored
View file

@ -408,7 +408,7 @@ jobs:
twine upload --skip-existing * twine upload --skip-existing *
- name: "Update pre-commit mirror" - name: "Update pre-commit mirror"
run: | run: |
curl -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer ${{ secrets.RUFF_PRE_COMMIT_PAT }}" -H "X-GitHub-Api-Version: 2022-11-28" https://api.github.com/repos/charliermarsh/ruff-pre-commit/dispatches --data '{"event_type": "pypi_release"}' curl -X POST -H "Accept: application/vnd.github+json" -H "Authorization: Bearer ${{ secrets.RUFF_PRE_COMMIT_PAT }}" -H "X-GitHub-Api-Version: 2022-11-28" https://api.github.com/repos/astral-sh/ruff-pre-commit/dispatches --data '{"event_type": "pypi_release"}'
- uses: actions/download-artifact@v3 - uses: actions/download-artifact@v3
with: with:
name: binaries name: binaries

8
README.md
View file

@ -33,7 +33,7 @@ An extremely fast Python linter, written in Rust.
- 📏 Over [500 built-in rules](https://beta.ruff.rs/docs/rules/) - 📏 Over [500 built-in rules](https://beta.ruff.rs/docs/rules/)
- ⚖️ [Near-parity](https://beta.ruff.rs/docs/faq/#how-does-ruff-compare-to-flake8) with the built-in Flake8 rule set - ⚖️ [Near-parity](https://beta.ruff.rs/docs/faq/#how-does-ruff-compare-to-flake8) with the built-in Flake8 rule set
- 🔌 Native re-implementations of dozens of Flake8 plugins, like flake8-bugbear - 🔌 Native re-implementations of dozens of Flake8 plugins, like flake8-bugbear
- ⌨️ First-party editor integrations for [VS Code](https://github.com/charliermarsh/ruff-vscode) and [more](https://github.com/charliermarsh/ruff-lsp) - ⌨️ First-party editor integrations for [VS Code](https://github.com/astral-sh/ruff-vscode) and [more](https://github.com/astral-sh/ruff-lsp)
- 🌎 Monorepo-friendly, with [hierarchical and cascading configuration](https://beta.ruff.rs/docs/configuration/#pyprojecttoml-discovery) - 🌎 Monorepo-friendly, with [hierarchical and cascading configuration](https://beta.ruff.rs/docs/configuration/#pyprojecttoml-discovery)
Ruff aims to be orders of magnitude faster than alternative tools while integrating more Ruff aims to be orders of magnitude faster than alternative tools while integrating more
@ -135,15 +135,15 @@ ruff check path/to/code/to/file.py # Lint `file.py`
Ruff can also be used as a [pre-commit](https://pre-commit.com) hook: Ruff can also be used as a [pre-commit](https://pre-commit.com) hook:
```yaml ```yaml
- repo: https://github.com/charliermarsh/ruff-pre-commit - repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version. # Ruff version.
rev: 'v0.0.269' rev: 'v0.0.269'
hooks: hooks:
- id: ruff - id: ruff
``` ```
Ruff can also be used as a [VS Code extension](https://github.com/charliermarsh/ruff-vscode) or Ruff can also be used as a [VS Code extension](https://github.com/astral-sh/ruff-vscode) or
alongside any other editor through the [Ruff LSP](https://github.com/charliermarsh/ruff-lsp). alongside any other editor through the [Ruff LSP](https://github.com/astral-sh/ruff-lsp).
Ruff can also be used as a [GitHub Action](https://github.com/features/actions) via Ruff can also be used as a [GitHub Action](https://github.com/features/actions) via
[`ruff-action`](https://github.com/chartboost/ruff-action): [`ruff-action`](https://github.com/chartboost/ruff-action):

2
crates/ruff/src/settings/options.rs
View file

@ -253,7 +253,7 @@ pub struct Options {
/// respect these exclusions unequivocally. /// respect these exclusions unequivocally.
/// ///
/// This is useful for [`pre-commit`](https://pre-commit.com/), which explicitly passes all /// This is useful for [`pre-commit`](https://pre-commit.com/), which explicitly passes all
/// changed files to the [`ruff-pre-commit`](https://github.com/charliermarsh/ruff-pre-commit) /// changed files to the [`ruff-pre-commit`](https://github.com/astral-sh/ruff-pre-commit)
/// plugin, regardless of whether they're marked as excluded by Ruff's own /// plugin, regardless of whether they're marked as excluded by Ruff's own
/// settings. /// settings.
pub force_exclude: Option<bool>, pub force_exclude: Option<bool>,

14
docs/editor-integrations.md
View file

@ -10,12 +10,12 @@ which supports autofix actions, import sorting, and more.
## Language Server Protocol (Official) ## Language Server Protocol (Official)
Ruff supports the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) Ruff supports the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/)
via the [`ruff-lsp`](https://github.com/charliermarsh/ruff-lsp) Python package, available on via the [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) Python package, available on
[PyPI](https://pypi.org/project/ruff-lsp/). [PyPI](https://pypi.org/project/ruff-lsp/).
[`ruff-lsp`](https://github.com/charliermarsh/ruff-lsp) enables Ruff to be used with any editor that [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp) enables Ruff to be used with any editor that
supports the Language Server Protocol, including [Neovim](https://github.com/charliermarsh/ruff-lsp#example-neovim), supports the Language Server Protocol, including [Neovim](https://github.com/astral-sh/ruff-lsp#example-neovim),
[Sublime Text](https://github.com/charliermarsh/ruff-lsp#example-sublime-text), Emacs, and more. [Sublime Text](https://github.com/astral-sh/ruff-lsp#example-sublime-text), Emacs, and more.
For example, to use `ruff-lsp` with Neovim, install `ruff-lsp` from PyPI along with For example, to use `ruff-lsp` with Neovim, install `ruff-lsp` from PyPI along with
[`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig). Then, add something like the following [`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig). Then, add something like the following
@ -80,7 +80,7 @@ Upon successful installation, you should see Ruff's diagnostics surfaced directl
![Code Actions available in Neovim](https://user-images.githubusercontent.com/1309177/208278707-25fa37e4-079d-4597-ad35-b95dba066960.png) ![Code Actions available in Neovim](https://user-images.githubusercontent.com/1309177/208278707-25fa37e4-079d-4597-ad35-b95dba066960.png)
To use `ruff-lsp` with other editors, including Sublime Text and Helix, see the [`ruff-lsp` documentation](https://github.com/charliermarsh/ruff-lsp#installation-and-usage). To use `ruff-lsp` with other editors, including Sublime Text and Helix, see the [`ruff-lsp` documentation](https://github.com/astral-sh/ruff-lsp#installation-and-usage).
## Language Server Protocol (Unofficial) ## Language Server Protocol (Unofficial)
@ -122,10 +122,10 @@ require'lspconfig'.pylsp.setup {
## Vim & Neovim ## Vim & Neovim
Ruff can be integrated into any editor that supports the Language Server Protocol via [`ruff-lsp`](https://github.com/charliermarsh/ruff-lsp) Ruff can be integrated into any editor that supports the Language Server Protocol via [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp)
(see: [Language Server Protocol](#language-server-protocol-official)), including Vim and Neovim. (see: [Language Server Protocol](#language-server-protocol-official)), including Vim and Neovim.
It's recommended that you use [`ruff-lsp`](https://github.com/charliermarsh/ruff-lsp), the It's recommended that you use [`ruff-lsp`](https://github.com/astral-sh/ruff-lsp), the
officially supported LSP server for Ruff. To use `ruff-lsp` with Neovim, install `ruff-lsp` from officially supported LSP server for Ruff. To use `ruff-lsp` with Neovim, install `ruff-lsp` from
PyPI along with [`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig). Then, add something PyPI along with [`nvim-lspconfig`](https://github.com/neovim/nvim-lspconfig). Then, add something
like the following to your `init.lua`: like the following to your `init.lua`:

6
docs/tutorial.md
View file

@ -240,7 +240,7 @@ This tutorial has focused on Ruff's command-line interface, but Ruff can also be
[pre-commit](https://pre-commit.com) hook: [pre-commit](https://pre-commit.com) hook:
```yaml ```yaml
- repo: https://github.com/charliermarsh/ruff-pre-commit - repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version. # Ruff version.
rev: 'v0.0.269' rev: 'v0.0.269'
hooks: hooks:
@ -251,7 +251,7 @@ See [_Usage_](usage.md) for more.
## Editor Integrations ## Editor Integrations
Ruff can also be used as a [VS Code extension](https://github.com/charliermarsh/ruff-vscode) or Ruff can also be used as a [VS Code extension](https://github.com/astral-sh/ruff-vscode) or
alongside any other editor through the [Ruff LSP](https://github.com/charliermarsh/ruff-lsp). alongside any other editor through the [Ruff LSP](https://github.com/astral-sh/ruff-lsp).
See [_Editor Integrations_](editor-integrations.md). See [_Editor Integrations_](editor-integrations.md).

8
docs/usage.md
View file

@ -20,7 +20,7 @@ ruff check path/to/code/ --watch
Ruff can also be used as a [pre-commit](https://pre-commit.com) hook: Ruff can also be used as a [pre-commit](https://pre-commit.com) hook:
```yaml ```yaml
- repo: https://github.com/charliermarsh/ruff-pre-commit - repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version. # Ruff version.
rev: 'v0.0.269' rev: 'v0.0.269'
hooks: hooks:
@ -30,7 +30,7 @@ Ruff can also be used as a [pre-commit](https://pre-commit.com) hook:
Or, to enable autofix: Or, to enable autofix:
```yaml ```yaml
- repo: https://github.com/charliermarsh/ruff-pre-commit - repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version. # Ruff version.
rev: 'v0.0.269' rev: 'v0.0.269'
hooks: hooks:
@ -45,8 +45,8 @@ reformatting.
## VS Code ## VS Code
Ruff can also be used as a [VS Code extension](https://github.com/charliermarsh/ruff-vscode) or Ruff can also be used as a [VS Code extension](https://github.com/astral-sh/ruff-vscode) or
alongside any other editor through the [Ruff LSP](https://github.com/charliermarsh/ruff-lsp). alongside any other editor through the [Ruff LSP](https://github.com/astral-sh/ruff-lsp).
## GitHub Action ## GitHub Action

2
ruff.schema.json generated
View file

@ -309,7 +309,7 @@
] ]
}, },
"force-exclude": { "force-exclude": {
"description": "Whether to enforce `exclude` and `extend-exclude` patterns, even for paths that are passed to Ruff explicitly. Typically, Ruff will lint any paths passed in directly, even if they would typically be excluded. Setting `force-exclude = true` will cause Ruff to respect these exclusions unequivocally.\n\nThis is useful for [`pre-commit`](https://pre-commit.com/), which explicitly passes all changed files to the [`ruff-pre-commit`](https://github.com/charliermarsh/ruff-pre-commit) plugin, regardless of whether they're marked as excluded by Ruff's own settings.", "description": "Whether to enforce `exclude` and `extend-exclude` patterns, even for paths that are passed to Ruff explicitly. Typically, Ruff will lint any paths passed in directly, even if they would typically be excluded. Setting `force-exclude = true` will cause Ruff to respect these exclusions unequivocally.\n\nThis is useful for [`pre-commit`](https://pre-commit.com/), which explicitly passes all changed files to the [`ruff-pre-commit`](https://github.com/astral-sh/ruff-pre-commit) plugin, regardless of whether they're marked as excluded by Ruff's own settings.",
"type": [ "type": [
"boolean", "boolean",
"null" "null"