Skip to content

🧗 [just] default work directories inside of the repo are easier for all #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.

Sign up for GitHub

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
chicks-net merged 2 commits into from
Sep 1, 2025
Merged

🧗 [just] default work directories inside of the repo are easier for all #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cd0bc6
🧗 [just] default work directories inside of the repo are easier for all
chicks-net Sep 1, 2025
47e8dd4
document working dirs in README
chicks-net Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,19 @@ Check out [casey/just](https://github.com/casey/just) if you haven't heard of

You can see in the [`justfile`](./justfile) how I've been using it to build this
project on my machine. Running `just` without arguments will run the `try`
stanza where I have setup my source and destination directories. Feel free to
edit this for your own convenience -- you would be `just`ified. :grin:
stanza which processes the `examples/` directory and outputs to `test_output/`.

The project includes:

* `examples/` - Sample Google+ HTML files for testing the parser
* `test_output/` - Generated Markdown files (gitignored)

Other named recipes are:

* `check` - run rust linters locally
* `newdep crate_name` - add a new create dependancy
* `sync` - get out of a branch after merging
* `backtrace` - run with detailed error traces

So `just check` would rerun the linters for you.

Expand Down
4 changes: 2 additions & 2 deletions justfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ import? '.just/gh-process.just'

# run the code and see how it goes (default)
try:
cargo run -- ~/Downloads/Takeout ~/Documents/tmp
cargo run -- examples test_output

# run with backtrace enabled
backtrace:
RUST_BACKTRACE=1 cargo run -- ~/Downloads/Takeout ~/Documents/tmp
RUST_BACKTRACE=1 cargo run -- examples test_output

# what have you broken?
check:
Expand Down
Loading