Add github link to package.json of packages

TimoGlastra commented 3 years ago

This is a minor nitpick but would make it a lot easier to go from npm to github (and from github to github).

Two reasons:

When on NPM you can't go directly to Github (it renders a link if present in package.json). You have to manually find where the package is located. With monorepos this can be inconvient.
I'm using OctoLinker which adds links to file/package imports in the Github Web UI. If you have a link to the Github repo in your package.json it will automatically link them together.

E.g. for the @transmute/vc.js package this will mean adding the following to the package.json:

{
  "name": "@transmute/vc.js",
  // ...
  "repository": {
    "type" : "git",
    "url" : "https://github.com/transmute-industries/vc.js.git",
    "directory": "packages/vc.js"
  },
  "homepage": "https://github.com/transmute-industries/vc.js/tree/master/packages/vc.js",
  // OR 
  "homepage": "https://transmute-industries.github.io/vc.js/"
}

Happy to assist if you agree :)

OR13 commented 3 years ago

@TimoGlastra thanks yes, I noticed this.... I would welcome such a PR. Thanks for raising the issue.

TimoGlastra commented 3 years ago

Cool, I've opened #44

transmute-industries / vc.js

Add github link to package.json of packages #43