v0.4.0 - Exquisite Elm - 2024-05-15

Release Notes

Full list of changes

Added

• #589 Added syntax highlighting to the playground (excluding Nickel)
• #686 Added support for Nickel pattern formatting
• #697 Setting the log level to INFO now outputs the pattern locations in a (row, column) way.
• #699 Added support for CSS, thanks to @lavigneer

Fixed

• #626 #627 #628 #626 Various OCaml improvements
• #673 Various TOML fixes
• #678 Ensures the client example project builds, and is tested in CI
• #677 Ensures our playground builds consistently in CI
• #682 Removes prepended linebreaks from equal signs in Nickel annotations
• #692 Improves our installation instructions, thanks to @Jasha10

Changed

• #664 Ensures source positions in the logs are consistent thanks to @evertedsphere
• #668 Updates our Nickel grammar
• #672 Completely refactors our crate layout, preparing for a release on crates.io

topiary-cli 0.4.0

Install topiary-cli 0.4.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/tweag/topiary/releases/download/v0.4.0/topiary-cli-installer.sh | sh

Download topiary-cli 0.4.0

File	Platform	Checksum
topiary-cli-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
topiary-cli-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
topiary-cli-x86_64-pc-windows-msvc.zip	x64 Windows	checksum
topiary-cli-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum

v0.3.0 - Dreamy Dracaena - 2023-09-22

Release Notes

Full list of changes

Added

• #538 Using cargo-dist to release Topiary binaries.
• #528 #609 Created a topiary-queries crate that exports the builtin query files.
• #526 Multi-line comments can be indented properly using the new predicate @multi_line_indent_all.
• #533 Topiary can now process multiple files with one call.
• #553 In Nickel, indent when a new infix_expr chain starts.
• #557 Topiary now falls back to the buildin queries when no other query files could be located.
• #573 Added OCamllex support (without injections).
• #576 Added append/prepend versions of scope captures.

Changed

• #535 Improved error message when idempotency fails due to invalid output in the first pass.
• #576 Allows prepending/appending @begin_scope and @end_scope
• #583 Modernisation of the command line interface (see the CLI Migration Guide, for details)
• #535 Change the error message for an idempotency error to be more descriptive.
• #536 #537 #578 #626 #627 #628 Various OCaml improvements.
• #623 #624 #625 Various Toml improvements thanks @pjjw.

Fixed

• #533 Bump tree-sitter-ocaml version, which allowed reintroduction of some removed queries.
• #550 Fixed handling of antispace in post-processing.
• #552 Fixed Nickel tag removal.
• #554 #555 Fixed Nickel idempotency issue related to annotations.
• #565 Fixed an issue where Topiary would remove whitespace between predicate parameters in query files.

Install topiary-cli 0.3.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/tweag/topiary/releases/download/v0.3.0/topiary-cli-installer.sh | sh

Install prebuilt binaries via powershell script

irm https://github.com/tweag/topiary/releases/download/v0.3.0/topiary-cli-installer.ps1 | iex

Download topiary-cli 0.3.0

target	kind	download
aarch64-apple-darwin	tarball	topiary-cli-aarch64-apple-darwin.tar.xz
x86_64-apple-darwin	tarball	topiary-cli-x86_64-apple-darwin.tar.xz
x86_64-pc-windows-msvc	tarball	topiary-cli-x86_64-pc-windows-msvc.zip
x86_64-unknown-linux-gnu	tarball	topiary-cli-x86_64-unknown-linux-gnu.tar.xz

v0.2.3 - Cyclic Cypress - 2023-06-20

Full list of changes

Added

• #513 Added the -t, --tolerate-parsing-errors flags to Topiary, tolerate_parsing_errors to the Format
  operation of the library, and a "Tolerate parsing errors" checkmark to the
  playground. These options make Topiary ignore errors in the parsed file, and
  attempt to format it.
• #506 Allows the users to
  configure Topiary through a user-defined configuration file. More information
  can be found in the README.md.

