Allow users to pass in a custom linting configuration (#61)

* Allow users to pass in a custom linting configuration

* Add experimental custom linting configuration section

more information

* clean up message for custom config

* Apply suggestions from code review

Co-authored-by: Joyce Zhu <[email protected]>

---------

Co-authored-by: Joyce Zhu <[email protected]>

Author: kendallgassner

README.md

@@ -68,6 +68,27 @@ This makes sure you stay on a stable version of this action.
 
 Replace the ref value with any commit hash.
 
+### Experimental: Adding a custom linting configuration
+
+If you would like to include more linting rules from the [markdownlint](https://github.com/DavidAnson/markdownlint) or [markdownlint-github](https://github.com/github/markdownlint-github) rulesets, pass a `config` object to the `github/accessibility-alt-text-bot` action.
+
+
+ ⚠ Consider adding new rules sparingly, as excessive rules could make the bot too noisy and overwhelm users. 
+
+ ⚠ This feature is experimental and may be removed in the future. We acknowledge that some repositories may want to implement more accessibility checks and aim to evaluate how users this feature before making it generally available.
+
+```yml
+    steps:
+      - name: Check alt text
+        uses: github/[email protected]
+        with:
+          config: |
+            no-default-alt-text: true,
+            no-alt-text: true,
+            no-empty-alt-text: true,
+            no-generic-link-text: true,
+```
+
 ## License
 
 This project is licensed under the terms of the MIT open source license.

action.yml

@@ -3,6 +3,10 @@ description: "This action will check a repos issue, discussion, or PR for correc
 branding:
   icon: "eye"
   color: "purple"
+inputs:
+  config:
+    description: "A custom linting configuration"
+    required: false
 runs:
   using: "composite"
   steps:
@@ -61,7 +65,16 @@ runs:
             bot_comment_id=$(gh api repos/${{ github.repository }}/discussions/${{ github.event.discussion.number }}/comments | jq -r '.[] | select(.user.login == "github-actions[bot]") | select(.body | test("<div alt-text-bot-id=\"${{ github.event.discussion.id }}\"")) | .node_id')
           fi
         fi
-        flag=$(node ${{ github.action_path }}/src/index.js "$content")
+   
+        flag=$(node ${{ github.action_path }}/src/index.js "$content" "$CONFIG")
+
+        custom_config_message="<div alt-text-bot-id=\"$target_id\" /> Uh oh! @$user, your markdown has a few linting errors. Check $target to fix the following violations:
+
+        $flag 
+
+        > 🤖 Beep boop! This comment was added automatically by [github/accessibility-alt-text-bot](https://github.com/github/accessibility-alt-text-bot).
+        "
+        
         message="<div alt-text-bot-id=\"$target_id\" /> Uh oh! @$user, at least one image you shared is missing helpful alt text. Check $target to fix the following violations:
 
         $flag 
@@ -73,7 +86,12 @@ runs:
         > 🤖 Beep boop! This comment was added automatically by [github/accessibility-alt-text-bot](https://github.com/github/accessibility-alt-text-bot).
         "
 
-        echo "Detected bad alt text: ${flag}"
+        echo "Config: $CONFIG"
+        if [ "$CONFIG" ]; then
+          message=$custom_config_message 
+        fi
+
+        echo "Detected errors: ${flag}"
         echo "Event type: $type"
         if [[ $flag && ${{ github.event.action }} != 'deleted' ]]; then
           if [ $bot_comment_id ]; then
@@ -115,3 +133,4 @@ runs:
         ISSUE_BODY: ${{ github.event.issue.body }}
         PR_BODY: ${{ github.event.pull_request.body }}
         DISCUSSION_BODY: ${{ github.event.discussion.body }}
+        CONFIG: ${{ inputs.config }}