docs: refreshed docs and onboarded eslint-doc-generator #67
Conversation
| @@ -1,6 +1,17 @@ | |||
| # eslint-plugin-expect-type | |||
|
|
|||
| ESLint plugin with $ExpectType and $ExpectError type assertions | |||
| > ESLint plugin with `^?` Twoslash, `$ExpectError`, and `$ExpectType` type assertions. ✨ | |||
There was a problem hiding this comment.
Can be in a separate PR, but it would be helpful to include some background on why you might want to do type assertions (testing types) and specifically why you might want to do them in this way (string matching avoids vagaries of assignability and lets you test the display of types).
There was a problem hiding this comment.
Yeah a good idea. Linking here to #50 👍
| ``` | ||
|
|
||
| By running `eslint` snapshot type will be matched with actual type and Error will be emitted in case types don't match. | ||
| <!-- prettier-ignore-start --> |
There was a problem hiding this comment.
In case you wanted to avoid disabling prettier for this, there are a couple ways to solve this in:
Example:
There was a problem hiding this comment.
Ah thanks! I'll probably leave this as is for a bit, since it's less config for now. But this is good to know!
|
🎉 This is included in version v0.3.0 🎉 The release is available on: Cheers! 📦🚀 |
PR Checklist
status: accepting prsOverview
Brings in https://github.com/bmish/eslint-doc-generator and generally rewrites the
expect-type/expectrule's docs to be clear.Trims down the README.md by delegating configuration information to https://typescript-eslint.io/docs. Updates the list of
### Referencesto be current peers.Updates all devDependencies to the latest.