https://github.com/ship-components/ship-components-eslint-rules-base

JavaScript ESLint style rules for SHIP applications
https://github.com/ship-components/ship-components-eslint-rules-base

eslint eslint-config eslint-plugin eslint-rules eslintconfig eslintrc javascript nodejs

Last synced: about 2 months ago
JSON representation

JavaScript ESLint style rules for SHIP applications

• Host: GitHub
• URL: https://github.com/ship-components/ship-components-eslint-rules-base
• Owner: ship-components
• License: mit
• Created: 2017-03-23T23:30:47.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-06-15T15:54:54.000Z (about 9 years ago)
• Last Synced: 2025-08-24T04:18:06.166Z (10 months ago)
• Topics: eslint, eslint-config, eslint-plugin, eslint-rules, eslintconfig, eslintrc, javascript, nodejs
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/eslint-config-ship-components-base
• Size: 9.77 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ship-components-eslint-rules-base

[eslint](http://eslint.org/) rules used in ship-components and Ship applications. Includes support for JavaScript.

[![npm](https://img.shields.io/npm/v/eslint-config-ship-components-base.svg?maxAge=2592000)](https://www.npmjs.com/package/eslint-config-ship-components-base)

[![Build Status](http://img.shields.io/travis/ship-components/ship-components-eslint-rules-base/master.svg?style=flat)](https://travis-ci.org/ship-components/ship-components-eslint-rules-base)

[![peerDependencies](https://img.shields.io/david/peer/ship-components/ship-components-eslint-rules-base.svg?style=flat)](https://david-dm.org/ship-components/ship-components-eslint-rules-base?type=peer)

[![devDependencies](https://img.shields.io/david/dev/ship-components/ship-components-eslint-rules-base.svg?style=flat)](https://david-dm.org/ship-components/ship-components-eslint-rules-base?type=dev)

# 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.

```shell

(

  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

```js

{

  "extends" : "ship-components-base",

  // 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-base`

4. 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.