chai-as-typed

動機

TypeScript は、プレーン JavaScript ファイルで 型チェック を実行できるようになりました。これは、魔法ではなく、JSDoc のよく構成された コメント に基づいています。

適切な JSDoc コメントが追加された JavaScript ファイルがあれば、Visual Studio Code などのエディタが、自動補完や型チェックを含む IntelliSense を自動的に取得できます。

しかし、モジュール API の型情報を確実に公開するには、テストが必要です。このプラグインは、プレーン JavaScript ファイルで型情報のチェック作業を容易にする特定のヘルパーを Chai に追加します。

使用方法

以下の行で始まる JavaScript ファイルがあるとします。

// @ts-check

以下のアサーションで、使用されている型が正しいことをテストできます。

expect('/absolute/path/to/filename.js').to.have.types.validated();

型エラーがある場合、型違反の位置を示すエラーがスローされます。

Error: /absolute/path/to/filename.js (Ln 5, Col 6): Argument of type '123' is not assignable to parameter of type 'string'

また、エラーが予想される場合は、以下でアサーションを使用してテストを行い、予想されるエラー数を示すことができます。

expect('/absolute/path/to/filename.js').to.have.types.errors(1);

インストールとセットアップ

npm install --save-dev chai-as-typed を実行し、

var chai = require('chai');
var chaiAsTyped = require('chai-as-typed');

chai.use(chaiAsTyped);

免責事項

このプラグインは実験段階です。慎重に使用して、フィードバックをお願いします。 :)