https://github.com/ship-components/ship-components-eslint-rules
ESLint style rules for SHIP applications
https://github.com/ship-components/ship-components-eslint-rules
eslint eslint-config eslint-rules eslintconfig eslintrc ship-components
Last synced: 2 months ago
JSON representation
ESLint style rules for SHIP applications
- Host: GitHub
- URL: https://github.com/ship-components/ship-components-eslint-rules
- Owner: ship-components
- Created: 2017-02-08T22:42:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-12-21T00:55:50.000Z (over 8 years ago)
- Last Synced: 2026-02-24T14:09:44.072Z (4 months ago)
- Topics: eslint, eslint-config, eslint-rules, eslintconfig, eslintrc, ship-components
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-config-ship-components
- Size: 41 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ship-components-eslint-rules
[eslint](http://eslint.org/) rules used in ship-components and Ship applications. Includes support for [Babel](https://github.com/babel/babel-eslint) and [React](https://github.com/yannickcr/eslint-plugin-react).
[](https://www.npmjs.com/package/eslint-config-ship-components)
[](https://travis-ci.org/ship-components/ship-components-eslint-rules)
[](https://david-dm.org/ship-components/ship-components-eslint-rules?type=peer)
[](https://david-dm.org/ship-components/ship-components-eslint-rules?type=dev)
# Usage
## Install
`npm install eslint-config-ship-components@latest --save-dev`
## Install peer dependencies
You can see them by running: `npm info eslint-config-ship-components@latest peerDependencies`
Linux/OSX users can simply run the following command to install them automatically.
```shell
(
export PKG=eslint-config-ship-components;
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",` to your .eslintrc
```js
{
"extends" : "ship-components",
// Additional rules
"rules": {
}
}
```
# Development
1. Clone this repo
2. Run `npm link` from the repository
3. In you the project folder you want to test in run `npm link eslint-config-ship-components`
4. Add to your `.eslintrc` like normal
# History
* 1.5.0 - Updated babel preset to env (from latest). Removed node 4 from Travis CI; added node 8.
* 1.4.2 - Fixes the one-var rule to enforce using multiple var, let, const per line.
* 1.4.1 - Fixes the invalid comma-dangle, space-after-keywords and array-bracket-spacing values
* 1.4.0 - Added rules for arrow functions based on airbnb
* 1.3.2 - Allowed arrow functions in render method, added more rules for spacing
* 1.3.1 - Switched jsx tabs to spaces
* 1.3.0 - Switched from tabs to spaces
* 1.2.0 - Updates the eslint setup to focus on react and JSX, and added tests
* 1.1.0 - Added indent rule
* 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.