Rename and deprecated some inputs

Author: nosborn

README.md

@@ -13,22 +13,30 @@ Basic usage with all options enabled:
 - name: markdownlint-cli
   uses: nosborn/github-action-markdown-cli@v4.0.0
   with:
+    cli-version: latest
+    config-file: .markdownlint.yaml
     files: .
-    config_file: .markdownlint.yaml
-    ignore_files: examples/ignore/*
-    ignore_path: examples/.markdownlintignore
+    ignore-files: examples/ignore/*
+    ignore-path: examples/.markdownlintignore
     rules: examples/rules/custom.js
-    cli_version: latest
 ```
 
 ## Inputs
 
 - `files` - what to process (files, directories, globs)
-- `config_file` (optional) - configuration file (JSON or YAML)
-- `ignore_files` (optional) - files to ignore/exclude (file, directory, glob)
-- `ignore_path` (optional) - path to file with ignore pattern(s)
+- `config` (optional) - configuration file (JSON or YAML)
+- `ignore` (optional) - files to ignore/exclude (file, directory, glob)
+- `ignore-path` (optional) - path to file with ignore patterns
 - `rules` (optional) - custom rule files (file, directory, glob, package)
-- `cli_version` (optional) - version of markdownlint-cli to use, default `latest`
+- `cli-version` (optional) - version of markdownlint-cli to use, default `latest`
+
+### Deprecated inputs
+
+These inputs are still available but will be removed in a future major version.
+
+- `config_file` (optional) - configuration file (JSON or YAML) - superseded by `config`
+- `ignore_files` (optional) - files to ignore/exclude (file, directory, glob) - superseded by `ignore`
+- `ignore_path` (optional) - path to file with ignore patterns - superseded by `ignore-path`
 
 ## License
 

action.yml

@@ -5,19 +5,31 @@ author: Nick Osborn
 description: Style checker and lint tool for Markdown/CommonMark files.
 
 inputs:
-  cli_version:
+  cli-version:
     description: version of markdownlint-cli to use
     required: true
     default: latest
+  config:
+    description: configuration file (JSON or YAML)
+    required: false
   config_file:
     description: configuration file (JSON or YAML)
     required: false
+    deprecationMessage: Please use 'config' instead.
   files:
     description: files, directories, or globs
     required: true
+  ignore:
+    description: files to ignore/exclude
+    required: false
+  ignore-path:
+    description: path to file with ignore pattern(s)
+    required: false
+    deprecationMessage: Please use 'ignore-path' instead.
   ignore_files:
     description: files to ignore/exclude
     required: false
+    deprecationMessage: Please use 'ignore' instead.
   ignore_path:
     description: path to file with ignore pattern(s)
     required: false
@@ -39,7 +51,7 @@ runs:
 
         markdownlint="${prefix}/bin/markdownlint"
         markdownlint="${markdownlint}${INPUT_CONFIG_FILE:+ -c ${INPUT_CONFIG_FILE:?}}"
-        markdownlint="${markdownlint}${INPUT_IGNORE_FILES:+ -i ${INPUT_IGNORE_FILES:?}}"
+        markdownlint="${markdownlint}${INPUT_IGNORE:+ -i ${INPUT_IGNORE:?}}"
         markdownlint="${markdownlint}${INPUT_IGNORE_PATH:+ -p ${INPUT_IGNORE_PATH:?}}"
         markdownlint="${markdownlint}${INPUT_RULES:+ -r ${INPUT_RULES:?}}"
 
@@ -51,11 +63,11 @@ runs:
         exit ${rc:-0}
       shell: bash
       env:
-        INPUT_CLI_VERSION: ${{ inputs.cli_version }}
-        INPUT_CONFIG_FILE: ${{ inputs.config_file }}
+        INPUT_CLI_VERSION: ${{ inputs.cli-version }}
+        INPUT_CONFIG_FILE: ${{ inputs.config || inputs.config_file }}
         INPUT_FILES: ${{ inputs.files }}
-        INPUT_IGNORE_FILES: ${{ inputs.ignore_files }}
-        INPUT_IGNORE_PATH: ${{ inputs.ignore_path }}
+        INPUT_IGNORE: ${{ inputs.ignore || inputs.ignore_files }}
+        INPUT_IGNORE_PATH: ${{ inputs.ignore-path || inputs.ignore_path }}
         INPUT_RULES: ${{ inputs.rules }}
 
 branding: