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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for using sort-package-JSON via trunk #305

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

joshmarinacci
Copy link

trunk check is an extendible superlinter with a built in language server and prexisting issue detection. sort-package-json is integrated here.

We're big fans of the sort-package-json project and hope our integration can increase its popularity!

add trunk check instructions
Copy link
Owner

@keithamus keithamus left a comment

Choose a reason for hiding this comment

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

Thanks for the PR and I'm glad you're a big fan!

As is stands this PR takes up a large amount of the README and it seems like it's mostly to promote the trunk check product. I'm happy to see a link inside the # Related tools or ## Supported Libraries subheadings but I think dedicating a whole new section to this seems a little much.

@joshmarinacci
Copy link
Author

Hi Keith. I did it this way to mirror some of the other tools we work with. For example actionlint has a whole section on Tools Integration that shows how to use it with reviewdog, precommit, VS code, and others in addition to Trunk Check. However, if that's not what you want here, how about this:

Trunk Check support (link) with:  `trunk check enable sort-package-josh`

https://github.com/rhysd/actionlint/blob/main/docs/usage.md

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.

2 participants