chore: upgrade to dprint-core 0.54.1

Author: dsherret

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dprint-plugin-markdown"
-version = "0.12.2"
+version = "0.13.0"
 authors = ["David Sherret <[email protected]>"]
 edition = "2021"
 homepage = "https://github.com/dprint/dprint-plugin-markdown"
@@ -25,12 +25,12 @@ tracing = ["dprint-core/tracing"]
 
 [dependencies]
 anyhow = "1.0.56"
-dprint-core = { version = "0.51.0", features = ["formatting"] }
+dprint-core = { version = "0.54.1", features = ["formatting"] }
 pulldown-cmark = { version = "0.9.1", default-features = false }
 regex = "1"
 serde = { version = "1.0.136", features = ["derive"] }
 serde_json = { version = "1.0", optional = true }
 
 [dev-dependencies]
-dprint-development = "0.7.0"
+dprint-development = "0.8.0"
 serde_json = { version = "1.0" }

dprint.json

@@ -12,10 +12,10 @@
     "**/target"
   ],
   "plugins": [
-    "https://plugins.dprint.dev/typescript-0.64.2.wasm",
+    "https://plugins.dprint.dev/typescript-0.65.1.wasm",
     "https://plugins.dprint.dev/json-0.14.1.wasm",
     "https://plugins.dprint.dev/markdown-0.12.2.wasm",
     "https://plugins.dprint.dev/toml-0.5.4.wasm",
-    "https://plugins.dprint.dev/rustfmt-0.4.0.exe-plugin@c6bb223ef6e5e87580177f6461a0ab0554ac9ea6b54f78ea7ae8bf63b14f5bc2"
+    "https://plugins.dprint.dev/rustfmt-0.6.1.exe-plugin@99b89a0599fd3a63e597e03436862157901f3facae2f0c2fbd0b9f656cdbc2a5"
   ]
 }

src/format_text.rs

@@ -1,9 +1,8 @@
-use std::borrow::Cow;
-
 use anyhow::bail;
 use anyhow::Result;
 use dprint_core::configuration::resolve_new_line_kind;
 use dprint_core::formatting::*;
+use dprint_core::plugins::FormatResult;
 
 use super::configuration::Configuration;
 use super::generation::file_has_ignore_file_directive;
@@ -15,17 +14,13 @@ use super::generation::Context;
 /// Formats a file.
 ///
 /// Returns the file text or an error when it failed to parse.
-pub fn format_text(
-  file_text: &str,
-  config: &Configuration,
-  format_code_block_text: impl for<'a> FnMut(&str, &'a str, u32) -> Result<Cow<'a, str>>,
-) -> Result<String> {
+pub fn format_text(file_text: &str, config: &Configuration, format_code_block_text: impl for<'a> FnMut(&str, &'a str, u32) -> FormatResult) -> FormatResult {
   let (source_file, markdown_text) = match parse_source_file(file_text, config)? {
-    ParseFileResult::IgnoreFile => return Ok(file_text.to_string()),
+    ParseFileResult::IgnoreFile => return Ok(None),
     ParseFileResult::SourceFile(file) => file,
   };
 
-  Ok(dprint_core::formatting::format(
+  let result = dprint_core::formatting::format(
     || {
       let mut context = Context::new(markdown_text, config, format_code_block_text);
       #[allow(clippy::let_and_return)]
@@ -34,23 +29,28 @@ pub fn format_text(
       print_items
     },
     config_to_print_options(file_text, config),
-  ))
+  );
+  if result == file_text {
+    Ok(None)
+  } else {
+    Ok(Some(result))
+  }
 }
 
 #[cfg(feature = "tracing")]
 pub fn trace_file(
   file_text: &str,
   config: &Configuration,
-  format_code_block_text: Box<dyn Fn(&str, &str, u32) -> Result<String>>,
+  format_code_block_text: impl for<'a> FnMut(&str, &'a str, u32) -> FormatResult,
 ) -> dprint_core::formatting::TracingResult {
   let (source_file, markdown_text) = match parse_source_file(file_text, config).unwrap() {
     ParseFileResult::IgnoreFile => panic!("Cannot trace file because it has an ignore file comment."),
     ParseFileResult::SourceFile(file) => file,
   };
   dprint_core::formatting::trace_printing(
     || {
-      let mut context = Context::new(&markdown_text, config, format_code_block_text);
-      let print_items = parse_node(&source_file.into(), &mut context);
+      let mut context = Context::new(markdown_text, config, format_code_block_text);
+      let print_items = generate(&source_file.into(), &mut context);
       // println!("{}", print_items.get_as_text());
       print_items
     },

src/generation/gen_types.rs

@@ -1,6 +1,4 @@
-use std::borrow::Cow;
-
-use anyhow::Result;
+use dprint_core::plugins::FormatResult;
 use regex::Regex;
 
 use super::utils::*;
@@ -15,7 +13,7 @@ pub struct Context<'a> {
   pub raw_indent_level: u32,
   is_in_list_count: u32,
   text_wrap_disabled_count: u32,
-  pub format_code_block_text: Box<dyn for<'b> FnMut(&str, &'b str, u32) -> Result<Cow<'b, str>> + 'a>,
+  pub format_code_block_text: Box<dyn for<'b> FnMut(&str, &'b str, u32) -> FormatResult + 'a>,
   pub ignore_regex: Regex,
   pub ignore_start_regex: Regex,
   pub ignore_end_regex: Regex,
