cmdlore 0.4.0

A command library that lives in your shell
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

version: 1

commands:

  - id: rust.new
    cmd: cargo new <name>
    desc: Start a new binary project
    tags: [rust, cargo, new, project, init]
    params:
      name:
        desc: Project name, which becomes the directory

  - id: rust.build
    cmd: cargo build
    desc: Compile the project in debug mode
    tags: [rust, cargo, build, compile]

  - id: rust.build.release
    cmd: cargo build --release
    desc: Compile the optimised binary
    tags: [rust, cargo, build, release, optimised]

  - id: rust.run
    cmd: cargo run
    desc: Build and run the project
    tags: [rust, cargo, run]

  - id: rust.check
    cmd: cargo check --all-targets
    desc: Find out whether it compiles without waiting for a build
    tags: [rust, cargo, check, compile, fast]

  - id: rust.test
    cmd: cargo test
    desc: Run every test
    tags: [rust, cargo, test]

  - id: rust.test.one
    cmd: cargo test <filter> -- --nocapture
    desc: Run one test and see everything it printed
    tags: [rust, cargo, test, filter, nocapture]
    params:
      filter:
        desc: Part of the test name

  - id: rust.lint
    cmd: cargo clippy --all-targets -- -D warnings
    desc: Run the lints the way continuous integration will run them
    tags: [rust, cargo, clippy, lint, warnings]

  - id: rust.format
    cmd: cargo fmt
    desc: Format every file in the project
    tags: [rust, cargo, fmt, format, rustfmt]

  - id: rust.add
    cmd: cargo add <crate>
    desc: Add a dependency to Cargo.toml
    tags: [rust, cargo, add, dependency, crate]
    params:
      crate:
        desc: Crate name, with features if you need them

  - id: rust.deps.update
    cmd: cargo update
    desc: Move the lock file to the newest versions Cargo.toml allows
    tags: [rust, cargo, update, dependencies, lockfile]

  - id: rust.deps.tree
    cmd: cargo tree -i <crate>
    desc: Find out which dependency is pulling in a crate
    tags: [rust, cargo, tree, dependencies, why]
    params:
      crate:
        desc: Crate to trace back

  - id: rust.doc.open
    cmd: cargo doc --no-deps --open
    desc: Read this crate's own documentation as its users will
    tags: [rust, cargo, doc, documentation]

  - id: rust.install
    cmd: cargo install <crate>
    desc: Install a tool from crates.io
    tags: [rust, cargo, install, tool, binary]
    params:
      crate:
        desc: Crate that ships a binary

  - id: rust.toolchain.update
    cmd: rustup update
    desc: Update the rust toolchain itself
    tags: [rust, rustup, update, toolchain]

  - id: rust.clean
    cmd: cargo clean
    desc: Delete the build directory when the cache stops making sense
    tags: [rust, cargo, clean, target]
    danger: true