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

"Repository" link pulling from incorrect property in package.json #235

Closed
jamsyoung opened this issue Feb 29, 2016 · 2 comments
Closed

"Repository" link pulling from incorrect property in package.json #235

jamsyoung opened this issue Feb 29, 2016 · 2 comments

Comments

@jamsyoung
Copy link

jamsyoung commented Feb 29, 2016

I am not sure when this behavior started. It def exists in node 5.6.0 with npm 3.7.5.

When doing "npm init" the default format for the "repository" url starts with git+

Example, edited for brevity. Showing only what is set by the "git repository" question.

$ npm init
git repository: https://github.com/cnnlabs/something.git
About to write to /Users/jyoung/dev/test/package.json:

{
  "repository": {
    "type": "git",
    "url": "git+https://github.com/cnnlabs/something.git"
  },
  "bugs": {
    "url": "https://github.com/cnnlabs/something/issues"
  },
  "homepage": "https://github.com/cnnlabs/something#readme"
}

ESDoc pulls the repository.url for the href of the "Repository" link, which is invalid since it starts with git+.

It would be more appropriate to pull the homepage property.

@jamsyoung
Copy link
Author

jamsyoung commented Feb 29, 2016

Changing this to read from homepage will probably break more people than are currently broken using git+ urls with the repository property.

@h13i32maru
Copy link
Member

h13i32maru commented Mar 6, 2016

Thanks this issue.
I released the v0.4.6 that fixes this bug.

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

No branches or pull requests

2 participants