Changed

• #523 Skips rebuilding the tree-
  sitter Query when performing the idempotence check. This improves performance
  when not skipping the idempotence check by about 35% for OCaml formatting.

Removed

• #508 Simplified language
  detection by treating ocaml and ocaml_interface as two distinct languages.
  This ensures we only have one grammar per language. This
  removed the -l ocaml_implementation flag from Topiary and the
  SupportedLanguage::OcamlImplementation from the library.

Fixed

• #522 Reverted the bump to the
  OCaml grammar and queries. This bump (for as of yet unknown reasons) had a
  catastrophic impact on Topiary's performance.

v0.2.2 - Cyclic Cypress - 2023-06-12

Full list of changes

Added

• #498 Updated the playground to include a nicer editor.
• #487 Added a flag to format function that allows skipping the idempotency check.
• #486 Added the processing time to the online playground.
• #484 Enabled the playground to perform on-the-fly formatting.
• #480 Shows which languages are marked as experimental in the playground.

Changed

• #490 Bumped the Nickel grammar.
• #494 Bumped the OCaml grammar, and fixed for the renamed infix_operator named node.

Fixed

• #493 Fixed #492 by only trimming newlines in prettyprinting.
• #491 Fixed #481, a SIGSEGV in exhaustivity testing.

v0.2.1 - Cyclic Cypress - 2023-05-23

Full list of changes

Fixed

• Correctly bumped version number in Cargo.toml.

v0.2.0 - Cyclic Cypress - 2023-05-22

Full list of changes

Added

• Topiary website, web-based playground and logos.
• Full Nickel formatting support.
• Improved OCaml formatting support.
• @append_antispace and @prepend_antispace formatting capture names.
• WASM build target, for the web-based playground.
• Arbitrary whitespace indentation support.
• Exhaustive query checking in tests.
• Maintain a CHANGELOG and a documented release process.

Changed

• Move to a build configuration file, rather than a mixture of hardcoding and parsing query predicates at runtime.
• Conditional predicates, in the query language, to reduce the number of formatting capture names.
• Higher fidelity exit codes.
• Idempotency check in terminal-based playground.
• Reduced verbosity of failed integration test output.
• Various improvements to the test suite.
• Idiomatic improvements to the Rust codebase.
• Restructured repository into a Cargo workspace.

Fixed

• OCaml idempotency issues.
• Idempotency checking in integration tests.
• Don't process queries that match below leaf nodes.
• Skip over zero-byte matched nodes.

v0.1.0 - Benevolent Beech - 2023-03-09

Full list of changes

This first public release focuses on the Topiary engine and providing decent OCaml formatting support, with the formatting capture names required to do so.

Formatting Capture Names

• @allow_blank_line_before
• @append_delimiter / @prepend_delimiter
• @append_multiline_delimiter / @prepend_multiline_delimiter
• @append_empty_softline / @prepend_empty_softline
• @append_hardline / @prepend_hardline
• @single_line_no_indent
• @append_indent_start / @prepend_indent_start
• @append_indent_end / @prepend_indent_end
• @append_input_softline / @prepend_input_softline
• @append_space / @prepend_space
• @append_spaced_softline / @prepend_spaced_softline
• @delete
• @singleline_delete
• @do_nothing
• @begin_scope / @end_scope and scoped softlines

Language Support

• OCaml (implementations and interfaces)
• JSON
• TOML
• Nickel (experimental)
• Bash (experimental)
• Tree-sitter query language (experimental)
• Rust (experimental)

Miscellaneous

• Basic formatter authoring tools (terminal-based playground and tree visualisation)
• pre-commit-hooks.nix support

Full Changelog: v0.0.1-prototype...v0.1.0

v0.0.1-prototype - Archetypal Aspen - 2022-06-14

Full list of changes

This prototype release was created exclusively to show the validity of the idea of using tree-sitter to build a formatter. It includes only a prototype JSON formatter.