Skip to content

Allow users to pass in a custom linting configuration - #61

Merged
kendallgassner merged 5 commits into
mainfrom
kendallg/allow-for-custom-config
Jan 27, 2025
Merged

kendallgassner merged 5 commits into
mainfrom
kendallg/allow-for-custom-config

Conversation

@kendallgassner

Copy link
Copy Markdown
Collaborator

Closes: #34

What

This PR adds the ability to pass a custom linting configuration object to the github/accessibility-alt-text-bot action. The configuration will allow users to include more linting rules from the markdownlint or markdownlint-github rulesets.

Copilot AI review requested due to automatic review settings January 8, 2025 19:37
@kendallgassner
kendallgassner requested a review from a team as a code owner January 8, 2025 19:37

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 116 out of 117 changed files in this pull request and generated no comments.

Files not reviewed (1)
  • package.json: Language not supported

Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more

Comment thread src/validate.js Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Resolved
Comment thread README.md Outdated

```yml
steps:
- name: Check alt text #change this step to use the

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#change this step to use the

I think this got cut off?

Comment thread src/validate.js
export const validate = (markdown) =>
(markdownlint
export const validate = (markdown, config) => {
const configObject = yaml.load(config)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this function handle if the extra custom config doesn't exist?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure does! I have a test repo that I will invite you too.

Comment thread README.md Resolved
Co-authored-by: Joyce Zhu <joycezhu@github.com>
@kendallgassner
kendallgassner merged commit 9b4b0e0 into main Jan 27, 2025
@kendallgassner
kendallgassner deleted the kendallg/allow-for-custom-config branch January 27, 2025 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add workflow input that allows users to customize their markdown-lint config

4 participants