1 // npm view [pkg [pkg ...]]
4 view.usage = "npm view pkg[@version] [<field>[.subfield]...]"
6 var npm = require("./npm.js")
7 , readJson = require("read-package-json")
8 , log = require("npmlog")
9 , util = require("util")
10 , semver = require("semver")
11 , mapToRegistry = require("./utils/map-to-registry.js")
12 , npa = require("npm-package-arg")
13 , path = require("path")
15 view.completion = function (opts, cb) {
16 if (opts.conf.argv.remain.length <= 2) {
17 // FIXME: there used to be registry completion here, but it stopped making
18 // sense somewhere around 50,000 packages on the registry
21 // have the package, get the fields.
22 var tag = npm.config.get("tag")
23 mapToRegistry(opts.conf.argv.remain[2], npm.config, function (er, uri, auth) {
26 npm.registry.get(uri, { auth : auth }, function (er, d) {
28 var dv = d.versions[d["dist-tags"][tag]]
30 d.versions = Object.keys(d.versions).sort(semver.compareLoose)
31 fields = getFields(d).concat(getFields(dv))
36 function getFields (d, f, pref) {
40 Object.keys(d).forEach(function (k) {
41 if (k.charAt(0) === "_" || k.indexOf(".") !== -1) return
42 var p = pref.concat(k).join(".")
44 if (Array.isArray(d[k])) {
45 d[k].forEach(function (val, i) {
46 var pi = p + "[" + i + "]"
47 if (val && typeof val === "object") getFields(val, f, [p])
52 if (typeof d[k] === "object") getFields(d[k], f, [p])
58 function view (args, silent, cb) {
59 if (typeof cb !== "function") cb = silent, silent = false
61 if (!args.length) args = ["."]
63 var pkg = args.shift()
66 , local = (name === "." || !name)
68 if (npm.config.get("global") && local) {
69 return cb(new Error("Cannot use view command in global mode."))
74 readJson(path.resolve(dir, "package.json"), function (er, d) {
76 if (er && er.code !== "ENOENT" && er.code !== "ENOTDIR") return cb(er)
77 if (!d.name) return cb(new Error("Invalid package.json"))
81 if (pkg && ~pkg.indexOf("@")) {
82 nv.rawSpec = pkg.split("@")[pkg.indexOf("@")]
85 fetchAndRead(nv, args, silent, cb)
88 fetchAndRead(nv, args, silent, cb)
92 function fetchAndRead (nv, args, silent, cb) {
93 // get the data about this package
95 , version = nv.rawSpec || npm.config.get("tag")
97 mapToRegistry(name, npm.config, function (er, uri, auth) {
100 npm.registry.get(uri, { auth : auth }, function (er, data) {
101 if (er) return cb(er)
102 if (data["dist-tags"] && data["dist-tags"].hasOwnProperty(version)) {
103 version = data["dist-tags"][version]
106 if (data.time && data.time.unpublished) {
107 var u = data.time.unpublished
108 er = new Error("Unpublished by " + u.name + " on " + u.time)
118 , versions = data.versions || {}
119 data.versions = Object.keys(versions).sort(semver.compareLoose)
120 if (!args.length) args = [""]
122 // remove readme unless we asked for it
123 if (-1 === args.indexOf("readme")) {
127 Object.keys(versions).forEach(function (v) {
128 if (semver.satisfies(v, version, true)) args.forEach(function (args) {
129 // remove readme unless we asked for it
130 if (-1 === args.indexOf("readme")) {
131 delete versions[v].readme
133 results.push(showFields(data, versions[v], args))
136 results = results.reduce(reducer, {})
139 if (args.length === 1 && args[0] === "") {
140 retval = cleanBlanks(retval)
141 log.silly("cleanup", retval)
144 if (error || silent) cb(error, retval)
145 else printData(results, data._id, cb.bind(null, error, retval))
150 function cleanBlanks (obj) {
152 Object.keys(obj).forEach(function (version) {
153 clean[version] = obj[version][""]
158 function reducer (l, r) {
159 if (r) Object.keys(r).forEach(function (v) {
161 Object.keys(r[v]).forEach(function (t) {
168 // return whatever was printed
169 function showFields (data, version, fields) {
171 ;[data, version].forEach(function (s) {
172 Object.keys(s).forEach(function (k) {
176 return search(o, fields.split("."), version.version, fields)
179 function search (data, fields, version, title) {
182 while (!field && fields.length) field = tail.shift()
183 fields = [field].concat(tail)
185 if (!field && !tail.length) {
188 o[version][title] = data
191 var index = field.match(/(.+)\[([^\]]+)\]$/)
195 if (data.field && data.field.hasOwnProperty(index)) {
196 return search(data[field][index], tail, version, title)
198 field = field + "[" + index + "]"
201 if (Array.isArray(data)) {
202 if (data.length === 1) {
203 return search(data[0], fields, version, title)
206 data.forEach(function (data, i) {
207 var tl = title.length
208 , newt = title.substr(0, tl-(fields.join(".").length) - 1)
209 + "["+i+"]" + [""].concat(fields).join(".")
210 results.push(search(data, fields.slice(), version, newt))
212 results = results.reduce(reducer, {})
215 if (!data.hasOwnProperty(field)) return undefined
218 if (typeof data === "object") {
219 // there are more fields to deal with.
220 return search(data, tail, version, title)
222 return new Error("Not an object: "+data)
227 o[version][title] = data
231 function printData (data, name, cb) {
232 var versions = Object.keys(data)
234 , includeVersions = versions.length > 1
237 versions.forEach(function (v) {
238 var fields = Object.keys(data[v])
239 includeFields = includeFields || (fields.length > 1)
240 fields.forEach(function (f) {
241 var d = cleanup(data[v][f])
242 if (includeVersions || includeFields || typeof d !== "string") {
243 d = cleanup(data[v][f])
244 d = npm.config.get("json")
245 ? JSON.stringify(d, null, 2)
246 : util.inspect(d, false, 5, npm.color)
247 } else if (typeof d === "string" && npm.config.get("json")) {
248 d = JSON.stringify(d)
250 if (f && includeFields) f += " = "
251 if (d.indexOf("\n") !== -1) d = " \n" + d
252 msg += (includeVersions ? name + "@" + v + " " : "")
253 + (includeFields ? f : "") + d + "\n"
257 // preserve output symmetry by adding a whitespace-only line at the end if
258 // there's one at the beginning
259 if (/^\s*\n/.test(msg)) msg += "\n"
261 // print directly to stdout to not unnecessarily add blank lines
262 process.stdout.write(msg)
266 function cleanup (data) {
267 if (Array.isArray(data)) {
268 if (data.length === 1) {
271 return data.map(cleanup)
274 if (!data || typeof data !== "object") return data
276 if (typeof data.versions === "object"
278 && !Array.isArray(data.versions)) {
279 data.versions = Object.keys(data.versions || {})
282 var keys = Object.keys(data)
283 keys.forEach(function (d) {
284 if (d.charAt(0) === "_") delete data[d]
285 else if (typeof data[d] === "object") data[d] = cleanup(data[d])
287 keys = Object.keys(data)
290 && (keys.length === 1
291 || keys.length === 3 && data.email && data.url
292 || keys.length === 2 && (data.email || data.url))) {
293 data = unparsePerson(data)
297 function unparsePerson (d) {
298 if (typeof d === "string") return d
300 + (d.email ? " <"+d.email+">" : "")
301 + (d.url ? " ("+d.url+")" : "")