tslint-plugin-jasmine

> TSLint rules for Jasmine

Usage

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

``shell
npm install --save-dev tslint-plugin-jasmine
`

2. Enable the rules by adding it to your tslint.json:

`json
{
"extends": [
// ...other rules
"tslint-plugin-jasmine"
],
"rules": {
// enable/disable rules
}
}
`

$3

No rules are enabled by default. You can use the recommended configuration:

Rule | Recommended | Options
---- | ----------- | -------
[expect-matcher][] | { "severity": "warning" } |
[expect-single-argument][] | { "severity": "warning" } |
[missing-expect][] | { "severity": "off", "options": ["expect()", "expectAsync()"] } | expectation function names
[named-spy][] | { "severity": "off" } |
[new-line-before-expect][] | { "severity": "warning" } |
[new-line-between-declarations][] | { "severity": "warning" } |
[no-assign-spyon][] | { "severity": "off" } |
[no-describe-variables][] | { "severity": "off" } |
[no-disabled-tests][] | { "severity": "warning" } |
[no-expect-in-setup-teardown][] | { "severity": "warning", "options" ["expect()", "expectAsync()"] } | expectation function names
[no-focused-tests][] | { "severity": "error" } |
[no-global-setup][] | { "severity": "error" } |
[no-promise-without-done-fail][] | { "severity": "warning" } |
[no-spec-dupes][] | { "severity": "warning" } | 'branch'
[no-suite-callback-args][] | { "severity": "error" } |
[no-suite-dupes][] | { "severity": "warning" } | 'branch'
[no-unsafe-spy][] | { "severity": "warning" } |
[prefer-jasmine-matcher][] | { "severity": "warning" } |
[prefer-to-have-been-called-with][] | { "severity": "warning" } |


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

[expect-matcher]: docs/rules/expect-matcher.md
[expect-single-argument]: docs/rules/expect-single-argument.md
[missing-expect]: docs/rules/missing-expect.md
[named-spy]: docs/rules/named-spy.md
[new-line-before-expect]: docs/rules/new-line-before-expect.md
[new-line-between-declarations]: docs/rules/new-line-between-declarations.md
[no-assign-spyon]: docs/rules/no-assign-spyon.md
[no-describe-variables]: docs/rules/no-describe-variables.md
[no-disabled-tests]: docs/rules/no-disabled-tests.md
[no-expect-in-setup-teardown]: docs/rules/no-expect-in-setup-teardown.md
[no-focused-tests]: docs/rules/no-focused-tests.md
[no-global-setup]: docs/rules/no-global-setup.md
[no-promise-without-done-fail]: docs/rules/no-promise-without-done-fail.md
[no-spec-dupes]: docs/rules/no-spec-dupes.md
[no-suite-callback-args]: docs/rules/no-suite-callback-args.md
[no-suite-dupes]: docs/rules/no-suite-dupes.md
[no-unsafe-spy]: docs/rules/no-unsafe-spy.md
[valid-expect]: docs/rules/valid-expect.md
[prefer-jasmine-matcher]: docs/rules/prefer-jasmine-matcher.md
[prefer-to-have-been-called-with]: docs/rules/prefer-to-have-been-called-with.md

License

Released under the MIT license.