Convert tests to use RuleTester instead of --report-unused-disable-directives #31
Conversation
…rectives The RuleTester provides the ability to assert on specific error messages and fixes that rules produce. It's also more in line with how the upstream projects (eslint and typescript-eslint) test their rules, which will smooth the process if we decide to upstream these rules. The tests for (and changes to) no-meaningless-void-operator are changes I made based on feedback on my typescript-eslint PR: typescript-eslint/typescript-eslint#3641
configs/typescript.example.ts
Outdated
| @@ -1,5 +1,6 @@ | |||
| // Use --report-unused-disable-directives to validate errors | |||
There was a problem hiding this comment.
Renamed this file to .example.ts instead of .test.ts so it doesn't get run under jest, only linted.
| // eslint-disable-next-line @typescript-eslint/no-var-requires | ||
| const rule = require("./no-boolean-parameters") as TSESLint.RuleModule< |
There was a problem hiding this comment.
Using import I get errors because TS can't find a corresponding declaration file. In the future, we should convert the rules themselves to TypeScript and then we wouldn't need a separate declaration file. (I recall hearing they are currently .js because it allows us to easily use this package to lint itself... might need to look for alternate solutions there)
There was a problem hiding this comment.
we could just require a compile step before running the tests - shouldn't be too hard to set up.
other reasons they are in js aren't super valid:
- I think one original rule came from the studio repo where we didn't want to require a compile step
- when writing the triple equals rule I was just lazy because most example code was in JS
|
Cool, didn't know about RuleTester |
Public-Facing Changes
no-boolean-parameterscorrectly reports the function name in variable assignments likeconst x = (a: boolean) => {}no-meaningless-void-operatorno longer reports errors onnevervalues by default; addedcheckNeveroption to enable (imported these changes from feat(eslint-plugin): addno-meaningless-void-operatorrule typescript-eslint/typescript-eslint#3641)Description
The
RuleTesterprovides the ability to assert on specific error messages and fixes that rules produce. It's also more in line with how the upstream projects (eslint and typescript-eslint) test their rules, which will smooth the process if we decide to upstream these rules.The tests for (and changes to) no-meaningless-void-operator are changes I made based on feedback on my typescript-eslint PR: typescript-eslint/typescript-eslint#3641
Imported jest.config.js from template-typescript.