Skip to content

Use task runner just (or VSCode "tasks") #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 20, 2024
Merged

Use task runner just (or VSCode "tasks") #14

merged 2 commits into from
Aug 20, 2024

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Aug 19, 2024

Configure just

just is a task manager/runner written in rust for any project. It makes executing common dev workflows commands simple and easily repeated.

Tip

See just docs.

just --list

Available recipes:
    bump component='patch' # bump version in root Cargo.toml
    lint                   # run clippy and rustfmt

    [bin]
    build *args=''         # build the native binary
    run *args              # run cpp-linter native binary

    [code coverage]
    lcov                   # generate lcov.info
    llvm-cov *args=''      # generate and open detailed coverage report
    pretty-cov *args=''    # generate and open pretty coverage report
    test                   # run the test suite

    [docs]
    docs open=''           # serve docs
    docs-build             # build docs
    docs-rs                # rust docs

    [python]
    py-dev                 # install python bindings
    venv                   # activate python venv

Configure VSCode tasks

I also configured custom tasks to execute using VSCode, but these aren't as simple to use as just <task>.

Use Ctrl+Shift+P ➡️ Tasks: Run task ➡️ select a task to run in the list.

Note

The cargo llvm-cov nextest task needs to be run before generating coverage reports in various forms (lcov, json, or html). VSCode's tasks don't allow for dependent tasks, so it is still easier to run

just test pretty-cov '--open'

This also updates some other minor things.

[`just`][just] is a task manager/runner written in rust for any project. It makes executing common dev workflows commands simple and easily repeated.

> [!tip]
> See [`just` docs][just].

This also updates some other minor things.

[just]: https://just.systems
Copy link

codecov bot commented Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.82%. Comparing base (d746a94) to head (b10a034).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #14      +/-   ##
==========================================
+ Coverage   87.22%   87.82%   +0.59%     
==========================================
  Files          11       11              
  Lines        2169     2169              
==========================================
+ Hits         1892     1905      +13     
+ Misses        277      264      -13     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@2bndy5 2bndy5 merged commit fa09129 into main Aug 20, 2024
60 checks passed
@2bndy5 2bndy5 deleted the use-just branch August 20, 2024 05:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant