Skip to content

Commit

Permalink
Add _tools folder for utility scripts
Browse files Browse the repository at this point in the history
Add script to list unused images in the repository.
  • Loading branch information
akien-mga committed Jun 5, 2020
1 parent 39dbbb2 commit 1361ffb
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 2 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,7 @@ ehthumbs_vista.db
$RECYCLE.BIN/
logo.h
*.autosave

# Output of list-unused-images.sh tool
tmp-unused-images
tmp-unused-images-history
4 changes: 2 additions & 2 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ install:
- pip install codespell

script:
- bash ./format.sh
- bash _tools/format.sh

# Check for possible typos
- codespell -I codespell-ignore.txt {about,community,development,getting_started,tutorials}/**/*.rst
- codespell -I _tools/codespell-ignore.txt {about,community,development,getting_started,tutorials}/**/*.rst

# TODO: Add `-W` to turn warnings into errors.
# This can only be done once all warnings have been fixed.
Expand Down
File renamed without changes.
File renamed without changes.
40 changes: 40 additions & 0 deletions _tools/list-unused-images.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#!/bin/bash

check_git_history=false

rm -f tmp-unused-images
rm -f tmp-unused-images-history

# List images which might be unused.
# Exceptions are ignored, and for .svg files we also look for potential .png
# files with the same base name, as they might be sources.

exceptions="docs_logo.png tween_cheatsheet.png"

files=$(find -name "_build" -prune -o \( -name "*.png" -o -name "*.jpg" -o -name "*.svg" -o -name "*.gif" \) -print | sort)

for path in $files; do
file=$(basename $path)
if echo "$exceptions" | grep -q "$file"; then
continue
fi
ext=${file##*.}
base=${file%.*}
found=$(rg -l ":: .*[ /]$file")
if [ -z "$found" -a "$ext" == "svg" ]; then
# May be source file.
found=$(rg -l ":: .*[ /]$base.png")
fi
if [ -z "$found" ]; then
echo "$path" >> tmp-unused-images
fi
done


if [ "$check_git_history" = true ]; then
for file in $(cat tmp-unused-images); do
echo "File: $file"
git log --diff-filter=A --follow $file
echo
done > tmp-unused-images-history
fi

0 comments on commit 1361ffb

Please sign in to comment.