0.0.0-alpha ā¢ Published 8 months ago
ts-enhance v0.0.0-alpha
Usage
ts-enhance
is a CLI tool that iteratively improves TypeScript types in existing code.
It can:
- Add type annotations to fix
noImplicitAny
andnoImplicitThis
type errors - Annotate missing
null
s andundefined
s to fixstrictNullChecks
type errors - Remove unnecessary annotations for types that can be inferred
- Remove unnecessary constituents and members of union types and object types
ā” To start, the ts-enhance
command will launch an interactive guide to setting up a configuration file. ā”
npx ts-enhance
š Welcome to ts-enhance! š This will create a new ts-enhance.json for you. ...
After, use ts-enhance --config ts-enhance.json
to convert your files with the same settings.
Configuration
To get a deeper understanding of ts-enhance
, read the following docs pages in order:
- Usage.md for an explanation of how
ts-enhance
works - Fixes.md for the type of fixes
ts-enhance
will generate mutations for - Cleanups.md for the post-fix cleaning
ts-enhance
may apply to files - Types.md for configuring how to work with types in mutations
- Filters.md for using tsquery to ignore sections of source files
- Custom Mutators.md for including or creating custom mutators
Development
See Development.md. š
š This package is based on @JoshuaKGoldberg's create-typescript-app.
0.0.0-alpha
8 months ago