#formatter #linter #parser

biome_formatter

Biome's formatter shared infrastructure

7 releases (4 breaking)

0.5.7 Mar 12, 2024
0.5.5 Mar 12, 2024
0.4.0 Jan 9, 2024
0.3.1 Nov 26, 2023
0.0.2 Sep 28, 2023

#2219 in Development tools

Download history 33/week @ 2024-07-02 86/week @ 2024-07-09 415/week @ 2024-07-16 2858/week @ 2024-07-23 3408/week @ 2024-07-30 2095/week @ 2024-08-06 1760/week @ 2024-08-13 1643/week @ 2024-08-20 1577/week @ 2024-08-27 1707/week @ 2024-09-03 1692/week @ 2024-09-10 1666/week @ 2024-09-17 1983/week @ 2024-09-24 1616/week @ 2024-10-01 1941/week @ 2024-10-08 1576/week @ 2024-10-15

7,469 downloads per month
Used in 5 crates

MIT/Apache

1.5MB
27K SLoC

Biome - Toolchain of the web

Discord chat CI cargo version

biome_formatter

Biome's formatter implementation. Follow the documentation.


lib.rs:

Infrastructure for code formatting

This module defines [FormatElement], an IR to format code documents and provides a mean to print such a document to a string. Objects that know how to format themselves implement the [Format] trait.

Formatting Traits

  • [Format]: Implemented by objects that can be formatted.
  • [FormatRule]: Rule that knows how to format an object of another type. Necessary in the situation where it's necessary to implement [Format] on an object from another crate. This module defines the [FormatRefWithRule] and [FormatOwnedWithRule] structs to pass an item with its corresponding rule.
  • [FormatWithRule] implemented by objects that know how to format another type. Useful for implementing some reusable formatting logic inside of this module if the type itself doesn't implement [Format]

Formatting Macros

This crate defines two macros to construct the IR. These are inspired by Rust's fmt macros

  • format!: Formats a formatable object
  • format_args!: Concatenates a sequence of Format objects.
  • write!: Writes a sequence of formatable objects into an output buffer.

Dependencies

~10–19MB
~256K SLoC