cargo-leet - A leetcode local development assistant

The cargo leet program helps you streamline your workflow with LeetCode problem local file where you can develop and test your solution before post it back to leetcode.

Help - Top level

cargo leet --help

A program that given the link or slug to a leetcode problem, creates a local file where you can
develop and test your solution before posting it back to leetcode

Usage: cargo leet [OPTIONS] <COMMAND>

Commands:
  generate, -g  Generates the module for the problem. Module naming preference follows `.leet.toml` unless overridden [aliases: gen]
  active        Either prints the active problem or sets it to the argument
  test          Run tests on active problem
  new           Creates a new pre-configured project from a template for use with cargo-leet
  help          Print this message or the help of the given subcommand(s)

Options:
  -p, --path <FOLDER>
          Specify the path to the project root (If not provided uses current working directory)

  -l, --log-level <LOG_LEVEL>
          Set logging level to use

          Possible values:
          - off:   Nothing emitted in this mode
          - error
          - warn
          - info
          - debug
          - trace
          
          [default: warn]

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Help - Generate

cargo leet generate --help

Generates the module for the problem. Module naming preference follows `.leet.toml` unless overridden

Usage: cargo leet {generate|-g} [OPTIONS] [PROBLEM]

Arguments:
  [PROBLEM]
          Question slug or url (If none specified then daily challenge is used)

Options:
  -n, --number_in_name
          If set the module name generated WILL include the number for the problem, overriding `.leet.toml`

  -m, --number_not_in_name
          If set the module name generated will NOT include the number for the problem, overriding `.leet.toml`

  -p, --path <FOLDER>
          Specify the path to the project root (If not provided uses current working directory)

  -l, --log-level <LOG_LEVEL>
          Set logging level to use

          Possible values:
          - off:   Nothing emitted in this mode
          - error
          - warn
          - info
          - debug
          - trace
          
          [default: warn]

  -h, --help
          Print help (see a summary with '-h')

Examples

• Create a new project:

  cargo leet new my-leetcode-project

• Change into the directory

  cd my-leetcode-project

• Generate a module for a specific problem:

  Include problem numbers in the file name depending on the config:

  cargo leet generate two-sum

  Forcibly add the problem number (overriding the config):

  cargo leet generate -n two-sum

  Forcibly exclude the problem number (overriding the config):

  cargo leet generate -m two-sum

• Set the active problem (done automatically by cargo leet gen):

  cargo leet active two-sum

• Run tests on the active problem:

  cargo leet test

Installation

Note: If cargo-leet is already installed and you install it again, the existing installation will be replaced, even if it was originally installed from a different source. For instance, if you first install it from a local clone and then reinstall it from a Git repository, the new installation will overwrite the previous one (you won't have both versions installed).

Build from Source

You can build cargo-leet from source using two different channels:

• Stable (main)

  cargo install --git https://github.com/rust-practice/cargo-leet.git --branch main -F tool

  This installs the stable version of cargo-leet from the main branch.

• Development (develop)

  cargo install --git https://github.com/rust-practice/cargo-leet.git --branch develop -F tool

  This installs the latest development version from the develop branch, which may include new features or changes that are still being tested.

Install from crates.io

You can also install cargo-leet directly from crates.io. However, please note that the crates.io release may not always reflect the latest updates.

cargo install cargo-leet -F tool

Running Directly from Source without Installation (For Development)

When developing the tool, you can run it directly from the source code without needing to install it. By default, these commands will execute the tool within the current working directory, meaning it will interact with the current project folder for cargo-leet.

Running in the Current Directory

Running the tool this way is useful for testing but may not be ideal if you need to target a specific project or repository. In such cases, you can specify the path to the desired repository using the --path option.

For example, to run the tool against a specific test repository:

cargo run -F tool -- leet gen --path $TEST_REPO

Using an Alias

If you have an alias configured in .cargo/config.toml, you can simplify the command:

cargo g

Using as a Library

You can use cargo-leet as a library to mimic the LeetCode environment in your own projects. To do so, add it as a dependency in your Cargo.toml file using

cargo add cargo-leet

For more information, see the documentation.

License

All code in this repository is dual-licensed under either:

• Apache License, Version 2.0 (LICENSE-APACHE or http://apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option. This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are very good reasons to include both as noted in this issue on Bevy's repo.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.