Adding remove_obsidian_comments postprocessor to remove obsidian format comments

README.md

@@ -239,6 +239,30 @@ With these hooks in place, links to both notes as well as file attachments shoul
  > 
  > Note: If you're using a theme which comes with it's own render hooks, you might need to do a little extra work, or customize the snippets above, to avoid conflicts with the hooks from your theme.
 
+## Removing Obsidian comments
+
+To remove [Obsidian formatted comments](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Comments) you can set the `--remove-obsidian-comments` flag. This will remove inline as well as block comments but leave any comments found in codeblocks.
+
+````md
+This is not a comment.
+
+%% This is an inline comment %% This line could have more text.
+
+%%
+This would be a
+block comment and
+all of this would be removed
+%%
+````
+
+With the `--remove-obsidian-comments` flag. This file would output as
+
+````md
+This is not a comment
+
+This line could have more text.
+````
+
 
 # Library usage
 

docs/usage-advanced.md

@@ -118,3 +118,26 @@ With these hooks in place, links to both notes as well as file attachments shoul
 [hugo-relative-linking]: https://notes.nick.groenen.me/notes/relative-linking-in-hugo/
 [hugo]: https://gohugo.io
 [markdown render hooks]: https://gohugo.io/getting-started/configuration-markup#markdown-render-hooks
+
+## Removing Obsidian comments
+
+To remove [Obsidian formatted comments](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Comments) you can set the `--remove-obsidian-comments` flag. This will remove inline as well as block comments but leave any comments found in codeblocks.
+
+```md
+This is not a comment.
+
+%% This is an inline comment %% This line could have more text.
+
+%%
+This would be a
+block comment and
+all of this would be removed
+%%
+```
+With the `--remove-obsidian-comments` flag. This file would output as
+
+```md
+This is not a comment
+
+This line could have more text.
+```

src/main.rs

@@ -60,6 +60,12 @@ struct Opts {
         default = "false"
     )]
     hard_linebreaks: bool,
+    #[options(
+        no_short,
+        help = "Remove Obsidian style comments from exported file",
+        default = "false"
+    )]
+    remove_obsidian_comments: bool,
 }
 
 fn frontmatter_strategy_from_str(input: &str) -> Result<FrontmatterStrategy> {
@@ -100,6 +106,10 @@ fn main() {
         exporter.add_postprocessor(&softbreaks_to_hardbreaks);
     }
 
+    if args.remove_obsidian_comments {
+        exporter.add_postprocessor(&remove_obsidian_comments);
+    }
+
     let tags_postprocessor = filter_by_tags(args.skip_tags, args.only_tags);
     exporter.add_postprocessor(&tags_postprocessor);
 

src/postprocessors.rs

@@ -1,7 +1,8 @@
 //! A collection of officially maintained [postprocessors][crate::Postprocessor].
 
 use super::{Context, MarkdownEvents, PostprocessorResult};
-use pulldown_cmark::Event;
+use pulldown_cmark::{CowStr, Event, Tag};
+use regex::Regex;
 use serde_yaml::Value;
 
 /// This postprocessor converts all soft line breaks to hard line breaks. Enabling this mimics
@@ -51,6 +52,70 @@ fn filter_by_tags_(
     }
 }
 
+/// This postprocessor removes all Obsidian comments from a file excluding codeblocks. Enabling this
+/// prohibits comments from being exported but leaves them untouched in the original files
+pub fn remove_obsidian_comments(
+    _context: &mut Context,
+    events: &mut MarkdownEvents,
+) -> PostprocessorResult {
+    let mut output = Vec::with_capacity(events.len());
+    let mut inside_comment = false;
+    let mut inside_codeblock = false;
+
+    for event in &mut *events {
+        output.push(event.to_owned());
+
+        match event {
+            Event::Text(ref text) => {
+                if !text.contains("%%") {
+                    if inside_comment {
+                        output.pop(); //Inside block comment so remove
+                    }
+                    continue;
+                } else if inside_codeblock {
+                    continue; //Skip anything inside codeblocks
+                }
+
+                output.pop();
+
+                if inside_comment {
+                    inside_comment = false;
+                    continue;
+                }
+
+                if !text.eq(&CowStr::from("%%")) {
+                    let re = Regex::new(r"%%.*?%%").unwrap();
+                    let result = re.replace_all(text, "").to_string();
+                    output.push(Event::Text(CowStr::from(result)));
+                    continue;
+                }
+
+                inside_comment = true;
+            }
+            Event::Start(Tag::CodeBlock(_)) => {
+                inside_codeblock = true;
+            }
+            Event::End(Tag::CodeBlock(_)) => {
+                inside_codeblock = false;
+            }
+            Event::End(Tag::Paragraph) => {
+                if output[output.len() - 2] == Event::Start(Tag::Paragraph) {
+                    // If the comment was the only item on the line remove the start and end paragraph events to remove the \n in the output file.
+                    output.pop();
+                    output.pop();
+                }
+            }
+            _ => {
+                if inside_comment {
+                    output.pop();
+                }
+            }
+        }
+    }
+    *events = output;
+    PostprocessorResult::Continue
+}
+
 #[test]
 fn test_filter_tags() {
     let tags = vec![

tests/postprocessors_test.rs

@@ -1,4 +1,6 @@
-use obsidian_export::postprocessors::{filter_by_tags, softbreaks_to_hardbreaks};
+use obsidian_export::postprocessors::{
+    filter_by_tags, remove_obsidian_comments, softbreaks_to_hardbreaks,
+};
 use obsidian_export::{Context, Exporter, MarkdownEvents, PostprocessorResult};
 use pretty_assertions::assert_eq;
 use pulldown_cmark::{CowStr, Event};
@@ -290,3 +292,20 @@ fn test_filter_by_tags() {
         );
     }
 }
+
+#[test]
+fn test_remove_obsidian_comments() {
+    let tmp_dir = TempDir::new().expect("failed to make tempdir");
+    let mut exporter = Exporter::new(
+        PathBuf::from("tests/testdata/input/remove-comments/"),
+        tmp_dir.path().to_path_buf(),
+    );
+    exporter.add_postprocessor(&remove_obsidian_comments);
+    exporter.run().unwrap();
+
+    let expected =
+        read_to_string("tests/testdata/expected/remove-comments/test_comments.md").unwrap();
+    let actual = read_to_string(tmp_dir.path().join(PathBuf::from("test_comments.md"))).unwrap();
+
+    assert_eq!(expected, actual);
+}

tests/testdata/expected/remove-comments/test_comments.md

@@ -0,0 +1,6 @@
+Not a comment
+
+
+````md
+%% Comment in code block should be kept %%
+````

tests/testdata/input/remove-comments/test_comments.md

@@ -0,0 +1,11 @@
+Not a comment
+%% Comment should be removed %%
+```md
+%% Comment in code block should be kept %%
+```
+
+%%
+This is
+a block comment
+that should be removed
+%%