diff --git a/action.yml b/action.yml index 59e4372..8d6b7b5 100644 --- a/action.yml +++ b/action.yml @@ -2,6 +2,10 @@ name: 'Codespell with annotations' author: 'Peter Newman' description: 'Codespell with annotations for Pull Request' inputs: + builtin: + description: 'Comma-separated list of builtin dictionaries to include' + required: false + default: '' check_filenames: description: 'If set, check file names as well' required: false @@ -10,16 +14,12 @@ inputs: description: 'If set, check hidden files (those starting with ".") as well' required: false default: '' - exclude_file: - description: 'File with lines that should not be checked for spelling mistakes' + config: + description: 'Path to a codespell config file' required: false default: '' - skip: - description: 'Comma-separated list of files to skip (it accepts globs as well)' - required: false - default: './.git' - builtin: - description: 'Comma-separated list of builtin dictionaries to include' + exclude_file: + description: 'File with lines that should not be checked for spelling mistakes' required: false default: '' ignore_words_file: @@ -38,6 +38,10 @@ inputs: description: 'Path to run codespell in' required: false default: '' + skip: + description: 'Comma-separated list of files to skip (it accepts globs as well)' + required: false + default: './.git' only_warn: description: 'If set, only warn, never error' required: false diff --git a/entrypoint.sh b/entrypoint.sh index 7c3d4ed..10b5a43 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -10,6 +10,10 @@ echo "::add-matcher::${RUNNER_TEMP}/_github_workflow/codespell-matcher.json" # e.g. PIPESTATUS and pipestatus only work in bash/zsh respectively. echo "Running codespell on '${INPUT_PATH}' with the following options..." command_args="" +echo "Builtin dictionaries '${INPUT_BUILTIN}'" +if [ "x${INPUT_BUILTIN}" != "x" ]; then + command_args="${command_args} --builtin ${INPUT_BUILTIN}" +fi echo "Check filenames? '${INPUT_CHECK_FILENAMES}'" if [ -n "${INPUT_CHECK_FILENAMES}" ]; then echo "Checking filenames" @@ -20,18 +24,14 @@ if [ -n "${INPUT_CHECK_HIDDEN}" ]; then echo "Checking hidden" command_args="${command_args} --check-hidden" fi +echo "Config '${INPUT_CONFIG}'" +if [ "x${INPUT_CONFIG}" != "x" ]; then + command_args="${command_args} --config ${INPUT_CONFIG}" +fi 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 "Builtin dictionaries '${INPUT_BUILTIN}'" -if [ "x${INPUT_BUILTIN}" != "x" ]; then - command_args="${command_args} --builtin ${INPUT_BUILTIN}" -fi echo "Ignore words file '${INPUT_IGNORE_WORDS_FILE}'" if [ "x${INPUT_IGNORE_WORDS_FILE}" != "x" ]; then command_args="${command_args} --ignore-words ${INPUT_IGNORE_WORDS_FILE}" @@ -44,6 +44,10 @@ echo "Ignore URI words list '${INPUT_URI_IGNORE_WORDS_LIST}'" if [ "x${INPUT_URI_IGNORE_WORDS_LIST}" != "x" ]; then command_args="${command_args} --uri-ignore-words-list ${INPUT_URI_IGNORE_WORDS_LIST}" 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 --count ${command_args} ${INPUT_PATH}; echo $? 1>&4; } 1>&5; } 4>&1` diff --git a/test/test.bats b/test/test.bats index 119bc5b..80536a4 100644 --- a/test/test.bats +++ b/test/test.bats @@ -39,6 +39,7 @@ function setup() { export INPUT_EXCLUDE_FILE="" export INPUT_SKIP="" export INPUT_BUILTIN="" + export INPUT_CONFIG="" export INPUT_IGNORE_WORDS_FILE="" export INPUT_IGNORE_WORDS_LIST="" export INPUT_URI_IGNORE_WORDS_LIST="" @@ -94,6 +95,50 @@ function setup() { [ "${lines[-4 - $errorCount]}" == "$errorCount" ] } +@test "Pass an ill-formed file to INPUT_CONFIG" { + # codespell's exit status is 78 for a configparser.Error exception + expectedExitStatus=78 + INPUT_CONFIG="./test/testdata/.badcfg" + run "./entrypoint.sh" + [ $status -eq $expectedExitStatus ] +} + +@test "Pass a non-existing file to INPUT_CONFIG" { + errorCount=$((ROOT_MISSPELLING_COUNT + SUBFOLDER_MISSPELLING_COUNT)) + # codespell's exit status is 0, or 65 if there are errors found + if [ $errorCount -eq 0 ]; then expectedExitStatus=0; else expectedExitStatus=65; fi + INPUT_CONFIG="./foo" + run "./entrypoint.sh" + [ $status -eq $expectedExitStatus ] + + # Check output + [ "${lines[0]}" == "::add-matcher::${RUNNER_TEMP}/_github_workflow/codespell-matcher.json" ] + outputRegex="^Running codespell on '${INPUT_PATH}'" + [[ "${lines[1]}" =~ $outputRegex ]] + [ "${lines[-4 - $errorCount]}" == "$errorCount" ] + [ "${lines[-3]}" == "Codespell found one or more problems" ] + [ "${lines[-2]}" == "::remove-matcher owner=codespell-matcher-default::" ] + [ "${lines[-1]}" == "::remove-matcher owner=codespell-matcher-specified::" ] +} + +@test "Pass a valid file to INPUT_CONFIG" { + errorCount=$((ROOT_MISSPELLING_COUNT + SUBFOLDER_MISSPELLING_COUNT)) + # codespell's exit status is 0, or 65 if there are errors found + if [ $errorCount -eq 0 ]; then expectedExitStatus=0; else expectedExitStatus=65; fi + INPUT_CONFIG="./test/testdata/.goodcfg" + run "./entrypoint.sh" + [ $status -eq $expectedExitStatus ] + + # Check output + [ "${lines[0]}" == "::add-matcher::${RUNNER_TEMP}/_github_workflow/codespell-matcher.json" ] + outputRegex="^Running codespell on '${INPUT_PATH}'" + [[ "${lines[1]}" =~ $outputRegex ]] + [ "${lines[-4 - $errorCount]}" == "$errorCount" ] + [ "${lines[-3]}" == "Codespell found one or more problems" ] + [ "${lines[-2]}" == "::remove-matcher owner=codespell-matcher-default::" ] + [ "${lines[-1]}" == "::remove-matcher owner=codespell-matcher-specified::" ] +} + @test "Use an exclude file" { errorCount=$((ROOT_MISSPELLING_COUNT + SUBFOLDER_MISSPELLING_COUNT - EXCLUDED_MISSPELLING_COUNT)) # codespell's exit status is 0, or 65 if there are errors found diff --git a/test/testdata/.badcfg b/test/testdata/.badcfg new file mode 100644 index 0000000..e810594 --- /dev/null +++ b/test/testdata/.badcfg @@ -0,0 +1 @@ +foobar = diff --git a/test/testdata/.goodcfg b/test/testdata/.goodcfg new file mode 100644 index 0000000..60bbe06 --- /dev/null +++ b/test/testdata/.goodcfg @@ -0,0 +1 @@ +[codespell]