",
Language::Html,
&options,
- |code, _| Ok::<_, std::convert::Infallible>(code.into()),
+ |code, _| Ok(code.into()),
).unwrap_err(),
FormatError::Syntax(SyntaxError { .. })
));
```
-External formatter can return [`Err`] as well.
+External formatter can return `anyhow::Error`.
This error will be aggregated and returned in [`FormatError::External`]:
```rust
+use anyhow::Error;
use markup_fmt::{config::FormatOptions, format_text, FormatError, Language};
-struct ExternalFormatterError;
-
let options = FormatOptions::default();
assert!(matches!(
format_text(
"",
Language::Html,
&options,
- |_, _| Err(ExternalFormatterError),
+ |_, _| Err(Error::msg("external formatter error")),
).unwrap_err(),
FormatError::External(errors) if !errors.is_empty()
));
diff --git a/markup_fmt/examples/fmt.rs b/markup_fmt/examples/fmt.rs
index a3dd4e7b..1d18a4c1 100644
--- a/markup_fmt/examples/fmt.rs
+++ b/markup_fmt/examples/fmt.rs
@@ -1,5 +1,5 @@
use markup_fmt::{config::FormatOptions, detect_language, format_text};
-use std::{convert::Infallible, env, fs, io};
+use std::{env, fs, io};
fn main() -> anyhow::Result<()> {
let file_path = env::args().nth(1).unwrap();
@@ -16,9 +16,7 @@ fn main() -> anyhow::Result<()> {
}
};
- let formatted = format_text(&code, language, &options, |code, _| {
- Ok::<_, Infallible>(code.into())
- })?;
+ let formatted = format_text(&code, language, &options, |code, _| Ok(code.into()))?;
print!("{formatted}");
Ok(())
}
diff --git a/markup_fmt/src/ast.rs b/markup_fmt/src/ast.rs
index 0e98a11c..8f4c7e0a 100644
--- a/markup_fmt/src/ast.rs
+++ b/markup_fmt/src/ast.rs
@@ -33,6 +33,13 @@ pub struct AngularElseIf<'s> {
pub children: Vec
>,
}
+#[derive(Debug)]
+pub struct AngularGenericBlock<'s> {
+ pub keyword: &'s str,
+ pub header: Option<&'s str>,
+ pub children: Vec>,
+}
+
#[derive(Debug)]
/// Angular interpolation: `{{ expression }}`.
///
@@ -102,6 +109,7 @@ pub enum Attribute<'s> {
JinjaBlock(JinjaBlock<'s, Attribute<'s>>),
JinjaComment(JinjaComment<'s>),
JinjaTag(JinjaTag<'s>),
+ JsComment(JsComment<'s>),
Native(NativeAttribute<'s>),
Svelte(SvelteAttribute<'s>),
SvelteAttachment(SvelteAttachment<'s>),
@@ -179,6 +187,8 @@ pub struct JinjaComment<'s> {
pub struct JinjaInterpolation<'s> {
pub expr: &'s str,
pub start: usize,
+ pub trim_prev: bool,
+ pub trim_next: bool,
}
#[derive(Debug)]
@@ -196,14 +206,28 @@ pub enum JinjaTagOrChildren<'s, T> {
Children(Vec),
}
+#[derive(Debug)]
+pub struct JsComment<'s> {
+ pub block: bool,
+ pub raw: &'s str,
+}
+
#[derive(Debug)]
/// Mustache block: `{{#variable}}{{/variable}}`.
///
/// See https://mustache.github.io/mustache.5.html
pub struct MustacheBlock<'s> {
+ pub controls: Vec>,
+ pub children: Vec>>,
+}
+
+#[derive(Debug)]
+pub struct MustacheBlockControl<'s> {
+ pub name: &'s str,
pub prefix: &'s str,
- pub content: &'s str,
- pub children: Vec>,
+ pub content: Option<&'s str>,
+ pub wc_before: bool,
+ pub wc_after: bool,
}
#[derive(Debug)]
@@ -233,6 +257,7 @@ pub struct Node<'s> {
#[derive(Debug)]
pub enum NodeKind<'s> {
AngularFor(AngularFor<'s>),
+ AngularGenericBlocks(Vec>),
AngularIf(AngularIf<'s>),
AngularInterpolation(AngularInterpolation<'s>),
AngularLet(AngularLet<'s>),
@@ -421,6 +446,8 @@ pub struct VentoEval<'s> {
pub struct VentoInterpolation<'s> {
pub expr: &'s str,
pub start: usize,
+ pub trim_prev: bool,
+ pub trim_next: bool,
}
#[derive(Debug)]
diff --git a/markup_fmt/src/config.rs b/markup_fmt/src/config.rs
index 4d41149e..09d983fa 100644
--- a/markup_fmt/src/config.rs
+++ b/markup_fmt/src/config.rs
@@ -50,7 +50,7 @@ impl Default for LayoutOptions {
}
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum LineBreak {
@@ -299,7 +299,7 @@ impl Default for LanguageOptions {
}
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum Quotes {
@@ -308,7 +308,7 @@ pub enum Quotes {
Single,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum ClosingTagLineBreakForEmpty {
@@ -318,7 +318,7 @@ pub enum ClosingTagLineBreakForEmpty {
Never,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum WhitespaceSensitivity {
@@ -328,7 +328,7 @@ pub enum WhitespaceSensitivity {
Ignore,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum DoctypeKeywordCase {
@@ -338,7 +338,7 @@ pub enum DoctypeKeywordCase {
Lower,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum VBindStyle {
@@ -347,7 +347,7 @@ pub enum VBindStyle {
Long,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum VOnStyle {
@@ -356,7 +356,7 @@ pub enum VOnStyle {
Long,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum VForDelimiterStyle {
@@ -365,7 +365,7 @@ pub enum VForDelimiterStyle {
Of,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum VSlotStyle {
@@ -376,7 +376,7 @@ pub enum VSlotStyle {
VSlot,
}
-#[derive(Clone, Debug, Default)]
+#[derive(Clone, Copy, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum VueComponentCase {
@@ -391,7 +391,7 @@ pub enum VueComponentCase {
KebabCase,
}
-#[derive(Clone, Debug)]
+#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum ScriptFormatter {
diff --git a/markup_fmt/src/ctx.rs b/markup_fmt/src/ctx.rs
index 85d6ab69..44824e01 100644
--- a/markup_fmt/src/ctx.rs
+++ b/markup_fmt/src/ctx.rs
@@ -4,14 +4,20 @@ use crate::{
helpers,
state::State,
};
+use anyhow::Error;
use memchr::memchr;
-use std::borrow::Cow;
+use regex::{Captures, Regex};
+use std::{borrow::Cow, sync::LazyLock};
const QUOTES: [&str; 3] = ["\"", "\"", "'"];
-pub(crate) struct Ctx<'b, E, F>
+static RE_LINE_COLUMN: LazyLock = LazyLock::new(|| {
+ Regex::new(r"(?:[Ll]ine\s*(\d+),?\s*[Cc]ol(?:umn)?\s*(\d+))|:(\d+):(\d+)").unwrap()
+});
+
+pub(crate) struct Ctx<'b, F>
where
- F: for<'a> FnMut(&'a str, Hints<'b>) -> Result, E>,
+ F: for<'a> FnMut(&'a str, Hints<'b>) -> Result, Error>,
{
pub(crate) source: &'b str,
pub(crate) language: Language,
@@ -19,12 +25,12 @@ where
pub(crate) print_width: usize,
pub(crate) options: &'b LanguageOptions,
pub(crate) external_formatter: F,
- pub(crate) external_formatter_errors: Vec,
+ pub(crate) external_formatter_errors: Vec,
}
-impl<'b, E, F> Ctx<'b, E, F>
+impl<'b, F> Ctx<'b, F>
where
- F: for<'a> FnMut(&'a str, Hints<'b>) -> Result, E>,
+ F: for<'a> FnMut(&'a str, Hints<'b>) -> Result, Error>,
{
pub(crate) fn script_indent(&self) -> bool {
match self.language {
@@ -86,11 +92,11 @@ where
matches!(
self.options
.component_whitespace_sensitivity
- .clone()
- .unwrap_or(self.options.whitespace_sensitivity.clone()),
+ .unwrap_or(self.options.whitespace_sensitivity),
WhitespaceSensitivity::Css | WhitespaceSensitivity::Strict
)
}
+ Language::Xml => false,
_ => match self.options.whitespace_sensitivity {
WhitespaceSensitivity::Css => {
helpers::is_whitespace_sensitive_tag(tag_name, self.language)
@@ -145,7 +151,7 @@ where
code: &str,
attr: bool,
start: usize,
- ) -> Result {
+ ) -> Result {
self.try_format_expr_with_indent(code, attr, start, 0)
}
@@ -155,27 +161,19 @@ where
attr: bool,
start: usize,
indent_level: u16,
- ) -> Result {
- if code.trim().is_empty() {
+ ) -> Result {
+ let code = code.trim_ascii();
+ if code.is_empty() {
Ok(String::new())
} else {
// Trim original code before sending it to the external formatter.
// This makes sure the code will be trimmed
// though external formatter isn't available.
- let wrapped = if code.trim_start().starts_with('{') {
- self.source
- .get(0..start.saturating_sub(1))
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + "("
- + code.trim()
- + ")"
+ let will_add_brackets = code.starts_with('{') || code.starts_with("...");
+ let wrapped = if will_add_brackets {
+ &format!("[{code}]")
} else {
- self.source
- .get(0..start)
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + code
+ code
};
let formatted = self.try_format_with_external_formatter(
wrapped,
@@ -185,50 +183,41 @@ where
attr,
ext: "tsx",
},
+ start,
)?;
- let formatted = formatted.trim_matches(|c: char| c.is_ascii_whitespace() || c == ';');
- let formatted = if code.trim_start().chars().take_while(|c| *c == '(').count()
- < formatted.chars().take_while(|c| *c == '(').count()
- && code
- .trim_end()
- .chars()
- .rev()
- .take_while(|c| *c == ')')
- .count()
- < formatted.chars().rev().take_while(|c| *c == ')').count()
- {
- formatted
- .trim_ascii()
- .strip_prefix('(')
- .and_then(|s| s.strip_suffix(')'))
- .unwrap_or(formatted)
- } else {
- formatted
- };
+ let mut formatted =
+ formatted.trim_matches(|c: char| c.is_ascii_whitespace() || c == ';');
+ // Only strip the wrapping brackets we added ourselves. Stripping
+ // `[` `]` unconditionally would remove array-destructuring brackets
+ // that the external formatter merely exposed by dropping redundant
+ // parentheses (e.g. `([a, b])` -> `[a, b]`), which corrupts Vue
+ // `v-for` bindings into `(a, b)` and changes their semantics.
+ if will_add_brackets {
+ formatted = trim_delim(code, formatted, '[', ']');
+ }
+ formatted = trim_delim(code, formatted, '(', ')');
+ if will_add_brackets {
+ formatted = formatted.trim_ascii_end().trim_end_matches(',');
+ }
Ok(formatted.trim_ascii().to_owned())
}
}
pub(crate) fn format_binding(&mut self, code: &str, start: usize) -> String {
- if code.trim().is_empty() {
+ let code = code.trim_ascii();
+ if code.is_empty() {
String::new()
} else {
- let wrapped = self
- .source
- .get(0..start.saturating_sub(4))
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + "let "
- + code.trim()
- + " = 0";
+ let wrapped = format!("let {code} = 0");
let formatted = self.format_with_external_formatter(
- wrapped,
+ &wrapped,
Hints {
print_width: self.print_width,
indent_level: 0,
attr: false,
ext: "ts",
},
+ start,
);
let formatted = formatted.trim_matches(|c: char| c.is_ascii_whitespace() || c == ';');
formatted
@@ -240,25 +229,20 @@ where
}
pub(crate) fn format_type_params(&mut self, code: &str, start: usize) -> String {
- if code.trim().is_empty() {
+ let code = code.trim_ascii();
+ if code.is_empty() {
String::new()
} else {
- let wrapped = self
- .source
- .get(0..start.saturating_sub(7))
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + "type T<"
- + code.trim()
- + "> = 0";
+ let wrapped = format!("type T<{code}> = 0");
let formatted = self.format_with_external_formatter(
- wrapped,
+ &wrapped,
Hints {
print_width: self.print_width,
indent_level: 0,
attr: true,
ext: "ts",
},
+ start,
);
let formatted = formatted.trim_matches(|c: char| c.is_ascii_whitespace() || c == ';');
formatted
@@ -272,18 +256,20 @@ where
}
pub(crate) fn format_stmt_header(&mut self, keyword: &str, code: &str) -> String {
- if code.trim().is_empty() {
+ let code = code.trim_ascii();
+ if code.is_empty() {
String::new()
} else {
let wrapped = format!("{keyword} ({code}) {{}}");
let formatted = self.format_with_external_formatter(
- wrapped,
+ &wrapped,
Hints {
print_width: self.print_width,
indent_level: 0,
attr: false,
ext: "js",
},
+ 0,
);
formatted
.strip_prefix(keyword)
@@ -304,18 +290,31 @@ where
start: usize,
state: &State,
) -> Cow<'a, str> {
- self.format_with_external_formatter(
- self.source
- .get(0..start)
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + code,
+ match self.try_format_script(code, lang, start, state) {
+ Ok(formatted) => formatted,
+ Err(e) => {
+ self.external_formatter_errors.push(e);
+ Cow::from(code)
+ }
+ }
+ }
+
+ pub(crate) fn try_format_script<'a>(
+ &mut self,
+ code: &'a str,
+ lang: &'b str,
+ start: usize,
+ state: &State,
+ ) -> Result, Error> {
+ self.try_format_with_external_formatter(
+ code,
Hints {
print_width: self.print_width,
indent_level: state.indent_level,
attr: false,
ext: lang,
},
+ start,
)
}
@@ -327,14 +326,7 @@ where
state: &State,
) -> Cow<'a, str> {
self.format_with_external_formatter(
- "\n".repeat(
- self.source
- .get(0..start)
- .unwrap_or_default()
- .lines()
- .count()
- .saturating_sub(1),
- ) + code,
+ code,
Hints {
print_width: self
.print_width
@@ -348,22 +340,20 @@ where
attr: false,
ext: if lang == "postcss" { "css" } else { lang },
},
+ start,
)
}
pub(crate) fn format_style_attr(&mut self, code: &str, start: usize, state: &State) -> String {
self.format_with_external_formatter(
- self.source
- .get(0..start)
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + code,
+ code,
Hints {
print_width: u16::MAX as usize,
indent_level: state.indent_level,
attr: true,
ext: "css",
},
+ start,
)
.trim()
.to_owned()
@@ -376,11 +366,7 @@ where
state: &State,
) -> Cow<'a, str> {
self.format_with_external_formatter(
- self.source
- .get(0..start)
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + code,
+ code,
Hints {
print_width: self
.print_width
@@ -394,6 +380,7 @@ where
attr: false,
ext: "json",
},
+ start,
)
}
@@ -405,11 +392,7 @@ where
state: &State,
) -> String {
self.format_with_external_formatter(
- self.source
- .get(0..start)
- .unwrap_or_default()
- .replace(|c: char| !c.is_ascii_whitespace(), " ")
- + code,
+ code,
Hints {
print_width: self
.print_width
@@ -422,6 +405,7 @@ where
"markup-fmt-jinja-stmt"
},
},
+ start,
)
.trim_ascii()
.to_owned()
@@ -429,12 +413,12 @@ where
fn format_with_external_formatter<'a>(
&mut self,
- code: String,
+ code: &'a str,
hints: Hints<'b>,
+ start: usize,
) -> Cow<'a, str> {
- match (self.external_formatter)(&code, hints) {
- Ok(Cow::Owned(formatted)) => Cow::from(formatted),
- Ok(Cow::Borrowed(..)) => Cow::from(code),
+ match self.try_format_with_external_formatter(code, hints, start) {
+ Ok(formatted) => formatted,
Err(e) => {
self.external_formatter_errors.push(e);
code.into()
@@ -444,13 +428,45 @@ where
fn try_format_with_external_formatter<'a>(
&mut self,
- code: String,
+ code: &'a str,
hints: Hints<'b>,
- ) -> Result, E> {
- match (self.external_formatter)(&code, hints) {
+ start: usize,
+ ) -> Result, Error> {
+ match (self.external_formatter)(code, hints) {
Ok(Cow::Owned(formatted)) => Ok(Cow::from(formatted)),
Ok(Cow::Borrowed(..)) => Ok(Cow::from(code)),
- Err(e) => Err(e),
+ Err(e) => {
+ let msg = e.to_string();
+ let (start_line, start_col) = helpers::pos_to_line_col(self.source, start);
+ let msg = RE_LINE_COLUMN
+ .replace_all(&msg, |captures: &Captures| {
+ captures
+ .get(1)
+ .or_else(|| captures.get(3))
+ .zip(captures.get(2).or_else(|| captures.get(4)))
+ .and_then(|(line, col)| {
+ Some((
+ msg.get(..line.start())?,
+ msg.get(line.range())
+ .and_then(|line| line.parse::().ok())?,
+ msg.get(line.end()..col.start())?,
+ msg.get(col.range())
+ .and_then(|col| col.parse::().ok())?,
+ msg.get(col.end()..)?,
+ ))
+ })
+ .map(|(prefix, line, mid, col, suffix)| {
+ format!(
+ "{prefix}{}{mid}{}{suffix}",
+ (start_line + line).saturating_sub(1),
+ start_col + col
+ )
+ })
+ .unwrap_or_else(|| msg.clone())
+ })
+ .to_string();
+ Err(Error::msg(msg))
+ }
}
}
}
@@ -465,3 +481,28 @@ pub struct Hints<'s> {
/// Fake file extension.
pub ext: &'s str,
}
+
+fn trim_delim<'a>(user_input: &str, formatted: &'a str, start: char, end: char) -> &'a str {
+ if user_input
+ .trim_start()
+ .chars()
+ .take_while(|c| *c == start)
+ .count()
+ < formatted.chars().take_while(|c| *c == start).count()
+ && user_input
+ .trim_end()
+ .chars()
+ .rev()
+ .take_while(|c| *c == end)
+ .count()
+ < formatted.chars().rev().take_while(|c| *c == end).count()
+ {
+ formatted
+ .trim_ascii()
+ .strip_prefix(start)
+ .and_then(|s| s.strip_suffix(end))
+ .unwrap_or(formatted)
+ } else {
+ formatted
+ }
+}
diff --git a/markup_fmt/src/error.rs b/markup_fmt/src/error.rs
index f7af6cb6..9cdecc56 100644
--- a/markup_fmt/src/error.rs
+++ b/markup_fmt/src/error.rs
@@ -1,4 +1,5 @@
-use std::{borrow::Cow, error::Error, fmt};
+use anyhow::Error;
+use std::{borrow::Cow, fmt};
#[derive(Clone, Debug)]
/// Syntax error when parsing tags, not `
+ >
@@ -46,7 +45,10 @@ source: markup_fmt/tests/fmt.rs
window.ga = function () { ga.q.push(arguments) }; ga.q = []; ga.l = +new Date;
ga('create', 'UA-XXXXX-Y', 'auto'); ga('send', 'pageview')
-
+