eslint-config-ship-components-base
v1.1.0
Published
JavaScript Eslint Rules for SHIP Back-End Code
Downloads
6
Readme
ship-components-eslint-rules-base
eslint rules used in ship-components and Ship applications. Includes support for JavaScript.
Usage
Install
npm install eslint-config-ship-components-base@latest --save-dev
Install peer dependencies
You can see them by running: npm info eslint-config-ship-components-base@latest peerDependencies
Linux/OSX users can simply run the following command to install them automatically.
(
export PKG=eslint-config-ship-components-base;
npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)
Setup .eslintrc
Add "extends": "ship-components-base",
to your .eslintrc
{
"extends" : "ship-components-base",
// Additional rules
"rules": {
}
}
Development
- Clone this repo
- Run
npm link
from the repository - In you the project folder you want to test in run
npm link eslint-config-ship-components-base
- Add to your
.eslintrc
like normal
History
- 1.1.0 - Switched to spaces
- 1.0.0 - Initial commit
License
MIT License
Copyright (c) 2017 SHIP
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.