Merge branch 'release-v1.0.0'

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: sean0x42 # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/create_release.yml

@@ -39,4 +39,6 @@ jobs:
       with:
         tag_name: ${{ github.ref }}
         release_name: Release ${{ steps.tags.outputs.value }}
-        body: ${{ steps.release_notes.outputs.value }}
+        body: |
+          ${{ steps.release_notes.outputs.value }}
+        draft: true

CHANGELOG.md

@@ -4,16 +4,26 @@ Patch notes are automatically extracted from this changelog whenever a tag is
 pushed to the GitHub repository. The tag name must match a heading exactly.
 
 
+## v1.0.0
+
+The first proper release of `markdown-extract`! :tada:
+
+- Add `--regex` flag, which enables the use of regular expressions to search
+  for section titles.
+- Add `--first` flag, which only prints the first matching section.
+- Fix an issue where extra newlines where inserted into the final output.
+
+
 ## v0.1.1
 
- - Publish as a binary instead of a library
+- Publish as a binary instead of a library
 
 
 ## v0.1.0-alpha
 
 This version is the initial release of `markdown_extract`! It features the
 following:
 
- - Extract sections from a markdown document
- - Run from the command line
- - Use as a Rust library
+- Extract sections from a markdown document
+- Run from the command line
+- Use as a Rust library

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "markdown-extract"
 description = "Extract sections of a markdown file."
-version = "0.1.1"
+version = "1.0.0"
 authors = ["Sean Bailey <hello@seanbailey.dev>"]
 license = "MIT"
 repository = "https://github.com/sean0x42/markdown-extract"

README.md

@@ -17,28 +17,30 @@ View the help guide if you like.
 
 ```console
 $ markdown-extract -h
-markdown-extract 0.1.1
-Extracts sections of a markdown file
+markdown-extract 1.0.0
+Extract sections of a markdown file
 
 USAGE:
-    markdown-extract [FLAGS] <title> <path>
+    markdown-extract [FLAGS] <pattern> <path>
 
 FLAGS:
-    -s, --case-sensitive          Title is case sensitive
+    -s, --case-sensitive          Treat pattern as case sensitive
+    -f, --first                   Only return the first match
     -h, --help                    Prints help information
     -i, --ignore-first-heading    Do not include the top level section heading
+    -r, --regex                   Compile pattern as a regular expression
     -V, --version                 Prints version information
 
 ARGS:
-    <title>    A title to find in section headings
-    <path>     Path to markdown file
+    <pattern>    Pattern to match against section headings
+    <path>       Path to markdown file
 ```
 
 Then extract matching sections in a markdown file.
 
 ```console
-$ markdown-extract v0.1.1 CHANGELOG.md
-## v0.1.1
+$ markdown-extract --fr "^v1" CHANGELOG.md
+## v1.0.0
 
 ...
 ```

src/bin.rs

@@ -1,24 +1,41 @@
-use markdown_extract::{Document, Parser, Section};
+pub mod document;
+mod matchers;
+mod parser;
+
+use document::{Document, Section};
+use matchers::{Matcher, RegexMatcher, SimpleMatcher};
+use parser::Parser;
 use std::convert::TryInto;
 use std::error::Error;
 use std::fs::File;
 use std::path::PathBuf;
 use structopt::StructOpt;
 
-/// Extracts sections of a markdown file.
+/// Extract sections of a markdown file.
 #[derive(StructOpt)]
 #[structopt(name = "markdown-extract")]
