EDITOR_SETUP.md

Setting up your Editor or IDE to work on Grapl

Here, we document tips for setting up various editors and IDEs for efficiently working on the Grapl codebase. The presence of a particular tool here is not an endorsement. Similarly, the absence of a tool doesn't mean it can't be used. This is just an informative document to help new contributors quickly get up to speed.

These configurations are not necessarily complete (this document is a work in progress), and they are not necessarily the only way these tools can be configured. They are, however, configurations that work.

If you have configuration instructions for an editor or IDE not covered here, please feel free to submit a PR!

Visual Studio Code

Link

For Rust, the Rust Analyzer Plugin is recommended.

Of particular note are the checkOnSave and rustfmt override commands. As with many Rust projects, we still use rustfmt, clippy, and cargo check for formatting and linting, but the specific configurations are encapsulated into custom scripts that we also use in CI. By also using them in an editor, we can ensure a consistent experience for all uses of these tools.

Add the following to your workspace settings:

    "settings": {
        "editor.formatOnSave": true,
        "editor.formatOnPaste": true,
        "[rust]": {
            "editor.defaultFormatter": "matklad.rust-analyzer",
        },
        "rust-analyzer.linkedProjects": [
            "src/rust/Cargo.toml"
        ],
        "rust-analyzer.checkOnSave.enable": true,
        "rust-analyzer.checkOnSave.overrideCommand": [
            "/path/to/your/grapl/repo/src/rust/bin/lint",
            "json"
        ],
        "rust-analyzer.rustfmt.overrideCommand": [
            "/path/to/your/grapl/repo/src/rust/bin/format",
            "--editor"
        ]
    }

Python and TypeScript configurations to come later!