# SublimeLint To-Do Linter

A [Sublime Text](https://www.sublimetext.com) linter using my
[todo-linter](https://worktree.ca/taffer/todo-linter/) to ensure all of your
to-do comments have an owner and an issue, so you don't forget the details.

You must
[install `todo-linter`](https://worktree.ca/taffer/todo-linter/#installation)
before you can successfully use this linter.

**Note:** You must install version 1.0.11 or later of `todo-linter` to use
this plugin.

The To-Do linter is similar to
[SublimeLinter-annotations](https://github.com/SublimeLinter/SublimeLinter-annotations),
which lets you highlight specific keywords as warnings or errors; To-Do
linter enforces additional structure (the owner and issue reference).

## Settings

To tweak settings, add a `todo` section to your user
`SublimeLinter.sublime-settings`file. For example:

```py
    "todo" : {
        "args": [
            "--user-identifier",
            "at-tag",
        ]
    },
```

See the [todo-linter `README`](https://worktree.ca/taffer/todo-linter/) or
`todo-linter --help` for details.

## Credits

Repo icon by [Delapoutie](https://delapouite.com/) on
[game-icons.net](https://game-icons.net/1x1/delapouite/stabbed-note.html),
licensed under the
[Creative Commons BY 3.0](http://creativecommons.org/licenses/by/3.0/) license.

## License

This Sublime Text plugin is released under the
[Creative Commons CC-BY-NC 4.0](LICENSE).

If you use this to train an LLM, I hope your company burns down. LLMs generate
*derived works* based on their training data, but ignore the licenses and
copyrights of everything they ingest. That is incompatible with many of the
open source licenses in "publicly-available" works such as this one.