diff --git a/action.yml b/action.yml index 522d9cf..f8c31ed 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: @@ -34,6 +34,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 0fc188f..606ca27 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}" @@ -40,6 +40,10 @@ echo "Ignore words list '${INPUT_IGNORE_WORDS_LIST}'" if [ "x${INPUT_IGNORE_WORDS_LIST}" != "x" ]; then command_args="${command_args} --ignore-words-list ${INPUT_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 db7ac8f..a67b1e5 100644 --- a/test/test.bats +++ b/test/test.bats @@ -92,6 +92,13 @@ function setup() { [ "${lines[-4 - $errorCount]}" == "$errorCount" ] } +@test "Check with a non-existent config file set in INPUT_CONFIG" { + expectedExitStatus=64 + INPUT_CONFIG="./foo/bar" + run "./entrypoint.sh" + [ $status -eq $expectedExitStatus ] +} + @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