0.0.2 • Published 6 years ago

eslint-plugin-socket-io v0.0.2

Weekly downloads
1
License
MIT
Repository
-
Last release
6 years ago

eslint-plugin-socket-io

ESLint rules for Socket.io.

Installation

You'll first need to install ESLint:

$ npm install eslint --save-dev

Next, install eslint-plugin-socket-io:

$ npm install @lixar/eslint-plugin-socket-io --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-socket-io globally.

Usage

Add socket-io to the plugins section of your .eslintrc.json configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["socket-io"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "socket-io/no-public-emit": 1
  }
}

or start with the recommended rule set:

{
  "extends": ["plugin:socket-io/recommended"]
}

Rules

ruledescriptionrecommendedfixable
no-public-emitForbids the broadcasting of public messages:bangbang:

Key

icondescription
:bangbang:Reports as error in recommended configuration
:warning:Reports as warning in recommended configuration
:seven:ES2017 Async Await rules
:wrench:Rule is fixable with eslint --fix