Skip to content

Converts JavaScript to TypeScript and TypeScript to better TypeScript. 🧫

License

Notifications You must be signed in to change notification settings

JoshuaKGoldberg/TypeStat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

TypeStat

Converts JavaScript to TypeScript and TypeScript to better TypeScript. 🧫

πŸ‘ͺ All Contributors: 12 🀝 Code of Conduct: Kept πŸ§ͺ Coverage πŸ“ License: MIT πŸ“¦ npm version πŸ’ͺ TypeScript: Strict

Usage

TypeStat is a CLI utility that modifies TypeScript types in existing code. The built-in mutators will only ever add or remove types and will never change your runtime behavior. TypeStat can:

  • ✨ Convert JavaScript files to TypeScript in a single bound!
  • ✨ Add TypeScript types on files freshly converted from JavaScript to TypeScript!
  • ✨ Infer types to fix --noImplicitAny and --noImplicitThis violations!
  • ✨ Annotate missing nulls and undefineds to get you started with --strictNullChecks!

⚑ To start, the typestat command will launch an interactive guide to setting up a configuration file. ⚑

npx typestat
πŸ‘‹ Welcome to TypeStat! πŸ‘‹
This will create a new typestat.json for you.
...

After, use typestat --config typestat.json to convert your files.

Configuration

To get a deeper understanding of TypeStat, read the following docs pages in order:

  1. Usage.md for an explanation of how TypeStat works
  2. Fixes.md for the type of fixes TypeStat will generate mutations for
  3. Cleanups.md for the post-fix cleaning TypeStat may apply to files
  4. Types.md for configuring how to work with types in mutations
  5. Filters.md for using tsquery to ignore sections of source files
  6. Custom Mutators.md for including or creating custom mutators

Development

See .github/CONTRIBUTING.md, then .github/DEVELOPMENT.md for general tooling documentation. For understanding the project, see ./docs in general, and especially ./docs/Architecture.md. Thanks! πŸ’–

Contributors

Beyang Liu
Beyang Liu

πŸ’»
Daniel Stiner
Daniel Stiner

πŸ›
Deleted user
Deleted user

🚧
Emerson
Emerson

πŸ’»
Girish Sontakke
Girish Sontakke

πŸ’»
Guten
Guten

πŸ›
Ibrahim H.
Ibrahim H.

πŸ’»
Josh Goldberg ✨
Josh Goldberg ✨

🚧 πŸ› πŸ”§ πŸ’» πŸš‡ πŸ“–
Mark Molinaro
Mark Molinaro

πŸ› πŸ’»
Nigel Gilbert
Nigel Gilbert

πŸ›
orionna319
orionna319

πŸ›
rubiesonthesky
rubiesonthesky

πŸ› 🚧 πŸ”§ πŸ’» ⚠️

πŸ’™ This package is based on @JoshuaKGoldberg's TypeStat.

About

Converts JavaScript to TypeScript and TypeScript to better TypeScript. 🧫

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published