@lint-todo/migrator

Migration tool to migrate lint todo files from multi-file storage to single-file storage.

Usage

  A migration tool for lint todos

  Usage
    $ npx @lint-todos/migrator <working directory>

  Options
    --removeV1, -r  Remove v1 todos from migration

  Examples
    $ npx @lint-todos/migrator .
     ✔ Successfully migrated 10 todos to single file format

From within the project directory, run:

npx @lint-todo/migrator .

The number of todos migrated will be printed to the console.

✔ Successfully migrated 10 todos to single file format

If the project was already migrated to the new format, the tool will print to the console indicating this.

⚠ Skipped migration (.lint-todo file found)

If the project does not contain either a .lint-todo directory or lint-todo file, the tool will print to the console indicating this.

⚠ Skipped migration (no .lint-todo directory found)

Options

npx @lint-todo/migrator . --removeV1

The new single file storage format does not support Version 1 of the todo format. You can optionally remove all Version 1 todos and convert the remaining Version 2 todos to single-file format. Doing so will effectively convert the Version 1 todos back to error or warn severity, so you should only do this if you are OK with exposing those lint violations to the user.

You should ensure that all your todos are using the new format by regenerating them in Version 2 format (using [email protected] or later and @scalvert/[email protected] or later).

License

This project is licensed under the MIT License.