deprecate things with depd module

Author: dougwilson

History.md

@@ -1,6 +1,7 @@
 unreleased
 ==========
 
+ * deprecate things with `depd` module
  * deps: [email protected]
  * deps: [email protected]
    - deprecate `verify` option to `json` -- use `body-parser` module directly

lib/application.js

@@ -12,8 +12,8 @@ var connect = require('connect')
   , compileTrust = require('./utils').compileTrust
   , View = require('./view')
   , utils = connect.utils
-  , deprecate = require('./utils').deprecate
   , http = require('http');
+var deprecate = require('depd')('express');
 
 /**
  * Application prototype.
@@ -448,7 +448,7 @@ app.all = function(path){
 
 // del -> delete alias
 
-app.del = deprecate(app.delete, 'app.del: Use app.delete instead');
+app.del = deprecate.function(app.delete, 'app.del: Use app.delete instead');
 
 /**
  * Render the given view `name` name with `options`

lib/express.js

@@ -2,14 +2,14 @@
  * Module dependencies.
  */
 
+var deprecate = require('depd')('express');
 var merge = require('merge-descriptors');
 var connect = require('connect')
   , proto = require('./application')
   , Route = require('./router/route')
   , Router = require('./router')
   , req = require('./request')
   , res = require('./response')
-  , deprecate = require('./utils').deprecate
   , utils = connect.utils;
 
 /**
@@ -51,7 +51,7 @@ merge(exports, connect.middleware);
  * Deprecated createServer().
  */
 
-exports.createServer = deprecate(createApplication,
+exports.createServer = deprecate.function(createApplication,
   'createServer() is deprecated\n' +
   'express applications no longer inherit from http.Server\n' +
   'please use:\n' +

lib/response.js

@@ -2,6 +2,7 @@
  * Module dependencies.
  */
 
+var deprecate = require('depd')('express');
 var escapeHtml = require('escape-html');
 var vary = require('vary');
 var http = require('http')
@@ -12,7 +13,6 @@ var http = require('http')
   , normalizeType = require('./utils').normalizeType
   , normalizeTypes = require('./utils').normalizeTypes
   , setCharset = require('./utils').setCharset
-  , deprecate = require('./utils').deprecate
   , statusCodes = http.STATUS_CODES
   , cookie = require('cookie')
   , send = require('send')
@@ -196,9 +196,11 @@ res.json = function(obj){
     // res.json(body, status) backwards compat
     if ('number' == typeof arguments[1]) {
       this.statusCode = arguments[1];
-      return 'number' === typeof obj
-        ? jsonNumDeprecated.call(this, obj)
-        : jsonDeprecated.call(this, obj);
+      if (typeof obj === 'number') {
+        deprecate('res.json(obj, status): Use res.json(status, obj) instead');
+      } else {
+        deprecate('res.json(num, status): Use res.status(status).json(num) instead');
+      }
     } else {
       this.statusCode = obj;
       obj = arguments[1];
@@ -218,12 +220,6 @@ res.json = function(obj){
   return this.send(body);
 };
 
-var jsonDeprecated = deprecate(res.json,
-  'res.json(obj, status): Use res.json(status, obj) instead');
-
-var jsonNumDeprecated = deprecate(res.json,
-  'res.json(num, status): Use res.status(status).json(num) instead');
-
 /**
  * Send JSON response with JSONP callback support.
  *
@@ -246,9 +242,11 @@ res.jsonp = function(obj){
     // res.json(body, status) backwards compat
     if ('number' == typeof arguments[1]) {
       this.statusCode = arguments[1];
-      return 'number' === typeof obj
-        ? jsonpNumDeprecated.call(this, obj)
-        : jsonpDeprecated.call(this, obj);
+      if (typeof obj === 'number') {
+        deprecate('res.jsonp(obj, status): Use res.jsonp(status, obj) instead');
+      } else {
+        deprecate('res.jsonp(num, status): Use res.status(status).jsonp(num) instead');
+      }
     } else {
       this.statusCode = obj;
       obj = arguments[1];
@@ -283,12 +281,6 @@ res.jsonp = function(obj){
   return this.send(body);
 };
 
-var jsonpDeprecated = deprecate(res.json,
-  'res.jsonp(obj, status): Use res.jsonp(status, obj) instead');
-
-var jsonpNumDeprecated = deprecate(res.json,
-  'res.jsonp(num, status): Use res.status(status).jsonp(num) instead');
-
 /**
  * Transfer the file at the given `path`.
  *

lib/utils.js

@@ -4,7 +4,6 @@
  */
 
 var mime = require('connect').mime
-  , deprecate = require('util').deprecate
   , proxyaddr = require('proxy-addr')
   , crc32 = require('buffer-crc32')
   , crypto = require('crypto');
@@ -20,30 +19,6 @@ var toString = {}.toString;
  */
 var charsetRegExp = /;\s*charset\s*=/;
 
-/**
- * Deprecate function, like core `util.deprecate`,
- * but with NODE_ENV and color support.
- *
- * @param {Function} fn
- * @param {String} msg
- * @return {Function}
- * @api private
- */
-
-exports.deprecate = function(fn, msg){
-  if (process.env.NODE_ENV === 'test') return fn;
-
-  // prepend module name
-  msg = 'express: ' + msg;
-
-  if (process.stderr.isTTY) {
-    // colorize
-    msg = '\x1b[31;1m' + msg + '\x1b[0m';
-  }
-
-  return deprecate(fn, msg);
-};
-
 /**
  * Return strong ETag for `body`.
  *

package.json

@@ -29,6 +29,7 @@
     "connect": "2.20.2",
     "commander": "1.3.2",
     "debug": "1.0.2",
+    "depd": "0.3.0",
     "escape-html": "1.0.1",
     "methods": "1.0.1",
     "mkdirp": "0.5.0",

test/support/env.js

@@ -1,3 +1,3 @@
 
 process.env.NODE_ENV = 'test';
-process.env.NO_DEPRECATION = 'connect';
+process.env.NO_DEPRECATION = 'connect,express';

test/utils.js

@@ -2,28 +2,6 @@
 var utils = require('../lib/utils')
   , assert = require('assert');
 
-describe('utils.deprecate(fn, msg)', function(){
-  var env
-  before(function(){
-    env = process.env.NODE_ENV
-  })
-  after(function(){
-    process.env.NODE_ENV = env
-  })
-
-  it('should pass-through fn in test environment', function(){
-    var fn = function(){}
-    process.env.NODE_ENV = 'test'
-    utils.deprecate(fn).should.equal(fn)
-  })
-
-  it('should return new fn in other environment', function(){
-    var fn = function(){}
-    process.env.NODE_ENV = ''
-    utils.deprecate(fn).should.not.equal(fn)
-  })
-})
-
 describe('utils.etag(body, encoding)', function(){
   it('should support strings', function(){
     utils.etag('express!')