Skip to content

collection of eslint rules needed to ensure @labset open-source packages are structured in a consistent way.

License

Notifications You must be signed in to change notification settings

viqueen/eslint-plugin

Repository files navigation

eslint-plugin

Quality Gate Status npm version

A collection of eslint rules needed to ensure labset open-source packages are structured in a consistent way.

It comes with:

  • license-notice rule to enforce all source files include the relevant license header notice

install it

  • with npm
npm install @labset-eslint/eslint-plugin --save-dev
  • with yarn
yarn add @labset-eslint/eslint-plugin -D -W

use it

  • add the eslint plugin to your .eslintrc.js
module.exports = {
    ...,
    plugins: [
        '@labset-eslint/eslint-plugin',
    ],
    rules: {
        '@labset-eslint/license-notice': [
            'error', {
                license: 'Apache-2.0',
                copyRightYear: '<year>',
                copyRightName: '<name>'
            }
        ]
    }
}