Add disable, dot, and enable inputs

Author: nosborn

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
         id: expect-failure
         uses: ./
         with:
-          config_file: .markdownlintrc
+          config: .markdownlintrc
           files: .
           rules: examples/rules/custom.js
         continue-on-error: true
@@ -42,14 +42,14 @@ jobs:
       - name: Test ignore_files
         uses: ./
         with:
-          config_file: .markdownlintrc
+          config: .markdownlintrc
           files: .
-          ignore_files: examples/ignore/*
+          ignore: examples/ignore/*
           rules: examples/rules/custom.js
       - name: Test ignore_path
         uses: ./
         with:
-          config_file: .markdownlintrc
+          config: .markdownlintrc
           files: .
-          ignore_path: examples/.markdownlintignore
+          ignore-path: examples/.markdownlintignore
           rules: examples/rules/custom.js

README.md

@@ -13,18 +13,24 @@ 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
+    disable: MD013 MD041
+    dot: true
+    enable: MD013 MD041
     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` (optional) - configuration file (JSON or YAML)
+- `disable` (optional) - disable certain rules, for example `MD013 MD041`
+- `dot` (optional) - if `true`, include files/folders with a dot (for example `.github`)
+- `enable` (optional) - enable certain rules, for example `MD013 MD041`
 - `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)

action.yml

@@ -16,6 +16,15 @@ inputs:
     description: configuration file (JSON or YAML)
     required: false
     deprecationMessage: Please use 'config' instead.
+  disable:
+    description: enable certain rules, for example 'MD013 MD041'
+    required: false
+  dot:
+    description: if 'true', include files/folders with a dot (for example '.github')
+    required: false
+  enable:
+    description: enable certain rules, for example 'MD013 MD041'
+    required: false
   files:
     description: files, directories, or globs
     required: true
@@ -25,14 +34,14 @@ inputs:
   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
+    deprecationMessage: Please use 'ignore-path' instead.
   rules:
     description: custom rule files
     required: false
@@ -43,17 +52,36 @@ runs:
     - run: |
         echo '::group::Installing markdownlint-cli'
         version="$(npm view --json markdownlint-cli@${INPUT_CLI_VERSION:?} | jq -r .version)"
+        major_version="$(cut -d . -f 1 <<<"${version}")"
+        minor_version="$(cut -d . -f 2 <<<"${version}")"
         prefix="${RUNNER_TOOL_CACHE:-${RUNNER_TEMP:?}}/markdownlint-cli/${version}"
         mkdir -p "${prefix}"
         # FIXME: --global and --production are deprecated
         NPM_CONFIG_PREFIX="${prefix}" npm install --global --production "markdownlint-cli@${version}"
         echo '::endgroup::'
 
         markdownlint="${prefix}/bin/markdownlint"
-        markdownlint="${markdownlint}${INPUT_CONFIG_FILE:+ -c ${INPUT_CONFIG_FILE:?}}"
-        markdownlint="${markdownlint}${INPUT_IGNORE:+ -i ${INPUT_IGNORE:?}}"
-        markdownlint="${markdownlint}${INPUT_IGNORE_PATH:+ -p ${INPUT_IGNORE_PATH:?}}"
-        markdownlint="${markdownlint}${INPUT_RULES:+ -r ${INPUT_RULES:?}}"
+        markdownlint+="${INPUT_CONFIG_FILE:+ -c ${INPUT_CONFIG_FILE:?}}"
+        if [[ ${major_version} -gt 0 ]] || [[ ${minor_version} -ge 30 ]]; then
+          markdownlint+="${INPUT_DISABLE:+ --disable ${INPUT_DISABLE:?}}"
+        fi
+        if [[ ${major_version} -gt 0 ]] || [[ ${minor_version} -ge 27 ]]; then
+          if [[ "$(tr '[:upper:]' '[:lower:]' <<<"${INPUT_DOT}")" == true ]]; then
+            markdownlint+=' --dot'
+          fi
+        fi
+        if [[ ${major_version} -gt 0 ]] || [[ ${minor_version} -ge 30 ]]; then
+          markdownlint+="${INPUT_ENABLE:+ --enable ${INPUT_ENABLE:?}}"
+        fi
+        if [[ ${major_version} -gt 0 ]] || [[ ${minor_version} -ge 7 ]]; then
+          markdownlint+="${INPUT_IGNORE:+ -i ${INPUT_IGNORE:?}}"
+        fi
+        if [[ ${major_version} -gt 0 ]] || [[ ${minor_version} -ge 22 ]]; then
+          markdownlint+="${INPUT_IGNORE_PATH:+ -p ${INPUT_IGNORE_PATH:?}}"
+        fi
+        if [[ ${major_version} -gt 0 ]] || [[ ${minor_version} -ge 11 ]]; then
+          markdownlint+="${INPUT_RULES:+ -r ${INPUT_RULES:?}}"
+        fi
 
         echo "::add-matcher::${GITHUB_ACTION_PATH:?}/markdownlint-problem-matcher.json"
         # shellcheck disable=SC2086
@@ -65,6 +93,9 @@ runs:
       env:
         INPUT_CLI_VERSION: ${{ inputs.cli-version }}
         INPUT_CONFIG_FILE: ${{ inputs.config || inputs.config_file }}
+        INPUT_DISABLE: ${{ inputs.disable }}
+        INPUT_DOT: ${{ inputs.dot }}
+        INPUT_ENABLE: ${{ inputs.enable }}
         INPUT_FILES: ${{ inputs.files }}
         INPUT_IGNORE: ${{ inputs.ignore || inputs.ignore_files }}
         INPUT_IGNORE_PATH: ${{ inputs.ignore-path || inputs.ignore_path }}