Skip to content

Latest commit

 

History

History
53 lines (31 loc) · 1.68 KB

README.md

File metadata and controls

53 lines (31 loc) · 1.68 KB
Raw

ts-migrate-server

ts-migrate-server is a package that contains the main migration runner. ts-migrate-server is designed around Airbnb projects. Use at your own risk.

Install

Install ts-migrate-server using npm:

npm install --save-dev ts-migrate-server

Or yarn:

yarn add --dev ts-migrate-server

Usage

import path from 'path';
import { migrate, MigrateConfig } from 'ts-migrate-server';

// get input files folder
const inputDir = path.resolve(__dirname, 'input');

// create new migration config. You can add your plugins there
const config = new MigrateConfig();

// run migration
const exitCode = await migrate({ rootDir: inputDir, config });

process.exit(exitCode);

FAQ

How can I use ts-migrate-server?

You can take a look at basic usage example. Another resource would be source code of the ts-migrate cli.

Why not just use codemods?

You actually can use codemods in your plugins! ts-migrate-server provides a more standardized API around TypeScript compiler usage and allows us to use the benefits of the TypeScript APIs without complicated setup.

I have an issue with a specific plugin, what should I do?

Please file an issue here.

Contributing

See the Contributors Guide.