Skip to content
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

Jump to bottom

Add the skip option #8

Merged
merged 9 commits into from
Jun 3, 2020
Merged

Add the skip option #8

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c16963a
Add the skip option
peternewman May 30, 2020
7007368
Add the skip option to the command line
peternewman May 30, 2020
281a31d
Merge branch 'master' into peternewman-skip
peternewman May 30, 2020
cfea490
Add a test for skip
peternewman May 30, 2020
1764809
Try and make the skip option relative in the test
peternewman May 30, 2020
ea28acd
Fix the skip bats test
peternewman May 30, 2020
5a3baf6
Merge branch 'master' into peternewman-skip
larsoner Jun 1, 2020
d1a6654
Allow git master to fail
peternewman Jun 2, 2020
41ddf53
Try and diagnose the BATS failure
peternewman Jun 3, 2020
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
4 changes: 4 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ inputs:
description: 'FILE with lines that should not be changed'
requred: false
default: ''
skip:
description: 'Comma-separated list of files to skip (it accepts globs as well)'
requred: false
default: ''
path:
description: 'Path to run codespell in'
requred: false
Expand Down
4 changes: 4 additions & 0 deletions entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ echo "Exclude file '${INPUT_EXCLUDE_FILE}'"
if [ "x${INPUT_EXCLUDE_FILE}" != "x" ]; then
command_args="${command_args} --exclude-file ${INPUT_EXCLUDE_FILE}"
fi
echo "Skipping '${INPUT_SKIP}'"
if [ "x${INPUT_SKIP}" != "x" ]; then
command_args="${command_args} --skip ${INPUT_SKIP}"
fi
echo "Resulting CLI options ${command_args}"
exec 5>&1
res=`{ { codespell ${command_args} ${INPUT_PATH}; echo $? 1>&4; } 1>&5; } 4>&1`
Expand Down
10 changes: 10 additions & 0 deletions test/test.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ FILENAME_MISSPELLING_COUNT=1
HIDDEN_MISSPELLING_COUNT=1
EXCLUDED_MISSPELLING_COUNT=1
SUBFOLDER_MISSPELLING_COUNT=1
# From all files called example.txt
EXAMPLE_MISSPELLING_COUNT=5

export RUNNER_TEMP="/foo/runner_temp"

Expand All @@ -17,6 +19,7 @@ function setup() {
export INPUT_CHECK_FILENAMES=""
export INPUT_CHECK_HIDDEN=""
export INPUT_EXCLUDE_FILE=""
export INPUT_SKIP=""
export INPUT_PATH="./test/testdata"
export INPUT_ONLY_WARN=""
}
Expand Down Expand Up @@ -69,6 +72,13 @@ function setup() {
[ $status -eq $expectedExitStatus ]
}

@test "Check the skip option" {
expectedExitStatus=$((ROOT_MISSPELLING_COUNT + HIDDEN_MISSPELLING_COUNT + SUBFOLDER_MISSPELLING_COUNT - EXAMPLE_MISSPELLING_COUNT))
INPUT_SKIP="example.txt"
run "./entrypoint.sh"
[ $status -eq $expectedExitStatus ]
}

@test "Custom path" {
expectedExitStatus=$((SUBFOLDER_MISSPELLING_COUNT))
INPUT_PATH="./test/testdata/subfolder"
Expand Down