https://github.com/airbnb/ts-migrate

A tool to help migrate JavaScript code quickly and conveniently to TypeScript
https://github.com/airbnb/ts-migrate

codemod javascript migration typescript

Last synced: 5 days ago
JSON representation

A tool to help migrate JavaScript code quickly and conveniently to TypeScript

• Host: GitHub
• URL: https://github.com/airbnb/ts-migrate
• Owner: airbnb
• License: mit
• Created: 2019-12-05T23:36:40.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-21T22:46:58.000Z (about 1 year ago)
• Last Synced: 2024-05-21T03:15:27.642Z (6 months ago)
• Topics: codemod, javascript, migration, typescript
• Language: TypeScript
• Homepage:
• Size: 1.23 MB
• Stars: 5,316
• Watchers: 45
• Forks: 218
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome-github-star - ts-migrate
• jimsghstars - airbnb/ts-migrate - A tool to help migrate JavaScript code quickly and conveniently to TypeScript (TypeScript)

README

        
# ts-migrate

*ts-migrate* is a tool for helping migrate code to TypeScript.

It takes a JavaScript, or a partial TypeScript, project in and gives a compiling TypeScript project out.

*ts-migrate* is intended to accelerate the TypeScript migration process. The resulting code will pass the build, but a followup is required to improve type safety. There will be lots of `// @ts-expect-error`, and `any` that will need to be fixed over time. In general, it is a lot nicer than starting from scratch.

*ts-migrate* is designed as a set of plugins so that it can be pretty customizable for different use-cases. Potentially, more plugins can be added for addressing things like improvements of type quality or libraries-related things (like prop-types in React).

Plugins are combined into migration configs. We currently have two main migration configs:

* for the main JavaScript → TypeScript migration

* for the reignore script

These configs can be moved out of the default script, and people can add custom configs with a different set of plugins for their needs.

You can find instructions on how to install and run ts-migrate in the [main package](./packages/ts-migrate/). If you find any [issues](https://github.com/airbnb/ts-migrate/issues) or have ideas for improvements, we welcome your [contributions](https://github.com/airbnb/ts-migrate/blob/master/CONTRIBUTING.md)!

Check out the [blog post](https://medium.com/airbnb-engineering/ts-migrate-a-tool-for-migrating-to-typescript-at-scale-cd23bfeb5cc) about ts-migrate!

# Published Packages

| Folder | Version | Package |

| ------ | ------- | ------- |

| [packages/ts-migrate](./packages/ts-migrate/) | [![npm version](https://badge.fury.io/js/ts-migrate.svg)](https://badge.fury.io/js/ts-migrate) | [ts-migrate](https://www.npmjs.com/package/ts-migrate) |

| [packages/ts-migrate-plugins](./packages/ts-migrate-plugins/) | [![npm version](https://badge.fury.io/js/ts-migrate-plugins.svg)](https://badge.fury.io/js/ts-migrate-plugins) | [ts-migrate-plugins](https://www.npmjs.com/package/ts-migrate-plugins) |

| [packages/ts-migrate-server](./packages/ts-migrate-server/) | [![npm version](https://badge.fury.io/js/ts-migrate-server.svg)](https://badge.fury.io/js/ts-migrate-server) | [ts-migrate-server](https://www.npmjs.com/package/ts-migrate-server) |

# Unpublished Packages

| Folder | Description |

| ------ | -----------|

| [packages/ts-migrate-example](./packages/ts-migrate-example/) | basic example of usage of the ts-migrate-server with a writing a custom simple plugin |

# Authors

  

    

      

        

        


        Brie Bunge

      

      

        

        


        Sergii Rudenko

      

      

        

        


        John Haytko

      

      

        

        


        Elliot Sachs

      

      

        

        


        Joe Lencioni

     

  

# License

MIT, see [LICENSE](https://github.com/airbnb/ts-migrate/blob/master/LICENCE) for details.