UNPKG

7.9 kBJavaScriptView Raw
1
2module.exports = config
3
4config.usage = "npm config set <key> <value>"
5 + "\nnpm config get [<key>]"
6 + "\nnpm config delete <key>"
7 + "\nnpm config list"
8 + "\nnpm config edit"
9 + "\nnpm set <key> <value>"
10 + "\nnpm get [<key>]"
11
12var log = require("npmlog")
13 , npm = require("./npm.js")
14 , spawn = require("child_process").spawn
15 , fs = require("graceful-fs")
16 , npmconf = require("npmconf")
17 , types = npmconf.defs.types
18 , ini = require("ini")
19 , editor = require("editor")
20 , os = require("os")
21
22config.completion = function (opts, cb) {
23 var argv = opts.conf.argv.remain
24 if (argv[1] !== "config") argv.unshift("config")
25 if (argv.length === 2) {
26 var cmds = ["get", "set", "delete", "ls", "rm", "edit"]
27 if (opts.partialWord !== "l") cmds.push("list")
28 return cb(null, cmds)
29 }
30
31 var action = argv[2]
32 switch (action) {
33 case "set":
34 // todo: complete with valid values, if possible.
35 if (argv.length > 3) return cb(null, [])
36 // fallthrough
37 case "get":
38 case "delete":
39 case "rm":
40 return cb(null, Object.keys(types))
41 case "edit":
42 case "list": case "ls":
43 return cb(null, [])
44 default: return cb(null, [])
45 }
46}
47
48// npm config set key value
49// npm config get key
50// npm config list
51function config (args, cb) {
52 var action = args.shift()
53 switch (action) {
54 case "set": return set(args[0], args[1], cb)
55 case "get": return get(args[0], cb)
56 case "delete": case "rm": case "del": return del(args[0], cb)
57 case "list": case "ls": return list(cb)
58 case "edit": return edit(cb)
59 default: return unknown(action, cb)
60 }
61}
62
63function edit (cb) {
64 var e = npm.config.get("editor")
65 , which = npm.config.get("global") ? "global" : "user"
66 , f = npm.config.get(which + "config")
67 if (!e) return cb(new Error("No EDITOR config or environ set."))
68 npm.config.save(which, function (er) {
69 if (er) return cb(er)
70 fs.readFile(f, "utf8", function (er, data) {
71 if (er) data = ""
72 data = [ ";;;;"
73 , "; npm "+(npm.config.get("global") ?
74 "globalconfig" : "userconfig")+" file"
75 , "; this is a simple ini-formatted file"
76 , "; lines that start with semi-colons are comments."
77 , "; read `npm help config` for help on the various options"
78 , ";;;;"
79 , ""
80 , data
81 ].concat( [ ";;;;"
82 , "; all options with default values"
83 , ";;;;"
84 ]
85 )
86 .concat(Object.keys(npmconf.defaults).reduce(function (arr, key) {
87 var obj = {};
88 obj[key] = npmconf.defaults[key]
89 if (key === "logstream") return arr
90 return arr.concat(
91 ini.stringify(obj)
92 .replace(/\n$/m, '')
93 .replace(/^/g, '; ')
94 .replace(/\n/g, '\n; ')
95 .split('\n'))
96 }, []))
97 .concat([""])
98 .join(os.EOL)
99 fs.writeFile
100 ( f
101 , data
102 , "utf8"
103 , function (er) {
104 if (er) return cb(er)
105 editor(f, { editor: e }, cb)
106 }
107 )
108 })
109 })
110}
111
112function 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)
117}
118
119function set (key, val, cb) {
120 if (key === undefined) {
121 return unknown("", cb)
122 }
123 if (val === undefined) {
124 if (key.indexOf("=") !== -1) {
125 var k = key.split("=")
126 key = k.shift()
127 val = k.join("=")
128 } else {
129 val = ""
130 }
131 }
132 key = key.trim()
133 val = val.trim()
134 log.info("config", "set %j %j", key, val)
135 var where = npm.config.get("global") ? "global" : "user"
136 npm.config.set(key, val, where)
137 npm.config.save(where, cb)
138}
139
140function get (key, cb) {
141 if (!key) return list(cb)
142 if (key.charAt(0) === "_") {
143 return cb(new Error("---sekretz---"))
144 }
145 console.log(npm.config.get(key))
146 cb()
147}
148
149function sort (a, b) {
150 return a > b ? 1 : -1
151}
152
153function reverse (a, b) {
154 return a > b ? -1 : 1
155}
156
157function public (k) {
158 return !(k.charAt(0) === "_" || types[k] !== types[k])
159}
160
161function getKeys (data) {
162 return Object.keys(data).filter(public).sort(sort)
163}
164
165function list (cb) {
166 var msg = ""
167 , long = npm.config.get("long")
168
169 var cli = npm.config.sources.cli.data
170 , cliKeys = getKeys(cli)
171 if (cliKeys.length) {
172 msg += "; cli configs\n"
173 cliKeys.forEach(function (k) {
174 if (cli[k] && typeof cli[k] === "object") return
175 if (k === "argv") return
176 msg += k + " = " + JSON.stringify(cli[k]) + "\n"
177 })
178 msg += "\n"
179 }
180
181 // env configs
182 var env = npm.config.sources.env.data
183 , envKeys = getKeys(env)
184 if (envKeys.length) {
185 msg += "; environment configs\n"
186 envKeys.forEach(function (k) {
187 if (env[k] !== npm.config.get(k)) {
188 if (!long) return
189 msg += "; " + k + " = " + JSON.stringify(env[k])
190 + " (overridden)\n"
191 } else msg += k + " = " + JSON.stringify(env[k]) + "\n"
192 })
193 msg += "\n"
194 }
195
196 // user config file
197 var uconf = npm.config.sources.user.data
198 , uconfKeys = getKeys(uconf)
199 if (uconfKeys.length) {
200 msg += "; userconfig " + npm.config.get("userconfig") + "\n"
201 uconfKeys.forEach(function (k) {
202 var val = (k.charAt(0) === "_")
203 ? "---sekretz---"
204 : JSON.stringify(uconf[k])
205 if (uconf[k] !== npm.config.get(k)) {
206 if (!long) return
207 msg += "; " + k + " = " + val
208 + " (overridden)\n"
209 } else msg += k + " = " + val + "\n"
210 })
211 msg += "\n"
212 }
213
214 // global config file
215 var gconf = npm.config.sources.global.data
216 , gconfKeys = getKeys(gconf)
217 if (gconfKeys.length) {
218 msg += "; globalconfig " + npm.config.get("globalconfig") + "\n"
219 gconfKeys.forEach(function (k) {
220 var val = (k.charAt(0) === "_")
221 ? "---sekretz---"
222 : JSON.stringify(gconf[k])
223 if (gconf[k] !== npm.config.get(k)) {
224 if (!long) return
225 msg += "; " + k + " = " + val
226 + " (overridden)\n"
227 } else msg += k + " = " + val + "\n"
228 })
229 msg += "\n"
230 }
231
232 // builtin config file
233 var builtin = npm.config.sources.builtin || {}
234 if (builtin && builtin.data) {
235 var bconf = builtin.data
236 , bpath = builtin.path
237 , bconfKeys = getKeys(bconf)
238 if (bconfKeys.length) {
239 var path = require("path")
240 msg += "; builtin config " + bpath + "\n"
241 bconfKeys.forEach(function (k) {
242 var val = (k.charAt(0) === "_")
243 ? "---sekretz---"
244 : JSON.stringify(bconf[k])
245 if (bconf[k] !== npm.config.get(k)) {
246 if (!long) return
247 msg += "; " + k + " = " + val
248 + " (overridden)\n"
249 } else msg += k + " = " + val + "\n"
250 })
251 msg += "\n"
252 }
253 }
254
255 // only show defaults if --long
256 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"
261
262 console.log(msg)
263 return cb()
264 }
265
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
274 + " (overridden)\n"
275 } else msg += k + " = " + val + "\n"
276 })
277 msg += "\n"
278
279 console.log(msg)
280 return cb()
281}
282
283function unknown (action, cb) {
284 cb("Usage:\n" + config.usage)
285}