commover

Batch remove unused @ts-expect-error directive comment lines, especially helpful when using with ts-migrate.

What does commover mean? It's a composite word that represents comment remover ahahaha :)

Motivation

ts-migrate is such an useful tool that helps us fix historical TS errors incrementally in our projects. But sometimes it's not perfect as well for some reason. There're lots of unused @ts-expect-error directive added to the code, which causes TS compile errors.

error TS2578: Unused '@ts-expect-error' directive

This project is designed for this, which will read your compile log, parse and remove the corresponding lines.

Usage

Global install the tool with pnpm first.

pnpm install -g commover # or npm/yarn

Compile ts, output a log file, and then call commover command with the file.

tsc --noEmit > tsc.log # or tsc -b, output compile log to `tsc.log`
commover tsc.log # will read `tsc.log` and handle parsed errors as need

Options

> commover -h     
Usage: commover [options] <path>

Batch remove unused @ts-expect-error comments, especially helpful when using with ts-migrate.

Arguments:
  path           Path to the ts compile log.

Options:
  -V, --version  output the version number
  -h, --help     display help for command

License

MIT License © 2024 秦旭洋