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

Improve JS package descriptions #8121

Merged
merged 3 commits into from
Jul 23, 2018
Merged

Improve JS package descriptions #8121

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a8ba9ec
Improve package descriptions
chrisvanpatten Jul 22, 2018
2fd101e
Update package.json
gziolo Jul 23, 2018
46d4425
Update package.json
gziolo Jul 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/a11y/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/a11y",
"version": "1.1.1",
"description": "Collection of JS modules and tools for WordPress development",
"description": "Accessibility (a11y) utilities for WordPress",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/api-fetch/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/api-fetch",
"version": "1.0.1",
"description": "Utility to call WordPress REST APIs",
"description": "Utility to make WordPress REST API requests",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/babel-plugin-import-jsx-pragma/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/babel-plugin-import-jsx-pragma",
"version": "1.0.1",
"description": "Babel transform plugin for automatically injecting an import to be used as the pragma for the React JSX Transform plugin.",
Copy link
Member

Choose a reason for hiding this comment

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

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? 🤷‍♂️

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link
Member

Choose a reason for hiding this comment

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

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.

Copy link

Choose a reason for hiding this comment

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

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!

Copy link
Member

Choose a reason for hiding this comment

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

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

"description": "Babel transform plugin for automatically injecting an import to be used as the pragma for the React JSX Transform plugin",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/babel-plugin-makepot/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/babel-plugin-makepot",
"version": "2.0.1",
"description": "WordPress Babel i18n Plugin",
"description": "WordPress Babel internationalization (i18n) plugin",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/blob/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/blob",
"version": "1.0.1",
"description": "Blob utils for WordPress",
"description": "Blob utilities for WordPress",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/browserslist-config/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/browserslist-config",
"version": "2.2.0",
"description": "WordPress Browserslist Shared Config",
"description": "WordPress Browserslist shared configuration",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/components/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/components",
"version": "1.0.1",
"description": "UI Compoonents for WordPress",
Copy link
Member

Choose a reason for hiding this comment

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

😅

"description": "UI components for WordPress",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/compose/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/compose",
"version": "1.0.1",
"description": "WordPress Higher Order components",
"description": "WordPress higher-order components",
Copy link
Member

Choose a reason for hiding this comment

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

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

"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/dom-ready/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/dom-ready",
"version": "1.1.1",
"description": "Execute callback after the DOM is loaded.",
"description": "Execute callback after the DOM is loaded",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/dom/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/dom",
"version": "1.0.1",
"description": "DOM utils module for WordPress",
"description": "DOM utilities module for WordPress",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/hooks/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/hooks",
"version": "1.3.1",
"description": "WordPress Hooks library",
"description": "WordPress hooks library",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/html-entities/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/html-entities",
"version": "1.0.1",
"description": "HTML entities utils for WordPress",
"description": "HTML entity utilties for WordPress",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/i18n/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/i18n",
"version": "1.2.1",
"description": "WordPress i18n library",
"description": "WordPress internationalization (i18n) library",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/keycodes/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/keycodes",
"version": "1.0.1",
"description": "KeyCodes utilities for WordPress",
"description": "Keycodes utilities for WordPress",
Copy link
Member

Choose a reason for hiding this comment

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

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

"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/npm-package-json-lint-config/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/npm-package-json-lint-config",
"version": "1.1.1",
"description": "WordPress npm-package-json-lint shareable config",
"description": "WordPress npm-package-json-lint shareable configuration",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion packages/wordcount/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@wordpress/wordcount",
"version": "1.1.1",
"description": "WordPress Word Count Utility",
"description": "WordPress word count utility",
"author": "The WordPress Contributors",
"license": "GPL-2.0-or-later",
"keywords": [
Expand Down