Skip to content
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

Init just as command-line runner #660

Merged
merged 10 commits into from
Aug 1, 2024
Merged

Init just as command-line runner #660

merged 10 commits into from
Aug 1, 2024

Conversation

Splines
Copy link
Member

@Splines Splines commented Jul 3, 2024

In this PR, we introduce support for the amazing Just command runner 🔥. This will allow us to specify frequently-used commands and have them available at our fingertips, e.g. just test cypress.

Installation

Warning

If you have previously installed a version of just on your system via apt, please remove it: sudo apt remove just. This is because the version on apt is too old and we want to have the latest features of just available.

Instead, I've added a script to package.json. Simply run: yarn just-install. It will install just to ~/bin. Then reload your shell and you're good to go. As of today, just --version should give 1.29.1.

Note I've added a VSCode workspace extension recommendation, feel free to install it to get syntax highlighting in the .justfiles.

Tip

just modules are currently not stable yet, but will probably be in the next few days (casey announced the stabilization to happen on July 1st). For right now, execute export JUST_UNSTABLE=1 in your shell before executing any just command. This PR will only be merged once the just modules are stable.

Usage

Run just to see available commands. Run just test etc. to see available commands for the submodules. Everything else should be self-explanatory, e.g. try out just docker up -d, then just docker shell db.

If you want to add your own commands, refer to the docs. It also has a search built-in.

TODOs

  • Update Wiki on how to install Just.
  • Add some more basic commands
  • Wait till modules are stabilized, see this issue -> or maybe don't as nothing substantial will change anymore and modules will be stabilized very soon

Copy link

codecov bot commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (dev@6bde35d). Learn more about missing BASE report.

Additional details and impacted files
@@          Coverage Diff           @@
##             dev     #660   +/-   ##
======================================
  Coverage       ?   66.64%           
======================================
  Files          ?      308           
  Lines          ?     9386           
  Branches       ?        0           
======================================
  Hits           ?     6255           
  Misses         ?     3131           
  Partials       ?        0           

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

Copy link
Collaborator

@fosterfarrell9 fosterfarrell9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works nicely. Just one question: Is there a wiki page on just in our wiki? I could not find one, but it would be really helpful.

@Splines
Copy link
Member Author

Splines commented Jul 9, 2024

I've added a section about how to install Just here in the Wiki. However, you're right it might be better to have a separate section for it for quick reference. I can then reference that section on the installation page.

@Splines
Copy link
Member Author

Splines commented Jul 10, 2024

I've outsourced the section to this new section explaining how to install/update just.

@Splines Splines requested a review from fosterfarrell9 July 10, 2024 13:03
@Splines
Copy link
Member Author

Splines commented Aug 1, 2024

Note you can now run yarn just-update and should get the version 1.33.0. In this version, modules are stabilized 🙌

@Splines Splines merged commit db3e5af into dev Aug 1, 2024
7 checks passed
@Splines Splines deleted the feature/justfile branch August 1, 2024 11:00
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.

2 participants