Skip to content

Commit

Permalink
Ignore node_modules/site-packages Markdown files (#91)
Browse files Browse the repository at this point in the history
Before this commit, `check-style.sh` would include
all `node_modules` and `site-packages` in its
search for Markdown files to checksum. These would
get `sha256sum`ed for the `markdown-autodocs`
check, which would take time. Ignoring these
folders speeds up our precommit a bit.
  • Loading branch information
rjhuijsman authored Nov 25, 2024
1 parent 45088e2 commit a515091
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion check-style.sh
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,8 @@ if [ ! -z "${affected_files}" ]; then
run_check prettier --ignore-unknown --check --loglevel=warn ${affected_files}

# Check documentation snippets (which can be affected by changes in any other file).
markdown_files=$(find . -type f \( -name "*.md" -o -name "*.mdx" \))
# Markdown files exclude `node_modules` (pulled NPM packages) and `site-packages` (pulled Python packages).
markdown_files=$(find . -type f \( -name "*.md" -o -name "*.mdx" \) -not \( -path "*/node_modules/*" -o -path "*/site-packages/*" \))
unindent_auto_doc_script=$(find . -type f -name 'unindent_auto_doc.py')
pre_autodocs_checksum=$(calculate_checksum $markdown_files)
run_check markdown-autodocs -c code-block -o ${markdown_files} > /dev/null && python $unindent_auto_doc_script ${markdown_files} > /dev/null
Expand Down

0 comments on commit a515091

Please sign in to comment.