tslint-no-unused-expression-chai

tslint-no-unused-expression-chai

From tslint 5, lint applies no-unused-expression more strictly. This affects test assertion written via chai, as its expect assertion is form of expression caught by lint. tslint-no-unused-expression-chai provides drop-in replacement of rule no-unused-expression to loosen lint checker for chai's assertion.

This module supports chai's expect based assertion (i.e expect(x).to.be....). When adding "should" to the rule configuration, it also supports those assertios. Other type of property based assertion still may not work.

Install

This has a peer dependencies of tslint@5.*.* and implicit dependency of typescript, which will have to be installed as well

npm install --save-dev tslint-no-unused-expression-chai

Usage

You can configure tslint rules by replacing existing no-unused-expression rule.

"rules": {
  //accepts all options of https://palantir.github.io/tslint/rules/no-unused-expression/
  "no-unused-expression-chai": true
  ...
},
"rulesDirectory": [
  "tslint-no-unused-expression-chai"
  ...
]

Alternatively you can just extend the configuration preset provided by this package. It disables no-unused-expression and enables no-unused-expression-chai.

"extends": [
  ...
  "tslint-no-unused-expression-chai"
]

Building / Testing

Few npm scripts are supported for build / test code. As this rule is simple override to default rules, it doesn't have own unit test coverage but borrows test fixture from original rule.

• build: Transpiles code to ES5 commonjs to rules.
• test: Run tests.
• lint: Run lint over all codebases
• lint:staged: Run lint only for staged changes. This'll be executed automatically with precommit hook.
• commit: Commit wizard to write commit message

Changelog

0.1.4 (2018-10-03)

Bug Fixes

• noUnusedExpressionChaiRule: corrected ruleName in metadata (692ce5b), closes kwonoj/tslint-no-unused-expression-chai#17 #17
• package: bump up dependencies (40911fd)

BREAKING CHANGES

• package: drop support for node.js <= 5

<a name="0.1.3"></a>