# @lint-todo/migrator

> A migration tool for lint todos

Latest version **1.0.3** (published 2021-12-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lint-todo/migrator
pnpm add @lint-todo/migrator
yarn add @lint-todo/migrator
bun add @lint-todo/migrator
```

Provides the command `migrator`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-12-03 |
| First published | 2021-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 269.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | scalvert |
| Maintainers | scalvert |

## Links

- npm: https://www.npmjs.com/package/@lint-todo/migrator
- Repository: https://github.com/lint-todo/migrator
- Homepage: https://github.com/lint-todo/migrator#readme
- Issues: https://github.com/lint-todo/migrator/issues
- npm.io page: https://npm.io/package/@lint-todo/migrator

## Dependencies (5)

- [meow](https://npm.io/package/meow.md) ^9.0.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [log-symbols](https://npm.io/package/log-symbols.md) ^4.0.0
- [@lint-todo/utils](https://npm.io/package/@lint-todo/utils.md) ^11.0.0
- [legacy-todo-utils](https://npm.io/package/legacy-todo-utils.md) npm:@ember-template-lint/todo-utils@10.0.0

## Recent versions

- 1.0.3 (latest) — 2021-12-03
- 1.0.2 — 2021-12-03
- 1.0.1 — 2021-12-03
- 1.0.0 — 2021-12-03

## README

# @lint-todo/migrator

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

## Usage

```bash
  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:

```bash
npx @lint-todo/migrator .
```

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

```bash
✔ 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.

```bash
⚠ 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.

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

### Options

```bash
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 `ember-template-lint@3.6.0` or later and `@scalvert/eslint-formatter-todo@1.4.0` or later).

## License

This project is licensed under the [MIT License](LICENSE).

---
_Source: https://npm.io/package/@lint-todo/migrator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._