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.

Sign up for GitHub

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

Jump to bottom

Fill out recommendations around prettier-plugin-packagejson #46

Closed
JoshuaKGoldberg opened this issue Sep 20, 2023 · 3 comments · Fixed by #124
Closed

Fill out recommendations around prettier-plugin-packagejson #46

JoshuaKGoldberg opened this issue Sep 20, 2023 · 3 comments · Fixed by #124
Assignees
@JoshuaKGoldberg
Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!

Comments

@JoshuaKGoldberg
Copy link
Owner

Forking from @Zamiell's suggestions in #28 (comment): some of this plugin's functionality is covered by prettier-plugin-packagejson. I personally have been using prettier-plugin-packagejson in my repos for a while now.

I agree we'll want to at least explicitly mention in the plugin README.md that the prettier-plugin-packagejson exists and overlaps with the package-json/order-properties and sort-collections rules.

I'd also suggest one step further:

  1. Recommending using prettier-plugin-packagejson
  2. Splitting out the overlapped plugin rules into a separate config with a name like formatting

Thoughts?
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Sep 20, 2023
Closed
11 tasks
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jan 20, 2024
@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! area: documentation Improvements or additions to docs labels Jan 20, 2024
@JoshuaKGoldberg
Copy link
Owner Author

Now that #58 is in, the default settings for the recommended ruleset shouldn't conflict with prettier-plugin-packagejson. Synergy! 🙌

I'll add a note that it's fine to use both, and we recommend the Prettier plugin.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jan 20, 2024
Merged
3 tasks
@JoshuaKGoldberg
Copy link
Owner Author

As for splitting the configs:

Splitting out the overlapped plugin rules into a separate config with a name like formatting

Since nothing should conflict out-of-the-box, I'm no longer motivated to spend time on this. If someone else wants it I'd happily take in a feature request issue.

JoshuaKGoldberg added a commit that referenced this issue Jan 20, 2024
@JoshuaKGoldberg
docs: mentioned prettier-plugin-packagejson (#124)
ea1336e 
## PR Checklist

-   [x] Addresses an existing open issue: fixes #46
- [x] That issue was marked as [`status: accepting
prs`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [x] Steps in
[CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CONTRIBUTING.md)
were taken

## Overview

Mentions
[`prettier-plugin-packagejson`](https://github.com/matzkoh/prettier-plugin-packagejson)
and that these tools synergize nicely. _Synergy!_

Also applies a
[sentences-per-line](https://github.com/JoshuaKGoldberg/sentences-per-line)
touchup I'd been meaning to for a while.
@github-actions GitHub Actions
Copy link

🎉 This is included in version v0.8.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
area: documentation Improvements or additions to docs status: accepting prs Please, send a pull request to resolve this!
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: mentioned prettier-plugin-packagejson JoshuaKGoldberg/eslint-plugin-package-json
1 participant
@JoshuaKGoldberg