panache-cli 3.7.0__tar.gz → 3.8.0__tar.gz

{panache_cli-3.7.0 → panache_cli-3.8.0}/Cargo.lock

@@ -746,9 +746,9 @@ checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
 
 [[package]]
 name = "hermit-abi"
-version = "0.5.2"
+version = "0.5.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fc0fef456e4baa96da950455cd02c081ca953b141298e41db3fc7e36b1da849c"
+checksum = "e17592d60ebacc7d5e169f4663c5f84f9161cc90328abcfe8456f41e4dfcb284"
 
 [[package]]
 name = "icu_collections"
@@ -878,9 +878,9 @@ dependencies = [
 
 [[package]]
 name = "indexmap"
-version = "2.14.0"
+version = "2.14.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d466e9454f08e4a911e14806c24e16fba1b4c121d1ea474396f396069cf949d9"
+checksum = "07aa2048142242915a31d35844fb311e0e53fcca590c3a0a40dcf1b841fa09eb"
 dependencies = [
  "equivalent",
  "hashbrown 0.17.1",
@@ -1250,7 +1250,7 @@ checksum = "1a80800c0488c3a21695ea981a54918fbb37abf04f4d0720c453632255e2ff0e"
 
 [[package]]
 name = "panache"
-version = "3.7.0"
+version = "3.8.0"
 dependencies = [
  "annotate-snippets",
  "assert_cmd",
@@ -1295,7 +1295,7 @@ dependencies = [
 
 [[package]]
 name = "panache-formatter"
-version = "0.22.0"
+version = "0.23.0"
 dependencies = [
  "badness-formatter",
  "insta",
@@ -1315,7 +1315,7 @@ dependencies = [
 
 [[package]]
 name = "panache-parser"
-version = "0.28.0"
+version = "0.28.1"
 dependencies = [
  "badness-parser",
  "entities",

{panache_cli-3.7.0 → panache_cli-3.8.0}/Cargo.toml

@@ -9,7 +9,7 @@ authors = ["Johan Larsson <johan@jolars.co>"]
 
 [package]
 name = "panache"
-version = "3.7.0"
+version = "3.8.0"
 edition.workspace = true
 rust-version.workspace = true
 # `distill_quarto_schema` is a dev-only vendoring bin (src/bin/); keep bare
@@ -51,11 +51,11 @@ path = "src/main.rs"
 required-features = ["cli"]
 
 [dependencies]
-panache-formatter = { path = "crates/panache-formatter", version = "0.22.0", features = [
+panache-formatter = { path = "crates/panache-formatter", version = "0.23.0", features = [
     "serde",
     "schema",
 ] }
-panache-parser = { path = "crates/panache-parser", version = "0.28.0", features = [
+panache-parser = { path = "crates/panache-parser", version = "0.28.1", features = [
     "serde",
     "schema",
 ] }

{panache_cli-3.7.0 → panache_cli-3.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: panache-cli
-Version: 3.7.0
+Version: 3.8.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.23.0](https://github.com/jolars/panache/compare/panache-formatter-v0.22.0...panache-formatter-v0.23.0) (2026-08-31)
+
+### Features
+- **math:** indent top-level environments ([`f222d44`](https://github.com/jolars/panache/commit/f222d448d74a53eb0d939108e244d560c9fc0e2e))
+
+### Bug Fixes
+- **formatter:** preserve math control spaces at line ends ([`b449e66`](https://github.com/jolars/panache/commit/b449e662644835ae8b62db99afa000e47be281ec))
+- **formatter:** preserve math control spaces ([`85dd96f`](https://github.com/jolars/panache/commit/85dd96f72ae3d924b2efde5c46baa8c70f7a2f60)), fixes [#522](https://github.com/jolars/panache/issues/522)
+- **formatter:** preserve control spaces in math rows ([`2c2e24f`](https://github.com/jolars/panache/commit/2c2e24fc087a6697f4f985d70c5e4478975cddb2)), fixes [#521](https://github.com/jolars/panache/issues/521)
+
+### Dependencies
+- updated crates/panache-parser to v0.28.1
+
 ## [0.22.0](https://github.com/jolars/panache/compare/panache-formatter-v0.21.3...panache-formatter-v0.22.0) (2026-08-28)
 
 ### Features

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "panache-formatter"
-version = "0.22.0"
+version = "0.23.0"
 edition.workspace = true
 rust-version.workspace = true
 include = [
@@ -19,7 +19,7 @@ keywords = ["quarto", "pandoc", "markdown", "formatter"]
 categories = ["text-processing"]
 
 [dependencies]
-panache-parser = { path = "../panache-parser", version = "0.28.0" }
+panache-parser = { path = "../panache-parser", version = "0.28.1" }
 log = { version = "0.4.31", features = ["release_max_level_debug"] }
 rowan = "0.17.0"
 serde = { version = "1.0.228", features = ["derive"], optional = true }

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/src/formatter/inline.rs

@@ -456,7 +456,7 @@ pub(super) fn format_inline_node(node: &SyntaxNode, config: &Config) -> String {
                     None => format!(
                         "{}\n{}\n{}",
                         open,
-                        math::trim_trailing_whitespace_per_line(content.trim()),
+                        math::trim_preserved_math_body(&content),
                         close,
                     ),
                 }
@@ -533,7 +533,8 @@ pub(super) fn format_inline_node(node: &SyntaxNode, config: &Config) -> String {
                     math::push_body_with_trailing_newline(&mut result, &body);
                 }
                 None => {
-                    let mut trimmed_content = content.trim_end();
+                    let cleaned_content = math::trim_trailing_whitespace_per_line(&content);
+                    let mut trimmed_content = cleaned_content.trim_end_matches(['\r', '\n']);
                     while let Some((first, rest)) = trimmed_content.split_once('\n') {
                         if first.trim().is_empty() {
                             trimmed_content = rest;
@@ -558,7 +559,7 @@ pub(super) fn format_inline_node(node: &SyntaxNode, config: &Config) -> String {
                             };
                             if !stripped.is_empty() {
                                 result.push_str(&pad);
-                                result.push_str(stripped.trim_end_matches([' ', '\t']));
+                                result.push_str(stripped);
                             }
                             result.push('\n');
                         }

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/src/formatter/math/STYLE.md

@@ -48,14 +48,12 @@ Text-domain, unknown, unmatched, over-attached, and document-redefined command
 arguments are opaque preservation islands when the surrounding expression can
 still be lowered safely; they do not automatically preserve the whole span. The
 host's preserved-body path removes ASCII spaces and tabs immediately before a
-line ending. This line hygiene does not otherwise normalize or reflow the
-preserved content.
+line ending, except for the semantic ASCII space in the TeX control symbol `\ `.
+This line hygiene does not otherwise normalize or reflow the preserved content.
 
 ## Intentional Badness differences
 
 - Markdown inline hosts join layout lines unless a TeX comment pins the break.
-- Standalone display environments own their indentation; `math_indent` is not
-  applied around their markers.
 - A soft newline before a signature-proven argument collapses as insignificant
   whitespace.
 - Panache applies both sides of the TeXbook Bin-to-Ord rule: it tightens
@@ -67,6 +65,9 @@ preserved content.
 - Panache preserves scripted composite relations such as `<=_i`, `>=_i`, and
   `==_i`; the pinned formatter incorrectly separates the relation head from its
   CST-separated script.
+- Panache retains an authored environment-row boundary after a standalone TeX
+  control space. The pinned formatter moves the control space onto the next row;
+  Panache keeps the semantic space at the physical line end.
 
 ## Rules
 
@@ -97,9 +98,11 @@ preserved content.
 
 3. **Environment layout.** A standalone `\begin{name}` and `\end{name}` each go
    on their own line at the environment's indent. The body is indented **one
-   level (2 spaces) deeper**, accumulating for nested environments.
-   `math_indent` does **not** apply inside standalone environments; their
-   two-space body indent is a fixed part of the stable style.
+   level (2 spaces) deeper**, accumulating for nested environments. An
+   environment inside a Markdown display-math host inherits `math_indent` around
+   its markers, then adds the fixed two-space body indent. A raw standalone TeX
+   environment has no Markdown host indent; its body still uses the same fixed
+   two-space step.
 
    Signature-declared environment arguments remain attached to the opening
    marker. In particular, `array`'s optional position and required column
@@ -191,9 +194,11 @@ preserved content.
    **source character counts**, so alignment is cosmetic source-tidiness, not
    rendered-glyph alignment (`\alpha` counts as 6).
 
-   Every math-body line ends without trailing ASCII spaces or tabs. The printer
-   and preserved-body host paths enforce this invariant; alignment padding may
-   appear before a `\\` marker, but never at the physical line end.
+   Every math-body line ends without layout-generated ASCII spaces or tabs. The
+   printer and preserved-body host paths enforce this invariant; alignment
+   padding may appear before a `\\` marker, but never at the physical line end.
+   The semantic ASCII space in the TeX control symbol `\ ` is the sole exception
+   and survives even when that token ends a physical line.
 
    A grid cell containing one comment-bearing group, signature-proven argument,
    braced script, or `\left`/`\right` body uses the typed comment layout from
@@ -339,6 +344,10 @@ preserved content.
      `+`/`-` is `Ord` and never a break site. Typed lowering keeps the semantic
      atom stream intact across continuation segments, so a leading binary
      operator stays binary instead of coercing to a sign.
+   - **Semantic control spaces survive breaks.** The math IR represents `\ `
+     separately from layout padding. An authored or selected line ending after
+     that token retains its ASCII space, while any formatter-generated padding
+     after it is removed.
    - **A logical row is one equation.** Free rows split into logical rows only
      on a top-level hard `\\`; a soft newline is insignificant whitespace and
      does **not** start a new row, so a multi-line authored equation (and the

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/src/formatter/math/ir.rs

@@ -15,6 +15,8 @@ use std::rc::Rc;
 pub(super) enum Ir {
     /// Literal single-line text.
     Text(Rc<str>),
+    /// The TeX control symbol `\ `, whose ASCII space is semantic.
+    ControlSpace,
     /// Documents printed back-to-back.
     Concat(Rc<[Ir]>),
     /// A space when flat, or a newline when broken.
@@ -59,6 +61,10 @@ impl Ir {
         }
     }
 
+    pub(super) fn control_space() -> Self {
+        Self::ControlSpace
+    }
+
     pub(super) fn concat(documents: impl IntoIterator<Item = Ir>) -> Self {
         let documents: Vec<_> = documents
             .into_iter()
@@ -117,7 +123,7 @@ impl Ir {
                 inner.contains_forced_break()
             }
             Self::BoundedAlign { aligned, .. } => aligned.contains_forced_break(),
-            Self::Text(_) | Self::Line | Self::SoftLine | Self::Nil => false,
+            Self::Text(_) | Self::ControlSpace | Self::Line | Self::SoftLine | Self::Nil => false,
         }
     }
 
@@ -126,6 +132,7 @@ impl Ir {
     pub(super) fn flat_width(&self) -> Option<usize> {
         match self {
             Self::Text(text) => Some(text.chars().count()),
+            Self::ControlSpace => Some(2),
             Self::Verbatim(text) => (!text.contains('\n')).then(|| text.chars().count()),
             Self::Concat(documents) => documents.iter().try_fold(0usize, |width, document| {
                 width.checked_add(document.flat_width()?)

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/src/formatter/math/lower.rs

@@ -2275,7 +2275,12 @@ fn atom_document(
         {
             let text = token_slice(range, token)?;
             let slash = text == "/";
-            (Ir::verbatim(text), slash)
+            let document = if text == r"\ " {
+                Ir::control_space()
+            } else {
+                Ir::verbatim(text)
+            };
+            (document, slash)
         }
         SyntaxElement::Node(node) => {
             if let Some(group) = MathGroup::cast(node.clone()) {

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/src/formatter/math/printer.rs

@@ -98,6 +98,7 @@ impl Printer {
             match command.document {
                 Ir::Nil => {}
                 Ir::Text(text) => writer.write_text(text),
+                Ir::ControlSpace => writer.write_control_space(),
                 Ir::Verbatim(text) if self.flatten_forced_breaks => {
                     writer.write_flattened_verbatim(text)
                 }
@@ -181,6 +182,7 @@ impl Printer {
                 Ir::Text(text) => {
                     column = column.saturating_add(text.chars().count());
                 }
+                Ir::ControlSpace => column = column.saturating_add(2),
                 Ir::Verbatim(text) if !text.contains('\n') => {
                     column = column.saturating_add(text.chars().count());
                 }
@@ -219,6 +221,7 @@ impl Printer {
                 Ir::SoftLine if command.mode == Mode::Flat => {}
                 Ir::SoftLine | Ir::HardLine | Ir::EmptyLine => return true,
                 Ir::Text(text) => column = column.saturating_add(text.chars().count()),
+                Ir::ControlSpace => column = column.saturating_add(2),
                 Ir::Verbatim(text) => {
                     let first = text
                         .split_once('\n')
@@ -304,6 +307,8 @@ struct Writer {
     /// that indentation is dropped at every join.
     flatten: bool,
     drop_leading_space: bool,
+    /// ASCII whitespace emitted for layout at the physical line end.
+    trailing_layout_whitespace: usize,
 }
 
 impl Writer {
@@ -315,6 +320,7 @@ impl Writer {
             needs_indent,
             flatten,
             drop_leading_space: false,
+            trailing_layout_whitespace: 0,
         }
     }
 
@@ -328,21 +334,36 @@ impl Writer {
     }
 
     fn finish(mut self) -> String {
-        if !self.flatten {
-            self.trim_trailing_whitespace();
-        }
+        self.trim_trailing_whitespace();
         self.output
     }
 
     fn trim_trailing_whitespace(&mut self) {
         self.output
-            .truncate(self.output.trim_end_matches([' ', '\t']).len());
+            .truncate(self.output.len() - self.trailing_layout_whitespace);
+        self.column = self.column.saturating_sub(self.trailing_layout_whitespace);
+        self.trailing_layout_whitespace = 0;
+    }
+
+    fn push_layout_text(&mut self, text: &str) {
+        self.output.push_str(text);
+        self.column += text.chars().count();
+        let trailing_whitespace = text
+            .as_bytes()
+            .iter()
+            .rev()
+            .take_while(|&&byte| matches!(byte, b' ' | b'\t'))
+            .count();
+        if trailing_whitespace == text.len() {
+            self.trailing_layout_whitespace += trailing_whitespace;
+        } else {
+            self.trailing_layout_whitespace = trailing_whitespace;
+        }
     }
 
     fn flush_indent(&mut self) {
         if self.needs_indent {
-            self.output.push_str(&" ".repeat(self.pending_indent));
-            self.column += self.pending_indent;
+            self.push_layout_text(&" ".repeat(self.pending_indent));
             self.needs_indent = false;
         }
     }
@@ -358,8 +379,15 @@ impl Writer {
         }
         self.drop_leading_space = false;
         self.flush_indent();
-        self.output.push_str(text);
-        self.column += text.chars().count();
+        self.push_layout_text(text);
+    }
+
+    fn write_control_space(&mut self) {
+        self.drop_leading_space = false;
+        self.flush_indent();
+        self.output.push_str(r"\ ");
+        self.column += 2;
+        self.trailing_layout_whitespace = 0;
     }
 
     /// Write one space, unless the line is still empty or already ends in one.
@@ -398,9 +426,9 @@ impl Writer {
                 self.output.push('\n');
                 self.column = 0;
                 self.needs_indent = false;
+                self.trailing_layout_whitespace = 0;
             }
-            self.output.push_str(segment);
-            self.column += segment.chars().count();
+            self.push_layout_text(segment);
         }
     }
 
@@ -410,6 +438,7 @@ impl Writer {
         self.column = 0;
         self.pending_indent = indent;
         self.needs_indent = indent > 0;
+        self.trailing_layout_whitespace = 0;
     }
 
     fn empty_line(&mut self, indent: usize) {
@@ -418,6 +447,7 @@ impl Writer {
         self.column = 0;
         self.pending_indent = indent;
         self.needs_indent = indent > 0;
+        self.trailing_layout_whitespace = 0;
     }
 }
 
@@ -544,6 +574,20 @@ mod tests {
         assert_eq!(printer(80).print(&document, 0), "a\nb\nc\n\nd");
     }
 
+    #[test]
+    fn line_boundaries_preserve_control_spaces_but_drop_later_padding() {
+        let document = Ir::concat([
+            Ir::text("a"),
+            Ir::control_space(),
+            Ir::text("  "),
+            Ir::HardLine,
+            Ir::text("b"),
+            Ir::control_space(),
+        ]);
+
+        assert_eq!(printer(80).print(&document, 0), "a\\ \nb\\ ");
+    }
+
     #[test]
     fn multiline_verbatim_forces_an_enclosing_group_open() {
         let document = Ir::group(Ir::concat([
@@ -595,7 +639,7 @@ mod tests {
             Ir::verbatim("b\nc"),
             Ir::HardLine,
         ]);
-        assert_eq!(printer(4).print_flat(&document), "a b c ");
+        assert_eq!(printer(4).print_flat(&document), "a b c");
     }
 
     #[test]

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/src/formatter/math/render.rs

@@ -116,7 +116,7 @@ fn render_inline_content(
         if keeps_breaks {
             printer.print(document, 0)
         } else {
-            printer.print_flat(document).trim().to_string()
+            printer.print_flat(document)
         }
     };
 
@@ -144,7 +144,10 @@ fn render_inline_content(
 /// on that line; the caller already puts the closing delimiter on a line of its
 /// own, so keeping the break would leave a blank line between them.
 fn trimmed_body(printer: &Printer, document: &Ir, indent: usize) -> String {
-    printer.print(document, indent).trim_end().to_string()
+    printer
+        .print(document, indent)
+        .trim_end_matches(['\r', '\n'])
+        .to_string()
 }
 
 fn render_display(
@@ -197,25 +200,9 @@ fn render_display(
             opts.line_width.saturating_sub(opts.math_indent),
         )
     {
-        let significant = top
-            .iter()
-            .filter(|element| !is_layout_whitespace(element))
-            .collect::<Vec<_>>();
-        let base_indent = if significant.len() == 1
-            && significant[0].as_node().is_some_and(|node| {
-                node.kind() == SyntaxKind::MATH_ENVIRONMENT
-                    || MathScripted::cast(node.clone()).is_some_and(|scripted| {
-                        scripted
-                            .base()
-                            .and_then(SyntaxElement::into_node)
-                            .is_some_and(|base| base.kind() == SyntaxKind::MATH_ENVIRONMENT)
-                    })
-            }) {
-            0
-        } else {
-            opts.math_indent
-        };
-        return Some(Printer::new(opts.line_width, INDENT.len()).print(&document, base_indent));
+        return Some(
+            Printer::new(opts.line_width, INDENT.len()).print(&document, opts.math_indent),
+        );
     }
 
     if has_mixed_environment_content(top) {

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-formatter/src/formatter/math.rs

@@ -156,9 +156,10 @@ impl Formatter {
                 push_body_with_trailing_newline(&mut self.output, &body);
             }
             None => {
-                for line in content.trim().lines() {
+                let content = trim_preserved_math_body(&content);
+                for line in content.lines() {
                     self.output.push_str(&" ".repeat(self.config.math_indent));
-                    self.output.push_str(line.trim_end());
+                    self.output.push_str(line);
                     self.output.push('\n');
                 }
             }
@@ -178,6 +179,10 @@ pub(super) fn push_body_with_trailing_newline(output: &mut String, body: &str) {
 }
 
 /// Drop ASCII line-end padding without otherwise normalizing preserved math.
+///
+/// A space immediately controlled by an odd-length backslash run is the TeX
+/// control symbol `\ `, not padding. Keep that byte while removing any layout
+/// whitespace after it.
 pub(super) fn trim_trailing_whitespace_per_line(body: &str) -> String {
     let mut output = String::with_capacity(body.len());
     for segment in body.split_inclusive('\n') {
@@ -185,18 +190,44 @@ pub(super) fn trim_trailing_whitespace_per_line(body: &str) -> String {
             let (line, carriage_return) = line
                 .strip_suffix('\r')
                 .map_or((line, false), |line| (line, true));
-            output.push_str(line.trim_end_matches([' ', '\t']));
+            output.push_str(trim_math_line_end(line));
             if carriage_return {
                 output.push('\r');
             }
             output.push('\n');
         } else {
-            output.push_str(segment.trim_end_matches([' ', '\t']));
+            output.push_str(trim_math_line_end(segment));
         }
     }
     output
 }
 
+pub(super) fn trim_preserved_math_body(body: &str) -> String {
+    trim_trailing_whitespace_per_line(body)
+        .trim_start()
+        .trim_end_matches(['\r', '\n'])
+        .to_string()
+}
+
+fn trim_math_line_end(line: &str) -> &str {
+    let trimmed = line.trim_end_matches([' ', '\t']);
+    let trailing = &line[trimmed.len()..];
+    if !trailing.starts_with(' ') {
+        return trimmed;
+    }
+    let backslashes = trimmed
+        .as_bytes()
+        .iter()
+        .rev()
+        .take_while(|&&byte| byte == b'\\')
+        .count();
+    if backslashes % 2 == 1 {
+        &line[..trimmed.len() + 1]
+    } else {
+        trimmed
+    }
+}
+
 fn inline_delimiters(
     style: MathDelimiterStyle,
     is_display_math: bool,
@@ -660,6 +691,20 @@ mod tests {
         assert_idempotent("\\alpha x", MathContext::Inline);
     }
 
+    #[test]
+    fn inline_preserves_trailing_control_space() {
+        assert_eq!(fmt(r"x\ ", MathContext::Inline), r"x\ ");
+        assert_idempotent(r"x\ ", MathContext::Inline);
+    }
+
+    #[test]
+    fn preserved_line_cleanup_keeps_only_semantic_control_space() {
+        assert_eq!(
+            trim_trailing_whitespace_per_line("a\\ \t  \nb\\\\   \nc \t\n"),
+            "a\\ \nb\\\\\nc\n"
+        );
+    }
+
     #[test]
     fn inline_keeps_optional_arguments_tight() {
         assert_eq!(fmt(r"\sqrt[3]{x}", MathContext::Inline), r"\sqrt[3]{x}");

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-parser/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.28.1](https://github.com/jolars/panache/compare/panache-parser-v0.28.0...panache-parser-v0.28.1) (2026-08-31)
+
+### Bug Fixes
+- **math:** report unescaped dollar ([`8083731`](https://github.com/jolars/panache/commit/80837318919cfe318eebd8c8b83a43db13ab2be6))
+
 ## [0.28.0](https://github.com/jolars/panache/compare/panache-parser-v0.27.2...panache-parser-v0.28.0) (2026-08-28)
 
 ### Features

{panache_cli-3.7.0 → panache_cli-3.8.0}/crates/panache-parser/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "panache-parser"
-version = "0.28.0"
+version = "0.28.1"
 edition.workspace = true
 rust-version.workspace = true
 readme = "README.md"