Skip to content

Latest commit

 

History

History
182 lines (124 loc) · 5.84 KB

CHANGELOG.md

File metadata and controls

182 lines (124 loc) · 5.84 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

0.8.0 - 2024-02-21

Added in 0.8.0

  • Support for Kotlin was added.

Fixed in 0.8.0

  • The --exclude-dir option now ignores trailing path separators (#1463)
  • The --output flag defaults to github when todos is run on GitHub Actions (#1459).

Removed in 0.8.0

0.7.0 - 2023-12-01

Added in 0.7.0

0.6.0 - 2023-09-23

Added in 0.6.0

Fixed in 0.6.0

  • All TODOs in a multi-line comment are now reported (#721).

Changed in 0.6.0

  • The language of each file is now determined by it's file name in most circumstances allowing for much faster language detection.

0.5.0 - 2023-09-04

Added in 0.5.0

  • Support for Erlang, Haskell, R, and SQL programming languages has been added.

  • A new exclude-dir flag was added to todos that allows for excluding matching directories from the search.

  • TODO comments are matched more loosely with more delimeters such as '/' or '-' in addition to ':' being recognized.

  • A new --charset flag was added which defaults to UTF-8. This is the character set used to read the code files. A special name of detect specifies that the character set of each file should be detected.

  • Support was added for TODO comments with no space between the comment start and "TODO" marker and no delimiter.

    //TODO Add some code here.

  • Support was added for TODO comments in JavaDoc/JSDoc/TSDoc that had a * prefix.

    /**
 * Some comment.
 * TODO: Add some code here.
 */

Changed in 0.5.0

  • todos no longer detects character encodings by default and now defaults to reading files as UTF-8. Character detection can be enabled by using the --charset=detect flag.

0.4.0 - 2023-08-23

Added in 0.4.0

  • The todos CLI now supports a new JSON output format.
  • A new issue-reopener GitHub action was added that uses the todos CLI to scan a repository checkout for TODOs referencing a GitHub issue and reopen issues that have been prematurely closed.

Removed in 0.4.0

  • The github-issue-reopener binary was removed in favor of the issue-reopener action.

0.3.0 - 2023-08-19

Added in 0.3.0

  • Support for Rust was added.
  • Support for Unix assembly language was added.
  • Support for Lua was added.
  • A new github-issue-reopener binary was added. This tool will scan a directory for TODOs referencing a GitHub issue and reopen issues that have been prematurely closed.

Changed in 0.3.0

  • Lowercase "Todo", "todo", "Fixme", "fixme", "Hack", "hack" were added as default TODO types.

0.2.0 - 2023-06-30

Changed in 0.2.0

  • Leading whitespaces is now trimmed from TODOS in multi-line comments.
  • The --include-hidden option was replaced with the --exclude-hidden option and including hidden files was made the default.
  • An --include-vcs option was added and the VCS directories .git, .hg, and .svn are skipped by default.

Fixed in 0.2.0

  • Hidden, Vendored, and Docs files are now properly excluded by default.

Removed in 0.2.0

  • The --include-docs option was removed.

0.1.0 - 2023-05-24

Added in 0.1.0

  • Added a --todo-types flag which allows users to specify the TODO tags to search for.

Changed in 0.1.0

  • TODOs matched in multi-line comments no longer print the entire comment. Only the line containing the TODO is printed. Line numbers printed also correspond to the line where the TODO occurs rather than the starting line of the comment.
  • Filenames and line numbers are now colored in the terminal if it supports it.
  • Hidden files are now supported properly on Windows.

Fixed in 0.1.0

  • TODOs are no longer matched when starting in the middle of a comment line.

0.0.1 - 2023-05-15

Added in 0.0.1

  • Initial release of todos CLI application.
  • Simple support for scanning directories for TODO/FIXME/BUG/HACK/XXX comments.