Add linter: toml-tidy#1149
Open
AndrewDongminYoo wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds toml-tidy as a TOML formatter: it sorts keys within each table (and sibling table declarations) while preserving table hierarchy, comments, and source formatting via tomlkit.
Why
It complements the existing
taplointegration (whitespace/style formatting) rather than replacing it — the relationship mirrorsprettier+sort-package-jsonforpackage.json, which this repo already ships. Sorted TOML keeps files likepyproject.tomldiff-friendly and merge-conflict-resistant.Definition notes
runtime: python/ PyPI package, following theblack/isortpattern — no binary downloads to maintain.suggest_if: never— key sorting is an opinionated choice, so it stays opt-in.affects_cache: [pyproject.toml]— per-file defaults live in[tool.toml-tidy].python@3.12.2, and the test pins it viapreCheck— same pattern as ktlint's jdk pin.Testing
npm test linters/toml-tidy— passes; fmt snapshot generated forknown_good_version0.2.0. The fixture exercises key sorting with comment attachment, natural numeric ordering (item2<item10), sibling-table sorting, and array-of-tables element-order preservation.npm test tests/repo_tests/readme_inclusion.test.ts— passes (README table updated).