Skip to content

fix: Improve build tooling configuration #45

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

Open
jcouball wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Improve build tooling configuration #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"scripts": {
"setup": "npm install && pip3 install -r requirements.txt",
"setup": "npm install && pip3 install -r requirements.txt && (command -v asdf >/dev/null && asdf reshim python || true)",

Copilot AI Mar 27, 2026

Copy link

Choose a reason for hiding this comment

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

The setup script currently swallows any failure from asdf reshim python (because of ... || true). If asdf is installed but the reshim fails, the script still exits successfully and CLI tools like mkdocs may still not be on PATH for asdf users. Consider using an explicit conditional (run asdf reshim python only when asdf exists) while letting real reshim failures surface.

Suggested change
"setup": "npm install && pip3 install -r requirements.txt && (command -v asdf >/dev/null && asdf reshim python || true)",
"setup": "npm install && pip3 install -r requirements.txt && (if command -v asdf >/dev/null; then asdf reshim python; fi)",

Copilot uses AI. Check for mistakes.
"lint": "markdownlint-cli2 '**/*.md' '!node_modules'",

Copilot AI Mar 27, 2026

Copy link

Choose a reason for hiding this comment

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

The .venv exclusion was added to build/serve, but npm run lint still runs markdownlint-cli2 without excluding .venv. If the goal is to avoid linting vendored dependencies consistently, lint should use the same ignore patterns as build/serve (or centralize the glob list to keep them in sync).

Suggested change
"lint": "markdownlint-cli2 '**/*.md' '!node_modules'",
"lint": "markdownlint-cli2 '**/*.md' '!node_modules' '!.venv'",

Copilot uses AI. Check for mistakes.
"build": "markdownlint-cli2 '**/*.md' '!node_modules' && mkdocs build",
"serve": "markdownlint-cli2 '**/*.md' '!node_modules' && mkdocs serve"
"build": "markdownlint-cli2 '**/*.md' '!node_modules' '!.venv' && mkdocs build",
"serve": "markdownlint-cli2 '**/*.md' '!node_modules' '!.venv' && mkdocs serve"
},
"devDependencies": {
"markdownlint-cli2": "^0.14.0"
Expand Down
3 changes: 1 addition & 2 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
mkdocs
mkdocs ~= 1.6
pymdown-extensions
mkdocs-material ~= 9.0, >= 9.0.3
markdown-include
mdx_truly_sane_lists

Loading