Merge pull request log4js-node#678 from log4js-node/deprecate-hipchat

nomiddlename · web-flow · commit 178e95e18cfc · 2018-03-05T08:23:51.000+11:00
chore: deprecated hipchat appender
diff --git a/docs/appenders.md b/docs/appenders.md
@@ -24,7 +24,6 @@ The following appenders are included with log4js. Some require extra dependencie
 * [dateFile](dateFile.md)
 * [file](file.md)
 * [fileSync](fileSync.md)
-* [hipchat](hipchat.md)
 * [logFaces-HTTP](logFaces-HTTP.md)
 * [logFaces-UDP](logFaces-UDP.md)
 * [logLevelFilter](logLevelFilter.md)
@@ -46,6 +45,7 @@ The following appenders are included with log4js. Some require extra dependencie
 The following appenders are supported by log4js, but will issue deprecation warnings from version 2.6 onwards - they will be removed from the log4js core in version 3. If you are using these appenders, you should alter your dependencies to include them explicitly.
 
 * [gelf](https://github.com/log4js-node/gelf)
+* [hipchat](https://github.com/log4js-node/hipchat)
 * [loggly](https://github.com/log4js-node/loggly)
 
 For example, if you were previously using the gelf appender (`type: 'gelf'`) then you should add `@log4js-node/gelf` to your dependencies and change the type to `type: '@log4js-node/gelf'`.
diff --git a/docs/hipchat.md b/docs/hipchat.md
diff --git a/lib/appenders/hipchat.js b/lib/appenders/hipchat.js
@@ -79,7 +79,9 @@ function hipchatConfigure(config, layouts) {
     layout = layouts.layout(config.layout.type, config.layout);
   }
 
-  return hipchatAppender(config, layout);
+  const appender = hipchatAppender(config, layout);
+  appender.deprecated = '@log4js-node/hipchat';
+  return appender;
 }
 
 module.exports.configure = hipchatConfigure;

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,9 @@ function hipchatConfigure(config, layouts) {`
`79`	`79`	`layout = layouts.layout(config.layout.type, config.layout);`
`80`	`80`	`}`
`81`	`81`
`82`		`- return hipchatAppender(config, layout);`
	`82`	`+ const appender = hipchatAppender(config, layout);`
	`83`	`+ appender.deprecated = '@log4js-node/hipchat';`
	`84`	`+ return appender;`
`83`	`85`	`}`
`84`	`86`
`85`	`87`	`module.exports.configure = hipchatConfigure;`