README.md

Typestep

Typestep aims to simplify the migration process from JavaScript to TypeScript in existing projects by offering a gradual transition strategy. It allows developers to introduce TypeScript incrementally by leveraging the parsing of TypeScript compiler output (tsc)

Usage

npm install typestep --save-dev

Warning

Do Not Use --pretty option with tsc

tsc > tsc-output.log

Config file

Init config file

Note

Init command will create your Typestep config file with all files from the tsc output marked as ignored

typestep init tsc-output.log

Or create your config file

// typestep.config.ts
import type { TypestepConfig } from 'typestep'

export default {
  ignoredFiles: ['src/main.ts'], // files to ignore
  fullOutput: false, // get full output errors (default: false)
} satisfies TypestepConfig

Run typestep

typestep run tsc-output.log