toml-sort

Fixed

• Error where the first override introduced tomlkit wrappers into the configuration and caused serialization problems for the dataclass: https://github.com/pappasam/toml-sort/pull/58

Added

• Ability to override sort configuration per key in configuration: https://github.com/pappasam/toml-sort/pull/52
• Option to sort particular keys first in output: https://github.com/pappasam/toml-sort/pull/53, updated by https://github.com/pappasam/toml-sort/pull/54

Fixed

• Issue where files that contain only comments are doubled: https://github.com/pappasam/toml-sort/pull/51

Fixed

• Trailing whitespace is no longer added to blank comments
• An issue where dotted keys raised a TypeError

Fixed

• Turns out that, at this time, toml-sort is only compatible with tomlkit 0.11.2+. We now make this clear in our dependencies. See: https://github.com/pappasam/toml-sort/issues/41 and https://github.com/sdispater/tomlkit/compare/0.11.1...0.11.2.

Added

• New pre-commit hook (toml-sort-fix) that enables users to change, instead of check, their toml files.

Fixed

• Issue where an IndexError exception was raised on an empty array. See: https://github.com/pappasam/toml-sort/pull/36

Release entirely related to this PR: https://github.com/pappasam/toml-sort/pull/33

Added

• Optionally add the ability to sort inline tables and arrays. New switches added for this functionality: --sort-inline-tables and --sort-inline-arrays, which are implied by the existing --all option
• New options groups to the CLI, to group the related formatting, comment, and sorting arguments
• Switch to add trailing comma to multi-line inline arrays --trailing-comma-inline-array
• Some additional formatting checks

Changed

• Make sure inline arrays and tables are consistently formatted
• Normalize the formatting for key = value pairs, always one space on either side of equals sign

This is a pretty big comment-related release. Resolves the long-standing issue: https://github.com/pappasam/toml-sort/issues/11.

Changed

• Header, Footer, and Block comments are retained by default and can be disabled with new CLI options.

Added

• New CLI comment-removal options: --no-comments, --no-header-comments, --no-footer-comments, --no-inline-comments, --no-block-comments
• The ability to configure spaces before inline comments with --spaces-before-inline-comment

Deprecated

• The CLI option: --no-header. This will be removed in a future release and is replaced by --no-header-comments

Fixed

• An issue where the sorter fails with boolean values in file. See https://github.com/pappasam/toml-sort/issues/29 and https://github.com/pappasam/toml-sort/pull/31

Fixed

• Preserve inline comments for boolean values. See: https://github.com/pappasam/toml-sort/pull/27

Added

• Support configuring cli with pyproject.toml configuration file.

Changed

• Moved CLI from click to argparse.
• Update minimum version of tomlkit to 0.8.0. This drops support for Python 3.6.

Added

• CLI option to ignore case while sorting

0.18.0

Note: in this release, we've discovered a strange bug (we believe in tomlkit) where, sometimes, AOT elements are ordered without our consent. One of the cli tests has been marked xfail. If you'd like to help figure out why, we're always looking for contributors!

Added

• Support for multiple FILENAME arguments in the CLI. Used for precommit / linting multiple files. Thanks @atugushev!
• Pre-commit hook

Changed

• Provide more-comprehensive error messages for interactive CLI usage.

Added

• This CHANGELOG.md

Changed

• tomlkit>=0.5.8. Upstream library made some important fixes.
• Add isort, make part of pre-commit pipeline

Fixed

• mypy, pylint, black, and isort all pass.

Removed

• AOT workaround in AOT parser. Latest version of tomlkit no longer spits out duplicate elements for AOT.

• --check: makes toml-sort usable as a linter. Will simply return non-zero status code if a file needs to be formatted. Now you can use this with pre-commit!
• --in-place: from the command line, you can now format a toml file in-place.

Not a functional release; just adds pypi shields to the readme.

Also, tidies up the containers special case, handling in one place
and simplifying the type interface to only be Item

An edge case involving AoT's returns a Container, not an Item, while recursing. This PR re-adds the Union[Item, Container] handling and adds a test for the case.

It also improves the README.

Add command line option to not print a document's leading comments.

Also, simplifies / shortens the help message (it was too long before)