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.

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

Outdated & missing package.json metadata #81

Closed
d2s opened this issue Sep 21, 2016 · 3 comments
Closed

Outdated & missing package.json metadata #81

d2s opened this issue Sep 21, 2016 · 3 comments

Comments

@d2s
Copy link
Contributor

d2s commented Sep 21, 2016

Individual packages should have an URL to the Git repository.

package.json files in /packages/ directory current lack details. Missing "repository": field creates discovery problems for people who look individual packages at the npm package directory (as they need to search separately from search engines to find where original source code is located).


Also, even while individual typography package already has the right "homepage": metadata, it has old URL in the"repository": field. Currently points to a broken repository address (as you had renamed repository from typography to typography.js).

Currently:

  "repository": {
    "type": "git",
    "url": "https://github.com/KyleAMathews/typography.git"
  },

Should be:

  "repository": {
    "type": "git",
    "url": "https://github.com/KyleAMathews/typography.js.git"
  },

Example files from another project:


Should individual packages's "repository": point to the Git repository?
(That is how Jest has solved the metadata issue.)

Do you need any help with this?

@KyleAMathews
Copy link
Owner

Hmmm... good point! This should be fixed. Just having repository point to this Github repo makes sense. If you want to take on creating a PR to fix this that'd be great!

@d2s
Copy link
Contributor Author

d2s commented Sep 21, 2016

@KyleAMathews I'll spend a bit of time to make a pull request. Review it after I post it.

d2s added a commit to d2s/typography.js that referenced this issue Sep 21, 2016
- Add "homepage" metadata to individual npm package.json files
- Add "bugs" metadata to individual npm package.json files
- Add "repository" metadata to individual npm package.json files
- Adjust order of metadata items to make files more consistent

More details:
- https://docs.npmjs.com/files/package.json

Related issues:
- KyleAMathews#81
KyleAMathews pushed a commit that referenced this issue Sep 21, 2016
- Add "homepage" metadata to individual npm package.json files
- Add "bugs" metadata to individual npm package.json files
- Add "repository" metadata to individual npm package.json files
- Adjust order of metadata items to make files more consistent

More details:
- https://docs.npmjs.com/files/package.json

Related issues:
- #81
@KyleAMathews
Copy link
Owner

Fixed by #83

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants