Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 3.61 KB

CHANGELOG.md

File metadata and controls

76 lines (57 loc) · 3.61 KB

Changelog

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

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning with regard to the command-line interface, the format of the precommit.py file, and the APIs documented in the README.

NOTE: As allowed by Semantic Versioning, backwards compatibility is not guaranteed until version 1.0 is released.

Numbers in parentheses after entries refer to issues in the GitHub issue tracker.

[0.7.1] - 2025-01-04

  • Bug fix: iprecommit erroneously examined newly-created untracked files, even when the --unstaged flag was not passed.

[0.7.0] - 2024-12-13

  • Bug fix: Installation process is more robust.

[0.6.3] - 2024-12-03

  • Bug fix: Negative filters (e.g., ["!*.md"]) now work correctly.
  • iprecommit run and iprecommit fix now take a --skip flag to optionally skip checks. You can also set skip = true in precommit.toml.
  • iprecommit run takes an optional --fail-fast flag.
  • autofix can be specified in precommit.toml on a per-check basis.

[0.6.2] - 2024-12-03

  • Bug fix: deleted files are no longer passed to commands for iprecommit run --all.
  • Bug fix: iprecommit run --unstaged now considers untracked files as well as tracked files with unstaged changes.

[0.6.1] - 2024-12-01

  • fail_fast option added to TOML.

[0.6.0] - 2024-12-01

  • autofix option added to TOML.
  • iprecommit-commit-msg-format now correctly ignores diffs in commit messages.
  • iprecommit-commit-msg-format now prints correct line numbers.
  • iprecommit-newline-at-eof now has a --fix option.
  • Program output tweaked (e.g., one blank line instead of two between blocks).

[0.5.2] - 2024-11-28

  • working_dir option for pre_commit checks
  • Check command stderr output is piped to stdout.
  • --all flag for iprecommit run and iprecommit fix
  • Git hooks are replaced atomically instead of overwritten in place.

[0.5.1] - 2024-11-28

  • The IPRECOMMIT_TOML_TEMPLATE environment variable can be used to customize the precommit.toml template.
  • iprecommit fix will stage changes to files after a fix command modifies them.
  • iprecommit-* commands now ignore files they cannot parse as UTF-8.

[0.5.0] - 2024-11-28

  • Config format changed from Python (precommit.py) to TOML (precommit.toml).

[0.4.0] - 2024-11-28

  • Main interface in precommit.py is now called Checks and has a different API than Pre.
  • Pure Python checks are no longer supported. All checks must be external shell commands.
  • The iprecommit package now includes a set of extra commands: iprecommit-commit-msg-format, iprecommit-newline-at-eof, and iprecommit-no-forbidden-strings

[0.3.1] - 2024-09-30

More API updates.

[0.3.0] - 2024-09-23

API redesigned, again.

[0.2.2] - 2024-08-15

  • PythonBlack() check is added.
  • NO_COLOR environment variable is respected.

[0.2.1] - 2024-08-15

  • Precommit.check and Precommit.command take pattern and exclude parameters to control what files the checks run on.
  • The iprecommit init command is introduced, to initialize a new pre-commit script from scratch.
  • iprecommit run and iprecommit fix now default to operating on both staged and unstaged changes. The --unstaged flag is removed. For the old behavior, pass --staged.
  • User is warned about misconfigured environment variables.
  • README is updated to reflect the new API.

[0.2] - 2024-08-15

Completely redesigned CLI and Python API.

[0.1.1] - 2022-07-10

First official release