-struct Opts {
-    /// Title is case sensitive
+pub struct Opts {
+    /// Only return the first match
+    #[structopt(short, long)]
+    first: bool,
+
+    /// Compile pattern as a regular expression.
+    ///
+    /// Documentation for the regex syntax can be found at
+    /// <https://docs.rs/regex/1.3.3/regex/index.html#syntax>
+    #[structopt(short, long)]
+    regex: bool,
+
+    /// Treat pattern as case sensitive
     #[structopt(short = "s", long)]
     case_sensitive: bool,
 
     /// Do not include the top level section heading
     #[structopt(short, long)]
     ignore_first_heading: bool,
 
-    /// A title to find in section headings
-    title: String,
+    /// Pattern to match against section headings
+    pattern: String,
 
     /// Path to markdown file
     #[structopt(parse(from_os_str))]
@@ -35,7 +52,7 @@ fn print_section(document: &Document, section: &Section, ignore_first_heading: b
             section.title
         );
     }
-    println!("{}", section.body);
+    println!("{}", section.body.join("\n"));
 
     // Print children
     for child in &section.children {
@@ -52,24 +69,26 @@ fn run() -> Result<(), Box<dyn Error>> {
     let file = File::open(&opts.path)?;
     let document = parser.parse_file(file)?;
 
-    let matches: Document = document
-        .iter()
-        .filter(|section| {
-            if opts.case_sensitive {
-                section.title.trim() == opts.title.trim()
-            } else {
-                section.title.to_lowercase().trim() == opts.title.to_lowercase().trim()
-            }
-        })
-        .cloned()
-        .collect();
+    // Match
+    let matches = if opts.regex {
+        RegexMatcher::get_matches(&document, &opts)
+    } else {
+        SimpleMatcher::get_matches(&document, &opts)
+    };
 
     // Handle no matches
     if matches.is_empty() {
         println!("No matches.");
         return Ok(());
     }
 
+    // Only print the first match
+    if opts.first {
+        // It's okay to use `[0]` here since we check if the doc is empty above
+        print_section(&document, &matches[0], opts.ignore_first_heading);
+        return Ok(());
+    }
+
     // Print matching sections
     for section in matches {
         print_section(&document, &section, opts.ignore_first_heading);

src/document.rs

@@ -11,7 +11,7 @@ pub struct Section {
 
     /// Raw markdown body.
     /// Does not include any child sections. See the `children` property for child content.
-    pub body: String,
+    pub body: Vec<String>,
 
     /// An optional pointer to a parent section.
     /// This property should always be `Some`, unless the section is located at the root of the
@@ -28,16 +28,15 @@ impl Section {
         Section {
             level: 0,
             title: String::new(),
-            body: String::new(),
+            body: Vec::new(),
             parent: None,
             children: Vec::new(),
         }
     }
 
     /// Appends the given line to the section's body
     pub fn append_to_body(&mut self, line: String) {
-        self.body.push_str(&line);
-        self.body.push('\n');
+        self.body.push(line);
     }
 
     /// Add a child to this section.

src/matchers/mod.rs

@@ -0,0 +1,12 @@
+mod regex;
+mod simple;
+
+pub use self::regex::RegexMatcher;
+use crate::document::Document;
+use crate::Opts;
+pub use simple::SimpleMatcher;
+
+pub trait Matcher {
+    /// Find any sections within the document that match
+    fn get_matches(document: &Document, opts: &Opts) -> Document;
+}

src/matchers/regex.rs

@@ -0,0 +1,24 @@
+use super::Matcher;
+use crate::document::Document;
+use crate::Opts;
+use regex::RegexBuilder;
+
+pub struct RegexMatcher;
+
+impl Matcher for RegexMatcher {
+    /// Compile the pattern as a regular expression
+    fn get_matches(document: &Document, opts: &Opts) -> Document {
+        // Compile regex for provided pattern
+        let re = RegexBuilder::new(&opts.pattern)
+            .case_insensitive(!opts.case_sensitive)
+            .size_limit(1024 * 100) // 100 kb
+            .build()
+            .unwrap();
+
+        document
+            .iter()
+            .filter(|section| re.is_match(&section.title))
+            .cloned()
+            .collect()
+    }
+}

src/matchers/simple.rs

@@ -0,0 +1,22 @@
+use super::Matcher;
+use crate::document::Document;
+use crate::Opts;
+
+pub struct SimpleMatcher;
+
+impl Matcher for SimpleMatcher {
+    /// Performs a simple pattern == title match
+    fn get_matches(document: &Document, opts: &Opts) -> Document {
+        document
+            .iter()
+            .filter(|section| {
+                if opts.case_sensitive {
+                    section.title.trim() == opts.pattern.trim()
+                } else {
+                    section.title.to_lowercase().trim() == opts.pattern.to_lowercase().trim()
+                }
+            })
+            .cloned()
+            .collect()
+    }
+}