https://github.com/videojs/eslint-config-videojs
https://github.com/videojs/eslint-config-videojs
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/videojs/eslint-config-videojs
- Owner: videojs
- License: other
- Created: 2015-12-01T22:35:23.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-05-10T15:01:09.000Z (about 2 years ago)
- Last Synced: 2025-06-08T07:44:10.063Z (about 1 year ago)
- Language: JavaScript
- Size: 520 KB
- Stars: 3
- Watchers: 23
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# video.js ESLint Shareable Config
[](https://travis-ci.org/videojs/eslint-config-videojs)
[](https://greenkeeper.io/)
[](http://slack.videojs.com)
[](https://nodei.co/npm/eslint-config-videojs/)
An ESLint [Shareable Config][shareable-configs] for [video.js Standard Style][videojs-standard].
_This package is for advanced users. If you only want the [video.js Standard Style][videojs-standard] program to check your code, use that instead!_
Lead Maintainer: Pat O'Neill [@misteroneill](https://github.com/misteroneill)
Maintenance Status: Stable
## Install
```bash
npm install eslint-config-videojs
```
## Usage
Shareable configs are designed to work with the `extends` feature of `.eslintrc` files.
You can learn more about [Shareable Configs][shareable-configs] on the official ESLint website.
To use the video.js Standard Style shareable config, first run this:
```bash
npm install eslint-config-videojs
```
Then, add this to your .eslintrc file:
```json
{
"extends": "videojs"
}
```
*Note: We omitted the `eslint-config-` prefix since it is automatically assumed by ESLint.*
You can override settings from the shareable config by adding them directly into your `.eslintrc` file.
## Contributing
This project should almost never change.
A rule should only change if there is a _very_ compelling reason that the video.js core contributors have agreed upon by discussion in an issue.
### Versioning Guidelines
Because this project can cause builds to fail, we want to avoid any potentially breaking changes outside of major versions. As such, these rules will be followed:
- Any change which is a loosening of a rule (an error becoming a warning or a rule being removed) can be released as a **patch**.
- Any change which is tightening a rule from off to warning can be released as a **minor**.
- All other changes are considered **major**.
This should allow common version ranges (`~` and `^`) to _never_ introduce a change that could break someone's build due to linter errors!
## License
Apache-2.0. Copyright (c) [Brightcove, Inc.][bcov]
This project is based on [`eslint-config-standard`][eslint-config-standard], which is licensed under the MIT license and copyright (c) Feross Aboukhadijeh.
[bcov]: https://www.brightcove.com/
[contrib]: CONTRIBUTING.md
[eslint-config-standard]: https://github.com/feross/eslint-config-standard
[shareable-configs]: http://eslint.org/docs/developer-guide/shareable-configs
[videojs-standard]: https://github.com/videojs/standard