Improve JS package descriptions

[chrisvanpatten]

Description

I went in to fix a typo in the @wordpress/components package description, and ended up giving them all a bit of love.

How has this been tested?

It has not been tested — the changes are only to text in the packages' package.json files.

Types of changes

• Applied sentence case to all descriptions
• Expanded abbreviations (to words like internationalization, accessibility, utilities, etc.)
• Removed trailing periods on a few descriptions
• Improved the language in one or two cases

[gziolo]

Nice one 💯 Thanks for opening this PR. In general, I like those changes because they bring consistency. I would prefer to have someone else to double check them before we proceed with mthe erge.

[tofumatt]

I dig it. A few thoughts but this is better than before so 🚢. If you want to make any of the small changes I suggest then feel free to do so before merge 😄

[tofumatt]

Interesting, I'd have thought sentence-case would be better for those. Some descriptions are surely multi-sentence?

It's split on NPM (React seems to be all without periods; lodash all with, etc.)

Given we're in the "comments must have full-stops" camp (I like it), maybe we should be here too? 🤷‍♂️

[gziolo]

Given we're in the "comments must have full-stops" camp (I like it), maybe we should be here too?

I would be also happy to see this change.

[aduth]

Seems like something that would be good to have (though from what I can tell, not yet offered as a feature) from npm-package-json-lint, which we're already using and have a predefined configuration for.

[tclindner]

Hey! I just released v3.3.0 of npm-package-json-lint with a new description-format rule. It has two options:

1. requireCapitalFirstLetter - Throws an error if the first character in the description isn't capitalized.
2. requireEndingPeriod - Throws an error if the description doesn't end with a period.

Hopefully this works well for your team!

[gziolo]

Thanks, opened PR to start using this new rule: #8596.

[tofumatt]

😅

[tofumatt]

I'd add "(HOC)" in brackets here; lots of people throw that acronym around and giving newbies context here for free is 👍

[tofumatt]

This one, I think, could be expanded upon further ("Keycodes utilities for WordPress; used to check for keyboard events across browsers/operating systems")

[gziolo]

Travis failed after I added fixes suggested by @tofumatt. Those are only text changes so I will merge as is.

[aduth]

Many of these descriptions are reused as the tagline description in the README.md (which I think is a good thing), and are now not always in sync (e.g. @wordpress/npm-package-json-lint-config).