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

📝 Documentation: Overhaul README.md and remove note about global ESLint installations #112

Closed
2 tasks done
JoshuaKGoldberg opened this issue Jan 20, 2024 · 1 comment · Fixed by #121
Closed
2 tasks done

📝 Documentation: Overhaul README.md and remove note about global ESLint installations #112

JoshuaKGoldberg opened this issue Jan 20, 2024 · 1 comment · Fixed by #121
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

JoshuaKGoldberg commented Jan 20, 2024 •
edited
Loading

Bug Report Checklist

Overview

eslint-plugin-package-json/README.md

Line 35 in 70b871f

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-package-json` globally.

Per eslint/eslint#15498, ESLint no longer recommends a global installation. This package no longer needs to mention that in its README.md.

I'd like to go through the README.md anyway and touch it up anyway.

Additional Info

No response
@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 JoshuaKGoldberg self-assigned this Jan 20, 2024
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jan 20, 2024
Merged
3 tasks
JoshuaKGoldberg added a commit that referenced this issue Jan 20, 2024
@JoshuaKGoldberg
docs: touchups (#121)
ebdd7aa 
## PR Checklist

-   [x] Addresses an existing open issue: fixes #112; fixes #113
- [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

Touches up the README.md to better explain itself and no longer
reference a global installation.

Also applies a bit of polish to rule docs:
* Applies
[sentences-per-line](https://github.com/JoshuaKGoldberg/sentences-per-line)
manually
* Lower-cases npm instead of NPM
* General phrasing and such
@github-actions GitHub Actions
Copy link

🎉 This is included in version v0.6.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: touchups JoshuaKGoldberg/eslint-plugin-package-json
1 participant
@JoshuaKGoldberg