Clean up package.json across all repositories

[janpio]

Laborious task:

Go through all package.json files for all repositories and clean them up. Remove things like

  "bugs": {
    "url": "https://issues.apache.org/jira/browse/CB"
  },

or other unneeded entries.

Might require some discussion on what to remove and keep first.

[oliversalzburg]

Should the bugs entry be removed or updated to the correct GitHub location?

[janpio]

Depends on where this is actually used - one would have to research that.
In general: Smaller file with less unnecessary stuff is better of course.

[oliversalzburg]

npm bugs cordova

[janpio]

https://docs.npmjs.com/files/package.json#bugs

[raphinesse]

We should not remove the bugs entry, but check that the URL is up-to date and use the short notation where possible. @erisu has done a lot of work on this already.

One thing I would love to see removed are the excessively long and outdated lists of contributors in some package.json files. Any objections against that?

Another thing would be consistent ordering of keys. sort-package-json can do that automatically. The ordering of the keys cannot be configured but it makes sense to me most of the time.

If we assemble a list of things to change, we could tag this for hacktoberfest.

[erisu]

+1 on removing the contributors section of the package.json

I am OK with resorting the keys to be in order. I am also not against defining a manual order to be consistent across repos.. Having like items grouped together and the relevant information at top, etc... But obviously sorting alphabetical would be the quickest and easiest.

[timbru31]

+1 on contributors, too.

We should also not forget to update the URLs in the plugin.xml file, many of them still have the JIRA URLs listed.

But yes, a good task for the Hacktoberfest to get an into the different Cordova repos.

[raphinesse]

I am OK with resorting the keys to be in order. I am also not against defining a manual order to be consistent across repos.. Having like items grouped together and the relevant information at top, etc... But obviously sorting alphabetical would be the quickest and easiest.

sort-package-json does not sort alphabetically but according to a predefined logical order. See https://www.npmjs.com/package/sort-package-json#usage for a small example.

[raphinesse]

I've written a little script that will perform the desired changes in an automated fashion. I will still create PRs for the changes.

Right now I plan on doing two PRs (since the second one could be controversial):

PR 1

• use short notation for repository field
• use short notation for bugs field

PR 2

• set author field to "Apache Software Foundation"
  (This is what is used in most packages. How about using "Apache Cordova Team" instead?)
• remove contributors field
  (@purplecabbage @dpogue You OK with that? You appear in at least some of them...)

If we agree on these changes up front, I could also throw these all into one PR per repo. Would be less work for everyone.

Regarding the sorting: I tried sort-package-json on one of our files and I don't really like the ordering it enforces. I found out that there's also https://www.npmjs.com/package/format-package which has a configurable ordering. But right now I would definitely postpone that part.

Any changes that should be added to PRs 1&2?

[dpogue]

• remove contributors field
  (@purplecabbage @dpogue You OK with that? You appear in at least some of them...)

I'm okay with that. Those contributor lists have not been maintained since the early days, so removing them is probably best.

[timbru31]

Does your script also fix the URLs of the bug report and git? Some of the projects might have the JIRA URL (https://github.com/apache/cordova-plugin-battery-status/blob/master/package.json#L20) or even the old https://git-wip-us.apache.org/repos/asf/... URLs

[raphinesse]

Does your script also fix the URLs of the bug report and git? Some of the projects might have the JIRA URL (https://github.com/apache/cordova-plugin-battery-status/blob/master/package.json#L20) or even the old https://git-wip-us.apache.org/repos/asf/... URLs

Yes

[raphinesse]

Thanks for the input and reviews. Can we close this as resolved? Or are there still things that need to be addressed? Like a consistent ordering of the fields in our package.json files, for example...

[raphinesse]

Should anyone be curious, these are the scripts I used to automate these changes.

[erisu]

consistent ordering of the fields

I think consistent ordering would be nice to have, but I don't think it is necessary to keep this ticket open anymore.