deprecate things with depd module

History.md

@@ -1,6 +1,7 @@
 2.x
 ===
 
+  * deprecate things with `depd` module
   * use `finalhandler` for final response handling
   * deps: connect-timeout@1.1.1
     - deps: debug@1.0.2

lib/middleware/limit.js

@@ -9,6 +9,7 @@
  * Module dependencies.
  */
 
+var deprecate = require('depd')('connect');
 var parseBytes = require('bytes');
 var utils = require('../utils');
 var brokenPause = utils.brokenPause;
@@ -85,5 +86,5 @@ module.exports = function limit(bytes){
   };
 };
 
-module.exports = utils.deprecate(module.exports,
+module.exports = deprecate.function(module.exports,
   'limit: Restrict request size at location of read');

lib/middleware/methodOverride.js

@@ -9,8 +9,8 @@
  * Module dependencies.
  */
 
+var deprecate = require('depd')('connect');
 var methodOverride = require('method-override');
-var utils = require('../utils');
 
 /**
  * Method Override:
@@ -43,5 +43,5 @@ module.exports = function(key){
   };
 };
 
-module.exports = utils.deprecate(module.exports,
+module.exports = deprecate.function(module.exports,
   'methodOverride: use method-override module directly');

lib/middleware/multipart.js

@@ -9,10 +9,10 @@
  * Module dependencies.
  */
 
+var deprecate = require('depd')('connect');
 var multiparty = require('multiparty')
   , typeis = require('type-is')
   , _limit = require('./limit')
-  , utils = require('../utils')
   , qs = require('qs');
 
 /**
@@ -164,5 +164,5 @@ exports = module.exports = function(options){
   }
 };
 
-module.exports = utils.deprecate(module.exports,
+module.exports = deprecate.function(module.exports,
   'multipart: use parser (multiparty, busboy, formidable) directly');

lib/middleware/staticCache.js

@@ -9,6 +9,7 @@
  * Module dependencies.
  */
 
+var deprecate = require('depd')('connect');
 var utils = require('../utils')
   , parseurl = require('parseurl')
   , Cache = require('../cache')
@@ -140,7 +141,7 @@ module.exports = function staticCache(options){
   }
 };
 
-module.exports = utils.deprecate(module.exports,
+module.exports = deprecate.function(module.exports,
   'staticCache: use varnish or similar reverse proxy caches');
 
 /**

lib/patch.js

@@ -10,20 +10,14 @@
  */
 
 var cookie = require('cookie');
+var deprecate = require('depd')('connect');
 var http = require('http');
 var onHeaders = require('on-headers');
 var utils = require('./utils')
   , res = http.ServerResponse.prototype
   , addListener = res.addListener
   , setHeader = res.setHeader;
 
-/**
- * Deprecated proxy for .on('header', ...)
- */
-
-var attachHeaderListener = utils.deprecate(onHeaders,
-  'res.on("header"): use on-headers module directly');
-
 // apply only once
 
 if (!res._hasConnectPatch) {
@@ -39,9 +33,11 @@ if (!res._hasConnectPatch) {
   Object.defineProperty(res, 'headerSent', {
     configurable: true,
     enumerable: true,
-    get: utils.deprecate(headersSent, 'res.headerSent: use standard res.headersSent')
+    get: headersSent
   });
 
+  deprecate.property(res, 'headerSent', 'res.headerSent: use standard res.headersSent');
+
   if (!('headersSent' in res)) {
 
     /**
@@ -135,7 +131,8 @@ if (!res._hasConnectPatch) {
 
   res.on = function(type, listener){
     if (type === 'header') {
-      attachHeaderListener(this, listener);
+      deprecate('res.on("header"): use on-headers module directly');
+      onHeaders(this, listener);
       return this;
     }
 

lib/utils.js

@@ -10,13 +10,13 @@
  * Module dependencies.
  */
 
+var deprecate = require('depd')('connect');
 var http = require('http')
   , crypto = require('crypto')
   , parseurl = require('parseurl')
   , sep = require('path').sep
   , signature = require('cookie-signature')
   , typeis = require('type-is')
-  , deprecate = require('util').deprecate
   , nodeVersion = process.versions.node.split('.');
 
 /**
@@ -30,31 +30,6 @@ var charsetRegExp = /;\s*charset\s*=/;
 exports.brokenPause = parseInt(nodeVersion[0], 10) === 0
   && parseInt(nodeVersion[1], 10) < 10;
 
-
-/**
- * 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 = 'connect: ' + msg;
-
-  if (process.stderr.isTTY) {
-    // colorize
-    msg = '\x1b[31;1m' + msg + '\x1b[0m';
-  }
-
-  return deprecate(fn, msg);
-};
-
 /**
  * Return `true` if the request has a body, otherwise return `false`.
  *
@@ -63,7 +38,7 @@ exports.deprecate = function(fn, msg){
  * @api private
  */
 
-exports.hasBody = exports.deprecate(typeis.hasBody,
+exports.hasBody = deprecate.function(typeis.hasBody,
   'utils.hasBody: use type-is module directly');
 
 /**
@@ -81,7 +56,7 @@ exports.mime = function(req) {
   return ~i ? str.slice(0, i) : str;
 };
 
-exports.mime = exports.deprecate(exports.mime,
+exports.mime = deprecate.function(exports.mime,
   'utils.mime: use type-is directly for mime comparisons');
 
 /**
@@ -120,7 +95,7 @@ exports.md5 = function(str, encoding){
     .digest(encoding || 'hex');
 };
 
-exports.md5 = exports.deprecate(exports.md5,
+exports.md5 = deprecate.function(exports.md5,
   'utils.md5: use crypto directly for hashing');
 
 /**
@@ -163,7 +138,7 @@ exports.escape = function(html){
     .replace(/"/g, '&quot;');
 };
 
-exports.escape = exports.deprecate(exports.escape,
+exports.escape = deprecate.function(exports.escape,
   'utils.escape: use escape-html module directly');
 
 /**
@@ -175,7 +150,7 @@ exports.escape = exports.deprecate(exports.escape,
  * @api private
  */
 
-exports.sign = exports.deprecate(signature.sign,
+exports.sign = deprecate.function(signature.sign,
   'utils.sign: use cookie-signature module directly');
 
 /**
@@ -188,7 +163,7 @@ exports.sign = exports.deprecate(signature.sign,
  * @api private
  */
 
-exports.unsign = exports.deprecate(signature.unsign,
+exports.unsign = deprecate.function(signature.unsign,
   'utils.unsign: use cookie-signature module directly');
 
 /**
@@ -216,7 +191,7 @@ exports.parseSignedCookies = function(obj, secret){
   return ret;
 };
 
-exports.parseSignedCookies = exports.deprecate(exports.parseSignedCookies,
+exports.parseSignedCookies = deprecate.function(exports.parseSignedCookies,
   'utils.parseSignedCookies: this private api moved with cookie-parser');
 
 /**
@@ -251,7 +226,7 @@ exports.parseJSONCookies = function(obj){
   return obj;
 };
 
-exports.parseJSONCookies = exports.deprecate(exports.parseJSONCookies,
+exports.parseJSONCookies = deprecate.function(exports.parseJSONCookies,
   'utils.parseJSONCookies: this private api moved with cookie-parser');
 
 /**
@@ -317,7 +292,7 @@ exports.removeContentHeaders = function(res){
   });
 };
 
-exports.removeContentHeaders = exports.deprecate(exports.removeContentHeaders,
+exports.removeContentHeaders = deprecate.function(exports.removeContentHeaders,
   'utils.removeContentHeaders: this private api moved with serve-static');
 
 /**
@@ -333,7 +308,7 @@ exports.conditionalGET = function(req) {
     || req.headers['if-none-match'];
 };
 
-exports.conditionalGET = exports.deprecate(exports.conditionalGET,
+exports.conditionalGET = deprecate.function(exports.conditionalGET,
   'utils.conditionalGET: use fresh module directly');
 
 /**
@@ -350,7 +325,7 @@ exports.unauthorized = function(res, realm) {
   res.end('Unauthorized');
 };
 
-exports.unauthorized = exports.deprecate(exports.unauthorized,
+exports.unauthorized = deprecate.function(exports.unauthorized,
   'utils.unauthorized: this private api moved with basic-auth-connect');
 
 /**
@@ -367,7 +342,7 @@ exports.notModified = function(res) {
   res.end();
 };
 
-exports.notModified = exports.deprecate(exports.notModified,
+exports.notModified = deprecate.function(exports.notModified,
   'utils.notModified: this private api moved with serve-static');
 
 /**
@@ -383,7 +358,7 @@ exports.etag = function(stat) {
   return '"' + stat.size + '-' + Number(stat.mtime) + '"';
 };
 
-exports.etag = exports.deprecate(exports.etag,
+exports.etag = deprecate.function(exports.etag,
   'utils.etag: this private api moved with serve-static');
 
 /**
@@ -417,7 +392,7 @@ exports.parseCacheControl = function(str){
  * @api private
  */
 
-exports.parseUrl = exports.deprecate(parseurl,
+exports.parseUrl = deprecate.function(parseurl,
   'utils.parseUrl: use parseurl module directly');
 
 /**
@@ -430,7 +405,7 @@ exports.parseUrl = exports.deprecate(parseurl,
 
 exports.parseBytes = require('bytes');
 
-exports.parseBytes = exports.deprecate(exports.parseBytes,
+exports.parseBytes = deprecate.function(exports.parseBytes,
   'utils.parseBytes: use bytes module directly');
 
 /**
@@ -446,7 +421,7 @@ exports.normalizeSlashes = function normalizeSlashes(path) {
   return path.split(sep).join('/');
 };
 
-exports.normalizeSlashes = exports.deprecate(exports.normalizeSlashes,
+exports.normalizeSlashes = deprecate.function(exports.normalizeSlashes,
   'utils.normalizeSlashes: this private api moved with serve-index');
 
 /**

package.json

@@ -27,6 +27,7 @@
     "connect-timeout": "1.1.1",
     "csurf": "1.2.1",
     "debug": "1.0.2",
+    "depd": "0.3.0",
     "errorhandler": "1.1.0",
     "express-session": "1.3.1",
     "finalhandler": "0.0.1",

test/support/env.js

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