Use nightly rust for formatting to group import statements

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       matrix:
         job:
-          - cargo fmt --all -- --check
+          - rustup toolchain install nightly --profile minimal --component rustfmt && cargo fmt --all -- --check
           - cargo test --all-targets --all-features
           - cargo clippy --all-targets --all-features -- -D warning
       fail-fast: false
@@ -54,7 +54,7 @@ jobs:
     needs: populate-rust-cache
     env:
       # These hooks are expensive and already run as dedicated jobs above
-      SKIP: "tests,clippy"
+      SKIP: "rustfmt,tests,clippy"
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
 

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
     hooks:
       - id: rustfmt
         name: Check formatting
-        entry: cargo fmt --
+        entry: cargo +nightly fmt --
         language: system
         files: \.rs$
       - id: tests

CONTRIBUTING.md

@@ -35,9 +35,11 @@ You can see some examples of this in:
 
 ## Conventions
 
-Code is formatted with [rustfmt](https://github.com/rust-lang/rustfmt) using the default options.
-In addition, all default [clippy](https://github.com/rust-lang/rust-clippy) checks on the latest stable Rust compiler must also pass.
-Both of these are enforced through CI using GitHub actions.
+Code is formatted with [rustfmt](https://github.com/rust-lang/rustfmt).
+The nightly toolchain is used for this as things like sorting of imports is not yet available on stable yet.
+If you don't have the nightly toolchain installed, run: `rustup toolchain install nightly --component rustfmt`
+
+In addition, [clippy](https://github.com/rust-lang/rust-clippy) is configured to be quite pedantic and all of its checks must also pass for CI builds to succeed.
 
 > **💡 Tip: install pre-commit hooks**
 >

rustfmt.toml

@@ -0,0 +1,4 @@
+imports_granularity = "Module"
+imports_layout = "HorizontalVertical"
+group_imports = "StdExternalCrate"
+format_code_in_doc_comments = true

src/context.rs

@@ -1,6 +1,7 @@
-use crate::Frontmatter;
 use std::path::{Path, PathBuf};
 
+use crate::Frontmatter;
+
 #[derive(Debug, Clone)]
 /// Context holds metadata about a note which is being parsed.
 ///
@@ -36,10 +37,9 @@ pub struct Context {
     /// # let mut context = Context::new(PathBuf::from("source"), PathBuf::from("destination"));
     /// let key = Value::String("foo".to_string());
     ///
-    /// context.frontmatter.insert(
-    ///     key.clone(),
-    ///     Value::String("bar".to_string()),
-    /// );
+    /// context
+    ///     .frontmatter
+    ///     .insert(key.clone(), Value::String("bar".to_string()));
     /// ```
     pub frontmatter: Frontmatter,
 }

src/frontmatter.rs

@@ -14,10 +14,7 @@ use serde_yaml::Result;
 /// let mut frontmatter = Frontmatter::new();
 /// let key = Value::String("foo".to_string());
 ///
-/// frontmatter.insert(
-///     key.clone(),
-///     Value::String("bar".to_string()),
-/// );
+/// frontmatter.insert(key.clone(), Value::String("bar".to_string()));
 ///
 /// assert_eq!(
 ///     frontmatter.get(&key),
@@ -67,10 +64,11 @@ pub enum FrontmatterStrategy {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     use pretty_assertions::assert_eq;
     use serde_yaml::Value;
 
+    use super::*;
+
     #[test]
     fn empty_string_should_yield_empty_frontmatter() {
         assert_eq!(frontmatter_from_str("").unwrap(), Frontmatter::new());

src/lib.rs

@@ -1,5 +1,4 @@
-pub use pulldown_cmark;
-pub use serde_yaml;
+pub use {pulldown_cmark, serde_yaml};
 
 #[macro_use]
 extern crate lazy_static;
@@ -10,11 +9,16 @@ pub mod postprocessors;
 mod references;
 mod walker;
 
-pub use context::Context;
-pub use frontmatter::{Frontmatter, FrontmatterStrategy};
-pub use walker::{vault_contents, WalkOptions};
+use std::ffi::OsString;
+use std::fs::{self, File};
+use std::io::prelude::*;
+use std::io::ErrorKind;
+use std::path::{Path, PathBuf};
+use std::{fmt, str};
 
+pub use context::Context;
 use frontmatter::{frontmatter_from_str, frontmatter_to_str};
+pub use frontmatter::{Frontmatter, FrontmatterStrategy};
 use pathdiff::diff_paths;
 use percent_encoding::{utf8_percent_encode, AsciiSet, CONTROLS};
 use pulldown_cmark::{CodeBlockKind, CowStr, Event, HeadingLevel, Options, Parser, Tag};
@@ -23,14 +27,8 @@ use rayon::prelude::*;
 use references::{ObsidianNoteReference, RefParser, RefParserState, RefType};
 use slug::slugify;
 use snafu::{ResultExt, Snafu};
-use std::ffi::OsString;
-use std::fmt;
-use std::fs::{self, File};
-use std::io::prelude::*;
-use std::io::ErrorKind;
-use std::path::{Path, PathBuf};
-use std::str;
 use unicode_normalization::UnicodeNormalization;
+pub use walker::{vault_contents, WalkOptions};
 
 /// A series of markdown [Event]s that are generated while traversing an Obsidian markdown note.
 pub type MarkdownEvents<'a> = Vec<Event<'a>>;
@@ -897,10 +895,11 @@ fn codeblock_kind_to_owned<'a>(codeblock_kind: CodeBlockKind<'_>) -> CodeBlockKi
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     use pretty_assertions::assert_eq;
     use rstest::rstest;
 
+    use super::*;
+
     lazy_static! {
         static ref VAULT: Vec<PathBuf> = vec![
             PathBuf::from("NoteA.md"),

src/main.rs

@@ -1,8 +1,10 @@
+use std::env;
+use std::path::PathBuf;
+
 use eyre::{eyre, Result};
 use gumdrop::Options;
 use obsidian_export::postprocessors::{filter_by_tags, softbreaks_to_hardbreaks};
 use obsidian_export::{ExportError, Exporter, FrontmatterStrategy, WalkOptions};
-use std::{env, path::PathBuf};
 
 const VERSION: &str = env!("CARGO_PKG_VERSION");
 

src/postprocessors.rs

@@ -1,9 +1,10 @@
 //! A collection of officially maintained [postprocessors][crate::Postprocessor].
 
-use super::{Context, MarkdownEvents, PostprocessorResult};
 use pulldown_cmark::Event;
 use serde_yaml::Value;
 
+use super::{Context, MarkdownEvents, PostprocessorResult};
+
 /// This postprocessor converts all soft line breaks to hard line breaks. Enabling this mimics
 /// Obsidian's _'Strict line breaks'_ setting.
 pub fn softbreaks_to_hardbreaks(

src/references.rs

@@ -1,6 +1,7 @@
-use regex::Regex;
 use std::fmt;
 
+use regex::Regex;
+
 lazy_static! {
     static ref OBSIDIAN_NOTE_LINK_RE: Regex =
         Regex::new(r"^(?P<file>[^#|]+)??(#(?P<section>.+?))??(\|(?P<label>.+?))??$").unwrap();

src/walker.rs

@@ -1,9 +1,11 @@
-use crate::{ExportError, WalkDirSnafu};
-use ignore::{DirEntry, Walk, WalkBuilder};
-use snafu::ResultExt;
 use std::fmt;
 use std::path::{Path, PathBuf};
 
+use ignore::{DirEntry, Walk, WalkBuilder};
+use snafu::ResultExt;
+
+use crate::{ExportError, WalkDirSnafu};
+
 type Result<T, E = ExportError> = std::result::Result<T, E>;
 type FilterFn = dyn Fn(&DirEntry) -> bool + Send + Sync + 'static;
 

tests/export_test.rs

@@ -1,16 +1,16 @@
 #![allow(clippy::shadow_unrelated)]
 
-use obsidian_export::{ExportError, Exporter, FrontmatterStrategy};
-use pretty_assertions::assert_eq;
 use std::fs::{create_dir, read_to_string, set_permissions, File, Permissions};
 use std::io::prelude::*;
+#[cfg(not(target_os = "windows"))]
+use std::os::unix::fs::PermissionsExt;
 use std::path::PathBuf;
+
+use obsidian_export::{ExportError, Exporter, FrontmatterStrategy};
+use pretty_assertions::assert_eq;
 use tempfile::TempDir;
 use walkdir::WalkDir;
 
-#[cfg(not(target_os = "windows"))]
-use std::os::unix::fs::PermissionsExt;
-
 #[test]
 fn test_main_variants_with_default_options() {
     let tmp_dir = TempDir::new().expect("failed to make tempdir");

tests/postprocessors_test.rs

@@ -1,12 +1,13 @@
+use std::collections::HashSet;
+use std::fs::{read_to_string, remove_file};
+use std::path::PathBuf;
+use std::sync::Mutex;
+
 use obsidian_export::postprocessors::{filter_by_tags, softbreaks_to_hardbreaks};
 use obsidian_export::{Context, Exporter, MarkdownEvents, PostprocessorResult};
 use pretty_assertions::assert_eq;
 use pulldown_cmark::{CowStr, Event};
 use serde_yaml::Value;
-use std::collections::HashSet;
-use std::fs::{read_to_string, remove_file};
-use std::path::PathBuf;
-use std::sync::Mutex;
 use tempfile::TempDir;
 use walkdir::WalkDir;