@@ -25,7 +23,7 @@ impl<'a> Context<'a> {
   pub fn new(
     file_text: &'a str,
     configuration: &'a Configuration,
-    format_code_block_text: impl for<'b> FnMut(&str, &'b str, u32) -> Result<Cow<'b, str>> + 'a,
+    format_code_block_text: impl for<'b> FnMut(&str, &'b str, u32) -> FormatResult + 'a,
   ) -> Context<'a> {
     Context {
       file_text,
@@ -63,7 +61,7 @@ impl<'a> Context<'a> {
     self.text_wrap_disabled_count > 0
   }
 
-  pub fn format_text<'b>(&mut self, tag: &str, text: &'b str) -> Result<Cow<'b, str>> {
+  pub fn format_text<'b>(&mut self, tag: &str, text: &'b str) -> FormatResult {
     let line_width = std::cmp::max(10, self.configuration.line_width as i32 - self.indent_level as i32) as u32;
     (self.format_code_block_text)(tag, text, line_width)
   }

src/generation/generate.rs

@@ -7,6 +7,7 @@ use dprint_core::formatting::conditions::*;
 use dprint_core::formatting::ir_helpers::*;
 use dprint_core::formatting::*;
 use std::borrow::Cow;
+use std::rc::Rc;
 
 pub fn generate(node: &Node, context: &mut Context) -> PrintItems {
   // println!("Kind: {:?}", node.kind());
@@ -61,7 +62,7 @@ fn gen_source_file(source_file: &SourceFile, context: &mut Context) -> PrintItem
 
   items.push_condition(if_true(
     "endOfFileNewLine",
-    |context| Some(context.writer_info.column_number > 0 || context.writer_info.line_number > 0),
+    Rc::new(|context| Some(context.writer_info.column_number > 0 || context.writer_info.line_number > 0)),
     Signal::NewLine.into(),
   ));
 
@@ -266,15 +267,15 @@ fn gen_block_quote(block_quote: &BlockQuote, context: &mut Context) -> PrintItem
       PrintItem::String(text) => {
         items.push_condition(if_true(
           "angleBracketIfStartOfLine",
-          |context| Some(context.writer_info.is_start_of_line()),
+          condition_resolvers::is_start_of_line(),
           "> ".into(),
         ));
         items.push_item(PrintItem::String(text));
       }
       PrintItem::Signal(Signal::NewLine) => {
         items.push_condition(if_true(
           "angleBracketIfStartOfLine",
-          |context| Some(context.writer_info.is_start_of_line()),
+          condition_resolvers::is_start_of_line(),
           ">".into(),
         ));
         items.push_signal(Signal::NewLine);
@@ -325,8 +326,8 @@ fn gen_code_block(code_block: &CodeBlock, context: &mut Context) -> PrintItems {
     let start_pos = get_code_block_start_pos(code);
     let code = code[start_pos..].trim_end();
     if let Some(tag) = &code_block.tag {
-      if let Ok(text) = context.format_text(tag, code) {
-        return text;
+      if let Ok(Some(text)) = context.format_text(tag, code) {
+        return Cow::Owned(text);
       }
     }
     Cow::Borrowed(code)
@@ -626,7 +627,7 @@ fn gen_list(list: &List, is_alternate: bool, context: &mut Context) -> PrintItem
       let after_child = Info::new("afterChild");
       items.push_condition(if_true(
         "spaceIfHasChild",
-        move |context| Some(!condition_resolvers::is_at_same_position(context, &after_child)?),
+        Rc::new(move |context| Some(!condition_helpers::is_at_same_position(context, &after_child)?)),
         Signal::SpaceIfNotTrailing.into(),
       ));
       items.extend(with_indent_times(generate(child, context), indent_increment));

src/wasm_plugin.rs

@@ -1,14 +1,13 @@
-use std::borrow::Cow;
 use std::path::Path;
 use std::path::PathBuf;
 
-use anyhow::Result;
 use dprint_core::configuration::ConfigKeyMap;
 use dprint_core::configuration::GlobalConfiguration;
 use dprint_core::configuration::ResolveConfigurationResult;
 use dprint_core::generate_plugin_code;
-use dprint_core::plugins::PluginHandler;
+use dprint_core::plugins::FormatResult;
 use dprint_core::plugins::PluginInfo;
+use dprint_core::plugins::SyncPluginHandler;
 
 use super::configuration::resolve_config;
 use super::configuration::Configuration;
@@ -21,15 +20,15 @@ impl MarkdownPluginHandler {
   }
 }
 
-impl PluginHandler<Configuration> for MarkdownPluginHandler {
+impl SyncPluginHandler<Configuration> for MarkdownPluginHandler {
   fn resolve_config(&mut self, config: ConfigKeyMap, global_config: &GlobalConfiguration) -> ResolveConfigurationResult<Configuration> {
     resolve_config(config, global_config)
   }
 
   // Markdown extensions: markdown, mdown, mkdn, mdwn, mkd, md
   // ref: https://superuser.com/questions/249436/file-extension-for-markdown-files/285878#285878
   // ref: https://github.com/denoland/deno_registry2/issues/206
-  fn get_plugin_info(&mut self) -> PluginInfo {
+  fn plugin_info(&mut self) -> PluginInfo {
     let version = env!("CARGO_PKG_VERSION").to_string();
     PluginInfo {
       name: env!("CARGO_PKG_NAME").to_string(),
@@ -50,25 +49,25 @@ impl PluginHandler<Configuration> for MarkdownPluginHandler {
     }
   }
 
-  fn get_license_text(&mut self) -> String {
+  fn license_text(&mut self) -> String {
     std::str::from_utf8(include_bytes!("../LICENSE")).unwrap().into()
   }
 
-  fn format_text(
+  fn format(
     &mut self,
     _file_path: &Path,
     file_text: &str,
     config: &Configuration,
-    mut format_with_host: impl FnMut(&Path, String, &ConfigKeyMap) -> Result<String>,
-  ) -> Result<String> {
+    mut format_with_host: impl FnMut(&Path, String, &ConfigKeyMap) -> FormatResult,
+  ) -> FormatResult {
     return super::format_text(file_text, config, |tag, file_text, line_width| {
       if let Some(ext) = tag_to_extension(tag) {
         let file_path = PathBuf::from(format!("file.{}", ext));
         let mut additional_config = ConfigKeyMap::new();
         additional_config.insert("lineWidth".into(), (line_width as i32).into());
-        format_with_host(&file_path, file_text.to_string(), &additional_config).map(|text| Cow::Owned(text))
+        format_with_host(&file_path, file_text.to_string(), &additional_config)
       } else {
-        Ok(Cow::Borrowed(file_text))
+        Ok(None)
       }
     });
 

tests/newline_test.rs

@@ -1,39 +1,35 @@
-use std::borrow::Cow;
-
 use dprint_plugin_markdown::configuration::*;
 use dprint_plugin_markdown::*;
 
 #[test]
 fn test_issue22_with_carriage_return_line_feeds() {
   let config = ConfigurationBuilder::new().build();
-  let result = format_text(&"```\r\ntest\r\n\r\ntest\r\n```\r\n", &config, |_, file_text, _| Ok(Cow::Borrowed(file_text))).unwrap();
-  assert_eq!(result, "```\ntest\n\ntest\n```\n");
+  let result = format_text(&"```\r\ntest\r\n\r\ntest\r\n```\r\n", &config, |_, _, _| Ok(None)).unwrap();
+  assert_eq!(result.unwrap(), "```\ntest\n\ntest\n```\n");
 }
 
 #[test]
 fn test_issue26_with_carriage_return_line_feeds() {
   let config = ConfigurationBuilder::new().build();
-  let result = format_text(
-    &"Testing:\r\n<!-- dprint-ignore -->\r\n```json\r\ntesting\r\n```\r\n",
-    &config,
-    |_, file_text, _| Ok(Cow::Borrowed(file_text)),
-  )
+  let result = format_text(&"Testing:\r\n<!-- dprint-ignore -->\r\n```json\r\ntesting\r\n```\r\n", &config, |_, _, _| {
+    Ok(None)
+  })
   .unwrap();
-  assert_eq!(result, "Testing:\n\n<!-- dprint-ignore -->\n```json\ntesting\n```\n");
+  assert_eq!(result.unwrap(), "Testing:\n\n<!-- dprint-ignore -->\n```json\ntesting\n```\n");
 }
 
 #[test]
 fn test_issue35_convert_two_spaces_end_of_line_to_hard_break() {
   // In markdown, two spaces at the end of the line is a hard break.
   // To make this easier to see, we convert it to a hard break.
   let config = ConfigurationBuilder::new().build();
-  let result = format_text(&"testing  \nasdf", &config, |_, file_text, _| Ok(Cow::Borrowed(file_text))).unwrap();
-  assert_eq!(result, "testing\\\nasdf\n");
+  let result = format_text(&"testing  \nasdf", &config, |_, _, _| Ok(None)).unwrap();
+  assert_eq!(result.unwrap(), "testing\\\nasdf\n");
 }
 
 #[test]
 fn test_issue35_ignore_two_spaces_before_hard_break() {
   let config = ConfigurationBuilder::new().build();
-  let result = format_text(&"testing  \\\nasdf", &config, |_, file_text, _| Ok(Cow::Borrowed(file_text))).unwrap();
-  assert_eq!(result, "testing\\\nasdf\n");
+  let result = format_text(&"testing  \\\nasdf", &config, |_, _, _| Ok(None)).unwrap();
+  assert_eq!(result.unwrap(), "testing\\\nasdf\n");
 }

tests/run_specs_test.rs

@@ -1,7 +1,6 @@
 extern crate dprint_development;
 extern crate dprint_plugin_markdown;
 
-use std::borrow::Cow;
 use std::path::PathBuf;
 
 use dprint_core::configuration::*;
@@ -30,9 +29,9 @@ fn test_specs() {
         format_text(&file_text, &config_result.config, |tag, file_text, line_width| {
           let end = format!("_formatted_{}", line_width);
           if tag == "format" && !file_text.ends_with(&end) {
-            Ok(Cow::Owned(format!("{}{}\n\n", file_text.to_string(), end)))
+            Ok(Some(format!("{}{}\n\n", file_text.to_string(), end)))
           } else {
-            Ok(Cow::Borrowed(file_text))
+            Ok(None)
           }
         })
       }
@@ -45,9 +44,9 @@ fn test_specs() {
         return serde_json::to_string(&trace_file(&_file_text, &config_result.config, |tag, file_text, line_width| {
           let end = format!("_formatted_{}", line_width);
           if tag == "format" && !file_text.ends_with(&end) {
-            Ok(format!("{}{}\n\n", file_text.to_string(), end))
+            Ok(Some(format!("{}{}\n\n", file_text.to_string(), end)))
           } else {
-            Ok(file_text.to_string())
+            Ok(None)
           }
         }))
         .unwrap();