Expose a public 'check' method

[charliermarsh]

See: #271.

[charliermarsh]

@Seamooo - Is this roughly what's needed for the LSP? (Is there any way to get the LSP to pass us a path, even as a string, to include in the error messages?)

[charliermarsh]

With this, you can do:

use anyhow::Result;
use ruff;

fn main() -> Result<()> {
    println!("{:?}", ruff::check("def f(): x = 1")?);
    Ok(())
}

[charliermarsh]

@Seamooo - What are you planning to use to implement the LSP? https://github.com/ebkalderon/tower-lsp?

[Seamooo]

the lsp can definitely pass a path, the source requirement is due to the dynamic nature of the buffer updating. I've implemented a rough version of the lsp from scratch https://github.com/Seamooo/ruffd, getting this in would enable a proof of concept.

[charliermarsh]

That's awesome. And it's here that we can plug into ruff as a library?

[charliermarsh]

(Did you write that implementation from scratch? Is it based off anything else?)

[charliermarsh]

Two questions:

1. Should I change the method signature to include something like path: &str or even path: Path? Some of the internals like to have a Path, e.g., for formatting the Message body, but it could be worked around if it needs to be omitted.
2. How should we determine the pyproject.toml path here? Is there any way to base it on the user's current working directory? Or can the LSP path an absolute path to a file?

[charliermarsh]

(I went ahead and did (1); if we pass the absolute Path, it will in turn solve (2).)

[Seamooo]

That's awesome. And it's here that we can plug into ruff as a library?

Exactly

[Seamooo]

(Did you write that implementation from scratch? Is it based off anything else?)

it's implemented from scratch from the specification, with coc-nvim as the client to verify

[Seamooo]

There's potentially some ambiguity for solving the pyproject.toml path. The easiest would just be using the workspace root provided by the lsp client, but potentially there's cases where the workspace has nested configurations underneath it. For that case the implementation would be to recurse from the file path upwards until finding a pyproject.toml terminating at the workspace root. If the public method takes in &Settings, potentially the public api shouldn't have to account for it. This may also enable global configs outside of pyproject.toml that can create the settings type.

[charliermarsh]

For that case the implementation would be to recurse from the file path upwards until finding a pyproject.toml terminating at the workspace root.

If we pass check a path to a file, then find_project_root will automatically do this.

[charliermarsh]

@Seamooo - I've merged this for now. Let me know if it works for you or if we need to amend the API!

[Seamooo]

looking good!

[charliermarsh]

Nice! That's awesome!

What does it take to enable others to use the LSP from VS Code and elsewhere?

[charliermarsh]

(E.g., do we need to publish this on some sort of extension marketplace?)