Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: create documentation fix script #9794

Merged

Conversation

HonkingGoose
Copy link
Collaborator

Changes:

  • Create a doc-fix script that runs prettier-fix and markdown-lint-fix in one go

Context:

I always forget to run the markdown-lint-fix command on my PRs. I think it would be very handy to just have one command that I need to use to fixup the documentation. Something like doc-fix or docs-fix that runs Prettier and the Markdown lint fixer. That way I only need to memorize the one command. 馃槃

While creating this PR, I noticed the list of scripts is not in alphabetical order, so we might want to fix that as well?

Let me know what you think.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • No new tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@HonkingGoose HonkingGoose marked this pull request as ready for review April 30, 2021 13:13
@HonkingGoose
Copy link
Collaborator Author

@rarkins What do you think of this idea?

Also do you want me to put the scripts in alphabetical order?

@rarkins rarkins merged commit 428c39a into renovatebot:main May 6, 2021
@rarkins
Copy link
Collaborator

rarkins commented May 6, 2021

Also do you want me to put the scripts in alphabetical order?

Yes, but in a separate PR

@viceice
Copy link
Member

viceice commented May 6, 2021

I like prettier-plugin-package to have a consistent package.json.

An alternate is prettier-plugin-packagejson

@renovate-release
Copy link
Collaborator

馃帀 This PR is included in version 25.15.0 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

@HonkingGoose HonkingGoose deleted the chore/create-documentation-fix-script branch May 6, 2021 07:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants