2 module.exports = config
4 config.usage = "npm config set <key> <value>"
5 + "\nnpm config get [<key>]"
6 + "\nnpm config delete <key>"
9 + "\nnpm set <key> <value>"
12 var log = require("npmlog")
13 , npm = require("./npm.js")
14 , npmconf = require("./config/core.js")
15 , fs = require("graceful-fs")
16 , writeFileAtomic = require("write-file-atomic")
17 , types = npmconf.defs.types
18 , ini = require("ini")
19 , editor = require("editor")
21 , umask = require("./utils/umask")
23 config.completion = function (opts, cb) {
24 var argv = opts.conf.argv.remain
25 if (argv[1] !== "config") argv.unshift("config")
26 if (argv.length === 2) {
27 var cmds = ["get", "set", "delete", "ls", "rm", "edit"]
28 if (opts.partialWord !== "l") cmds.push("list")
35 // todo: complete with valid values, if possible.
36 if (argv.length > 3) return cb(null, [])
41 return cb(null, Object.keys(types))
43 case "list": case "ls":
45 default: return cb(null, [])
49 // npm config set key value
52 function config (args, cb) {
53 var action = args.shift()
55 case "set": return set(args[0], args[1], cb)
56 case "get": return get(args[0], cb)
57 case "delete": case "rm": case "del": return del(args[0], cb)
58 case "list": case "ls": return list(cb)
59 case "edit": return edit(cb)
60 default: return unknown(action, cb)
65 var e = npm.config.get("editor")
66 , which = npm.config.get("global") ? "global" : "user"
67 , f = npm.config.get(which + "config")
68 if (!e) return cb(new Error("No EDITOR config or environ set."))
69 npm.config.save(which, function (er) {
71 fs.readFile(f, "utf8", function (er, data) {
74 , "; npm "+(npm.config.get("global") ?
75 "globalconfig" : "userconfig")+" file"
76 , "; this is a simple ini-formatted file"
77 , "; lines that start with semi-colons are comments."
78 , "; read `npm help config` for help on the various options"
83 , "; all options with default values"
87 .concat(Object.keys(npmconf.defaults).reduce(function (arr, key) {
89 obj[key] = npmconf.defaults[key]
90 if (key === "logstream") return arr
95 .replace(/\n/g, "\n; ")
104 if (er) return cb(er)
105 editor(f, { editor: e }, cb)
112 function del (key, cb) {
113 if (!key) return cb(new Error("no key provided"))
114 var where = npm.config.get("global") ? "global" : "user"
115 npm.config.del(key, where)
116 npm.config.save(where, cb)
119 function set (key, val, cb) {
120 if (key === undefined) {
121 return unknown("", cb)
123 if (val === undefined) {
124 if (key.indexOf("=") !== -1) {
125 var k = key.split("=")
134 log.info("config", "set %j %j", key, val)
135 var where = npm.config.get("global") ? "global" : "user"
136 if (key.match(/umask/)) val = umask.fromString(val)
137 npm.config.set(key, val, where)
138 npm.config.save(where, cb)
141 function get (key, cb) {
142 if (!key) return list(cb)
144 return cb(new Error("---sekretz---"))
146 var val = npm.config.get(key)
147 if (key.match(/umask/)) val = umask.toString(val)
152 function sort (a, b) {
153 return a > b ? 1 : -1
156 function public (k) {
157 return !(k.charAt(0) === "_" ||
158 k.indexOf(":_") !== -1 ||
159 types[k] !== types[k])
162 function getKeys (data) {
163 return Object.keys(data).filter(public).sort(sort)
168 , long = npm.config.get("long")
170 var cli = npm.config.sources.cli.data
171 , cliKeys = getKeys(cli)
172 if (cliKeys.length) {
173 msg += "; cli configs\n"
174 cliKeys.forEach(function (k) {
175 if (cli[k] && typeof cli[k] === "object") return
176 if (k === "argv") return
177 msg += k + " = " + JSON.stringify(cli[k]) + "\n"
183 var env = npm.config.sources.env.data
184 , envKeys = getKeys(env)
185 if (envKeys.length) {
186 msg += "; environment configs\n"
187 envKeys.forEach(function (k) {
188 if (env[k] !== npm.config.get(k)) {
190 msg += "; " + k + " = " + JSON.stringify(env[k])
192 } else msg += k + " = " + JSON.stringify(env[k]) + "\n"
198 var uconf = npm.config.sources.user.data
199 , uconfKeys = getKeys(uconf)
200 if (uconfKeys.length) {
201 msg += "; userconfig " + npm.config.get("userconfig") + "\n"
202 uconfKeys.forEach(function (k) {
203 var val = (k.charAt(0) === "_")
205 : JSON.stringify(uconf[k])
206 if (uconf[k] !== npm.config.get(k)) {
208 msg += "; " + k + " = " + val
210 } else msg += k + " = " + val + "\n"
215 // global config file
216 var gconf = npm.config.sources.global.data
217 , gconfKeys = getKeys(gconf)
218 if (gconfKeys.length) {
219 msg += "; globalconfig " + npm.config.get("globalconfig") + "\n"
220 gconfKeys.forEach(function (k) {
221 var val = (k.charAt(0) === "_")
223 : JSON.stringify(gconf[k])
224 if (gconf[k] !== npm.config.get(k)) {
226 msg += "; " + k + " = " + val
228 } else msg += k + " = " + val + "\n"
233 // builtin config file
234 var builtin = npm.config.sources.builtin || {}
235 if (builtin && builtin.data) {
236 var bconf = builtin.data
237 , bpath = builtin.path
238 , bconfKeys = getKeys(bconf)
239 if (bconfKeys.length) {
240 msg += "; builtin config " + bpath + "\n"
241 bconfKeys.forEach(function (k) {
242 var val = (k.charAt(0) === "_")
244 : JSON.stringify(bconf[k])
245 if (bconf[k] !== npm.config.get(k)) {
247 msg += "; " + k + " = " + val
249 } else msg += k + " = " + val + "\n"
255 // only show defaults if --long
257 msg += "; node bin location = " + process.execPath + "\n"
258 + "; cwd = " + process.cwd() + "\n"
259 + "; HOME = " + process.env.HOME + "\n"
260 + "; 'npm config ls -l' to show all defaults.\n"
266 var defaults = npmconf.defaults
267 , defKeys = getKeys(defaults)
268 msg += "; default values\n"
269 defKeys.forEach(function (k) {
270 if (defaults[k] && typeof defaults[k] === "object") return
271 var val = JSON.stringify(defaults[k])
272 if (defaults[k] !== npm.config.get(k)) {
273 msg += "; " + k + " = " + val
275 } else msg += k + " = " + val + "\n"
283 function unknown (action, cb) {
284 cb("Usage:\n" + config.usage)