ESLint rules for Jasmine
JavaScript VimL

README.md

eslint-plugin-jasmine

Build Status npm version License

ESLint rules for Jasmine

Usage

  1. Install eslint-plugin-jasmine as a dev-dependency:

    npm install --save-dev eslint-plugin-jasmine
  2. Enable the plugin by adding it to your .eslintrc:

    plugins:
      - jasmine

ESLint itself provides a Jasmine environment for Jasmine's global variables. It's therefore recommended to also enable it in your .eslintrc:

plugins:
  - jasmine
env:
  jasmine: true

By default, no rules are enabled. See the next section for more.

Configuration

This plugin exports a recommended configuration that enforces good practices.

To enable this configuration, use the extends property in your .eslintrc config file:

plugins:
  - jasmine
env:
  jasmine: true
extends: 'plugin:jasmine/recommended'

See the ESLint config docs for more information about extending configuration files.

Rules

Rule Recommended Options
named-spy 0
no-focused-tests 2
no-disabled-tests 1
no-suite-dupes 1, 'block' ['block', 'branch']
no-spec-dupes 1, 'block' ['block', 'branch']
missing-expect 0, 'expect()' expectation function names
no-suite-callback-args 2
valid-expect 1
no-assign-spyon 0
no-unsafe-spy 1
no-global-setup 2
no-expect-in-setup-teardown 1, 'expect()' expectation function names

For example, using the recommended configuration, the no-focused-tests rule is enabled and will cause ESLint to throw an error (with an exit code of 1) when triggered.

You may customise each rule by adding a value in your .eslintrc rules property:

plugins:
  - jasmine
env:
  jasmine: true
rules:
  jasmine/no-focused-tests: 0
  jasmine/no-suite-dupes:
    - 2
    - branch

See configuring rules for more information.

Author

© 2016 Tom Vincent git@tlvince.com and contributors.

License

Released under the MIT license.