Skip to content

Latest commit

 

History

History
73 lines (45 loc) · 2.75 KB

README.md

File metadata and controls

73 lines (45 loc) · 2.75 KB
Raw

video.js ESLint Shareable Config

Build Status Greenkeeper badge Slack Status

NPM

An ESLint Shareable Config for video.js Standard Style.

This package is for advanced users. If you only want the video.js Standard Style program to check your code, use that instead!

Lead Maintainer: Pat O'Neill @misteroneill

Maintenance Status: Stable

Install

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 on the official ESLint website.

To use the video.js Standard Style shareable config, first run this:

npm install eslint-config-videojs

Then, add this to your .eslintrc file:

{
  "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.

This project is based on eslint-config-standard, which is licensed under the MIT license and copyright (c) Feross Aboukhadijeh.