Skip to content

Commit 73ef927

Browse files
lwjohnst86signekb
andauthored
build: 🔨 add list-todos recipe to justfile (#30)
# Description This PR needs a quick review. ## Checklist - [x] Ran `just run-all` Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com>
1 parent 7e80a3f commit 73ef927

1 file changed

Lines changed: 30 additions & 20 deletions

File tree

justfile

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,45 +7,55 @@ run-all: format-md check test-theme build-readme build-website
77
# Run all checks
88
check: check-spelling check-commits
99

10+
# List all TODO items in the repository
11+
list-todos:
12+
grep -R -n \
13+
--exclude="*.code-snippets" \
14+
--exclude-dir=.quarto \
15+
--exclude=justfile \
16+
--exclude=_site \
17+
"TODO" *
18+
1019
# Install the pre-commit hooks
1120
install-precommit:
12-
# Install pre-commit hooks
13-
uvx pre-commit install
14-
# Run pre-commit hooks on all files
15-
uvx pre-commit run --all-files
16-
# Update versions of pre-commit hooks
17-
uvx pre-commit autoupdate
21+
# Install pre-commit hooks
22+
uvx pre-commit install
23+
# Run pre-commit hooks on all files
24+
uvx pre-commit run --all-files
25+
# Update versions of pre-commit hooks
26+
uvx pre-commit autoupdate
1827

1928
# Format Markdown files
2029
format-md:
2130
uvx rumdl fmt --silent
2231

2332
# Check the commit messages on the current branch that are not on the main branch
2433
check-commits:
25-
#!/usr/bin/env bash
26-
branch_name=$(git rev-parse --abbrev-ref HEAD)
27-
number_of_commits=$(git rev-list --count HEAD ^main)
28-
if [[ ${branch_name} != "main" && ${number_of_commits} -gt 0 ]]
29-
then
30-
# If there is an issue, run `uv tool update-shell`.
31-
uvx --from commitizen cz check --rev-range main..HEAD
32-
else
33-
echo "On 'main' or current branch doesn't have any commits."
34-
fi
34+
#!/usr/bin/env bash
35+
branch_name=$(git rev-parse --abbrev-ref HEAD)
36+
number_of_commits=$(git rev-list --count HEAD ^main)
37+
if [[ ${branch_name} != "main" && ${number_of_commits} -gt 0 ]]
38+
then
39+
# If there is an issue, run `uv tool update-shell`.
40+
uvx --from commitizen cz check --rev-range main..HEAD
41+
else
42+
echo "On 'main' or current branch doesn't have any commits."
43+
fi
3544

3645
# Check for spelling errors in files
3746
check-spelling:
38-
uvx typos
47+
uvx typos
3948

4049
# Test the theme by building the website using Quarto
4150
test-theme:
42-
uvx --from quarto quarto render
51+
uvx --from quarto quarto render
4352

4453
# Re-build the README file from the Quarto version
4554
build-readme:
46-
# Use `uvx` in order to use Python and jupyter3
47-
uvx --from quarto quarto render README.qmd --to gfm
55+
# Use `uvx` in order to use Python and jupyter3
56+
uvx --from quarto quarto render README.qmd --to gfm
4857

4958
# Build the website using Quarto
5059
build-website:
5160
quarto render
61+

0 commit comments

Comments
 (0)