Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sharetribe/eslint-config-sharetribe
Sharetribe ESLint configuration
https://github.com/sharetribe/eslint-config-sharetribe
Last synced: 8 days ago
JSON representation
Sharetribe ESLint configuration
- Host: GitHub
- URL: https://github.com/sharetribe/eslint-config-sharetribe
- Owner: sharetribe
- Created: 2017-01-17T19:48:42.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-10T09:53:07.000Z (over 7 years ago)
- Last Synced: 2024-10-07T05:10:08.456Z (about 1 month ago)
- Language: JavaScript
- Size: 5.86 KB
- Stars: 1
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Sharetribe ESLint configuration
This package provides Sharetribe's shared [ESLint](http://eslint.org/) configuration. It extends the [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb) configuration by disabling many rules related to style and syntax and loosens some errors into warnings.
This enables using the configuration in a hot loading environment like an application created with [create-react-app](https://github.com/facebookincubator/create-react-app/) together with an automatic style and syntax formatter like [Prettier](https://github.com/jlongster/prettier).
## Usage
https://www.npmjs.com/package/eslint-config-sharetribe
Install with `npm`:
npm install --save-dev eslint-config-sharetribe
or with `yarn`:
yarn add --dev eslint-config-sharetribe
Then install the required peerDependencies.
Next, create an [ESLint configuration file](http://eslint.org/docs/user-guide/configuring#configuration-file-formats) and extend the `sharetribe` configuration:
**.eslintrc**:
```json
{
"extends": "sharetribe"
}
```You can then override rules as you wish in this configuration file.
## Changes
See [CHANGELOG.md](CHANGELOG.md).
## Author
Developed and maintained by [Sharetribe](https://www.sharetribe.com/).
## Licence
MIT