Re-exported sqlparser::dialect and updated documentation

Author: RPG-Alex

README.md

@@ -34,10 +34,8 @@ CREATE TABLE users (
 ```
 A rudimentary implementation can be generated with:
 ```rust
-use sql_docs::SqlDoc;
-use sql_docs::error::DocError;
+use sql_docs::{GenericDialect,SqlDoc,error::DocError};
 use std::{env, fs};
-use sqlparser::dialect::GenericDialect;
 
 fn main() -> Result<(), DocError> {
     // Temporary directory and file created for demonstration purposes

fuzz/Cargo.lock

@@ -3,54 +3,54 @@
 use libfuzzer_sys::fuzz_target;
 use std::str;
 
-use sql_docs::SqlDoc;
+use sql_docs::{SqlDoc, GenericDialect};
 
 fuzz_target!(|data: String| {
     const SEPS: [&str; 6] = ["", " ", "\n", " | ", " • ", "--"];
-    let _ = SqlDoc::builder_from_str(&data).build();
-    let _ = SqlDoc::builder_from_str(&data).deny(&data).build();
+    let _ = SqlDoc::builder_from_str(&data).build::<GenericDialect>();
+    let _ = SqlDoc::builder_from_str(&data).deny(&data).build::<GenericDialect>();
     let _ = SqlDoc::builder_from_str(&data)
         .deny("nonexistent.sql")
         .deny("a.sql")
         .deny("b.sql")
-        .build();
-    let _ = SqlDoc::builder_from_str(&data).preserve_multiline().build();
-    let _ = SqlDoc::builder_from_str(&data).flatten_multiline().build();
+        .build::<GenericDialect>();
+    let _ = SqlDoc::builder_from_str(&data).preserve_multiline().build::<GenericDialect>();
+    let _ = SqlDoc::builder_from_str(&data).flatten_multiline().build::<GenericDialect>();
     for sep in SEPS {
-        let _ = SqlDoc::builder_from_str(&data).flatten_multiline_with(sep).build();
+        let _ = SqlDoc::builder_from_str(&data).flatten_multiline_with(sep).build::<GenericDialect>();
     }
-    let _ = SqlDoc::builder_from_str(&data).collect_single_nearest().build();
-    let _ = SqlDoc::builder_from_str(&data).collect_all_leading().build();
-    let _ = SqlDoc::builder_from_str(&data).collect_all_single_one_multi().build();
+    let _ = SqlDoc::builder_from_str(&data).collect_single_nearest().build::<GenericDialect>();
+    let _ = SqlDoc::builder_from_str(&data).collect_all_leading().build::<GenericDialect>();
+    let _ = SqlDoc::builder_from_str(&data).collect_all_single_one_multi().build::<GenericDialect>();
     for sep in SEPS {
         let _ = SqlDoc::builder_from_str(&data)
             .collect_single_nearest()
             .flatten_multiline_with(sep)
             .deny("nonexistent.sql")
-            .build();
+            .build::<GenericDialect>();
 
         let _ = SqlDoc::builder_from_str(&data)
             .collect_all_leading()
             .flatten_multiline_with(sep)
             .deny(&data)
-            .build();
+            .build::<GenericDialect>();
 
         let _ = SqlDoc::builder_from_str(&data)
             .collect_all_single_one_multi()
             .flatten_multiline_with(sep)
             .deny("a.sql")
             .deny("b.sql")
-            .build();
+            .build::<GenericDialect>();
     }
     let _ = SqlDoc::builder_from_str(&data)
         .collect_single_nearest()
         .collect_all_leading()
         .collect_all_single_one_multi()
-        .build();
+        .build::<GenericDialect>();
 
     let _ = SqlDoc::builder_from_str(&data)
         .flatten_multiline()
         .preserve_multiline()
         .flatten_multiline_with(" | ")
-        .build();
+        .build::<GenericDialect>();
 });

fuzz/fuzz_targets/sql_docs.rs

@@ -11,7 +11,7 @@
 //! - [`docs`]     — Generate structured documentation (`TableDoc`, `ColumnDoc`)
 //! - [`sql_doc`]  — Build the top-level [`SqlDoc`] and primary entry point
 //!
-//! **Start here:** [`SqlDoc::from_dir`] or [`SqlDoc::from_path`]
+//! **Start here:** [`SqlDoc::from_dir`], [`SqlDoc::from_path`], or [`SqlDoc::builder_from_str`]
 
 pub mod ast;
 pub mod comments;
@@ -20,4 +20,25 @@ pub mod error;
 pub mod files;
 pub mod source;
 pub mod sql_doc;
-pub use sql_doc::SqlDoc;
+pub use crate::comments::{LeadingCommentCapture, MultiFlatten};
+pub use crate::docs::{ColumnDoc, TableDoc};
+pub use crate::error::DocError;
+pub use crate::sql_doc::{SqlDoc, SqlDocBuilder};
+
+/// Common imports for typical usage of this crate.
+pub mod prelude {
+    pub use crate::{
+        AnsiDialect, BigQueryDialect, ClickHouseDialect, DatabricksDialect, Dialect, DuckDbDialect,
+        GenericDialect, HiveDialect, MsSqlDialect, MySqlDialect, OracleDialect, PostgreSqlDialect,
+        RedshiftSqlDialect, SQLiteDialect, SnowflakeDialect,
+    };
+    pub use crate::{
+        ColumnDoc, DocError, LeadingCommentCapture, MultiFlatten, SqlDoc, SqlDocBuilder, TableDoc,
+    };
+}
+
+pub use sqlparser::dialect::{
+    AnsiDialect, BigQueryDialect, ClickHouseDialect, DatabricksDialect, Dialect, DuckDbDialect,
+    GenericDialect, HiveDialect, MsSqlDialect, MySqlDialect, OracleDialect, PostgreSqlDialect,
+    RedshiftSqlDialect, SQLiteDialect, SnowflakeDialect,
+};

src/lib.rs

@@ -41,7 +41,7 @@ impl SqlDoc {
     ///
     /// # Examples
     /// ```no_run
-    /// use sql_docs::sql_doc::SqlDoc;
+    /// use sql_docs::SqlDoc;
     /// use sqlparser::dialect::GenericDialect;
     ///
     /// let doc = SqlDoc::from_dir("migrations")
@@ -72,8 +72,7 @@ impl SqlDoc {
     ///
     /// # Examples
     /// ```no_run
-    /// use sql_docs::sql_doc::SqlDoc;
-    /// use sqlparser::dialect::GenericDialect;
+    /// use sql_docs::{SqlDoc,GenericDialect};
     ///
     /// let doc = SqlDoc::from_path("schema.sql")
     ///     .build::<GenericDialect>()
@@ -102,8 +101,7 @@ impl SqlDoc {
     ///
     /// # Examples
     /// ```no_run
-    /// use sql_docs::sql_doc::SqlDoc;
-    /// use sqlparser::dialect::GenericDialect;
+    /// use sql_docs::{SqlDoc,GenericDialect};
     ///
     /// let paths = vec!["one.sql", "two.sql"];
     /// let doc = SqlDoc::from_paths(&paths)
@@ -139,8 +137,7 @@ impl SqlDoc {
     ///
     /// # Examples
     /// ```
-    /// use sql_docs::sql_doc::SqlDoc;
-    /// use sqlparser::dialect::GenericDialect;
+    /// use sql_docs::{SqlDoc,GenericDialect};
     ///
     /// let sql = r#"
     ///     -- Users table
@@ -177,8 +174,7 @@ impl SqlDoc {
     /// # Examples
     /// ```
     /// use std::path::PathBuf;
-    /// use sql_docs::sql_doc::SqlDoc;
-    /// use sqlparser::dialect::GenericDialect;
+    /// use sql_docs::{SqlDoc,GenericDialect};
     ///
     /// let sql_users = "CREATE TABLE users (id INTEGER PRIMARY KEY);".to_owned();
     /// let sql_posts = "CREATE TABLE posts (id INTEGER PRIMARY KEY);".to_owned();