npm deprecate function

1 files changed, 33 insertions, 0 deletions

diff --git a/lib/deprecate.js b/lib/deprecate.js
new file mode 100644
index 000000000..b42d2c012
--- /dev/null
+++ b/lib/deprecate.js
@@ -0,0 +1,33 @@
+
+module.exports = deprecate
+
+deprecate.usage = "npm deprecate <pkg>[@<version>] <message>"
+
+var registry = require("./utils/registry")
+  , semver = require("./utils/semver")
+  , log = require("./utils/log")
+  , asyncMap = require("./utils/async-map")
+
+function deprecate (args, cb) {
+  var pkg = args[0]
+    , msg = args[1]
+  if (msg === undefined) return cb(new Error(deprecate.usage))
+  // fetch the data and make sure it exists.
+  pkg = pkg.split(/@/)
+  var name = pkg.shift()
+    , ver = pkg.join("@")
+  if (semver.validRange(ver) === null) {
+    return cb(new Error("invalid version range: "+ver))
+  }
+  registry.get(name, function (er, data) {
+    if (er) return cb(er)
+    // filter all the versions that match
+    Object.keys(data.versions).filter(function (v) {
+      return semver.satisfies(v, ver)
+    }).forEach(function (v) {
+      data.versions[v].deprecated = msg
+    })
+    // now update the doc on the registry
+    registry.request.PUT(data._id, data, cb)
+  })
+}