You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

72 lines
1.8 KiB

module.exports = docs
docs.usage = "npm docs <pkgname>"
docs.usage += "\n"
docs.usage += "npm docs ."
var npm = require("./npm.js")
, opener = require("opener")
, path = require("path")
, log = require("npmlog")
, mapToRegistry = require("./utils/map-to-registry.js")
docs.completion = function (opts, cb) {
// FIXME: there used to be registry completion here, but it stopped making
// sense somewhere around 50,000 packages on the registry
cb()
}
function url (json) {
return json.homepage ? json.homepage : "https://npmjs.org/package/" + json.name
}
function docs (args, cb) {
args = args || []
var pending = args.length
if (!pending) return getDoc(".", cb)
args.forEach(function(proj) {
getDoc(proj, function(err) {
if (err) {
return cb(err)
}
--pending || cb()
})
})
}
function getDoc (project, cb) {
project = project || "."
var package = path.resolve(npm.localPrefix, "package.json")
if (project === "." || project === "./") {
var json
try {
json = require(package)
if (!json.name) throw new Error('package.json does not have a valid "name" property')
project = json.name
} catch (e) {
log.error(e.message)
return cb(docs.usage)
}
return opener(url(json), { command: npm.config.get("browser") }, cb)
}
mapToRegistry(project, npm.config, function (er, uri, auth) {
if (er) return cb(er)
npm.registry.get(uri + "/latest", { timeout : 3600, auth : auth }, next)
})
function next (er, json) {
var github = "https://github.com/" + project + "#readme"
11 years ago
if (er) {
if (project.split("/").length !== 2) return cb(er)
return opener(github, { command: npm.config.get("browser") }, cb)
11 years ago
}
return opener(url(json), { command: npm.config.get("browser") }, cb)
}
}