chore: deprecated hipchat appender

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'`.

docs/hipchat.md

@@ -1,51 +0,0 @@
-# Hipchat Appender
-
-The hipchat appender will send every log message it receives to a [hipchat](http://www.hipchat.com) server, over HTTP. It uses the [hipchat-notifier](https://www.npmjs.com/package/hipchat-notifier) library, and you will need to include that in your dependencies if you want to use this appender. If you're not sure what some of the configuration options below mean, then check the documentation for hipchat-notifier, and the hipchat docs themselves.
-
-## Configuration
-
-* `type` - `hipchat`
-* `hipchat_token` - `string` - User token with notification privileges
-* `hipchat_room` - `string` - Room ID or name
-* `hipchat_from` - `string` (optional, defaults to empty string) - a label to say where the message is from
-* `hipchat_notify` - `boolean` (optional, defaults to `false`) - make hipchat annoy people
-* `hipchat_host` - `string` (optional, defaults to `api.hipchat.com`) - set this if you have your own hipchat server
-* `hipchat_response_callback` - `function` (optional, defaults to only throwing errors) - implement this function if you want intercept the responses from hipchat
-* `layout` - (optional, defaults to `messagePassThroughLayout`)  - see [layouts](layouts.md)
-
-## Example (default config)
-
-```javascript
-log4js.configure({
-  appenders: {
-    squawk: { type: 'hipchat', hipchat_token: 'abc123', hipchat_room: 'ops' }
-  },
-  categories: {
-    default: { appenders: ['squawk'], level: 'error'}
-  }
-});
-```
-This will result in all error (and above) messages being sent to the hipchat room "ops".
-
-# Example (use all the options!)
-
-```javascript
-log4js.configure({
-  appenders: {
-    squawk: {
-      type: 'hipchat',
-      hipchat_token: 'abc123',
-      hipchat_room: 'things_are_on_fire',
-      hipchat_from: 'Hal9000',
-      hipchat_notify: true,
-      hipchat_host: 'hipchat.yourorganisation.com',
-      hipchat_response_callback: function(err, response) {
-        console.log("I got a response from hipchat: ", response);
-      }
-    }
-  },
-  categories: {
-    default: { appenders: ['squawk'], level: 'info' }
-  }
-});
-```

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;