Merge pull request #97 from mufeedvh/stateful

Code2prompt should handle stateful session

Author: ODAncona

Cargo.lock

@@ -33,3 +33,4 @@ pyo3 = { version = "0.23", features = ["extension-module", "abi3-py312"] }
 clap = { version = "4.0", features = ["derive"] }
 env_logger = { version = "0.11.3" }
 arboard = { version = "3.4.0" }
+derive_builder = { version = "0.20.2" }

Cargo.toml

@@ -29,7 +29,6 @@
   <i>Report Bug</i> 🐛<br>
 </p>
 
-
 ## Quick Install ⚡
 
 CLI with cargo 🦀
@@ -327,7 +326,6 @@ print(result["prompt"])
 
 [![Star History Chart](https://api.star-history.com/svg?repos=mufeedvh/code2prompt&type=Date)](https://star-history.com/#mufeedvh/code2prompt&Date)
 
-
 ## License
 
 Licensed under the MIT License, see <a href="https://github.com/mufeedvh/code2prompt/blob/master/LICENSE">LICENSE</a> for more information.
@@ -345,4 +343,3 @@ Ways to contribute:
 - Fix something and open a pull request
 - Help me document the code
 - Spread the word
-

README.md

@@ -1,6 +1,6 @@
 [package]
 name = "code2prompt_core"
-version = "3.0.0"
+version = "3.1.0"
 authors = [
     "Mufeed VH <[email protected]>",
     "Olivier D'Ancona <[email protected]>",
@@ -33,11 +33,11 @@ jwalk = { workspace = true }
 termtree = { workspace = true }
 tiktoken-rs = { workspace = true }
 ignore = { workspace = true }
-inquire = { workspace = true }
 regex = { workspace = true }
 git2 = { workspace = true }
 once_cell = { workspace = true }
 globset = { workspace = true }
+derive_builder = { workspace = true }
 
 [lib]
 name = "code2prompt_core"

crates/code2prompt-core/Cargo.toml

@@ -0,0 +1,105 @@
+//! This module defines the `Code2PromptConfig` struct and its Builder for configuring the behavior
+//! of code2prompt in a stateless manner. It includes all parameters needed for file traversal,
+//! code filtering, token counting, and more.
+
+use crate::template::OutputFormat;
+use crate::tokenizer::TokenizerType;
+use crate::{sort::FileSortMethod, tokenizer::TokenFormat};
+use derive_builder::Builder;
+use std::path::PathBuf;
+
+/// A stateless configuration object describing all the preferences and filters
+/// applied when generating a code prompt. It does not store any mutable data,
+/// so it can be cloned freely or shared across multiple sessions.
+#[derive(Debug, Clone, Default, Builder)]
+#[builder(setter(into), default)]
+pub struct Code2PromptConfig {
+    /// Path to the root directory of the codebase.
+    pub path: PathBuf,
+
+    /// List of glob-like patterns to include.
+    #[builder(default)]
+    pub include_patterns: Vec<String>,
+
+    /// List of glob-like patterns to exclude.
+    #[builder(default)]
+    pub exclude_patterns: Vec<String>,
+
+    /// If true, include patterns have priority over exclude patterns in case of conflicts.
+    #[builder(default)]
+    pub include_priority: bool,
+
+    /// If true, code lines will be numbered in the output.
+    #[builder(default)]
+    pub line_numbers: bool,
+
+    /// If true, paths in the output will be relative instead of absolute.
+    #[builder(default)]
+    pub relative_paths: bool,
+
+    /// If true, code2prompt will generate a full directory tree, ignoring include/exclude rules.
+    #[builder(default)]
+    pub full_directory_tree: bool,
+
+    /// If true, code blocks will not be wrapped in Markdown fences (```).
+    #[builder(default)]
+    pub no_codeblock: bool,
+
+    /// If true, symbolic links will be followed during traversal.
+    #[builder(default)]
+    pub follow_symlinks: bool,
+
+    /// If true, hidden files and directories will be included.
+    #[builder(default)]
+    pub hidden: bool,
+
+    /// If true, .gitignore rules will be ignored.
+    #[builder(default)]
+    pub no_ignore: bool,
+
+    /// Defines the sorting method for files.
+    #[builder(default)]
+    pub sort_method: Option<FileSortMethod>,
+
+    /// Determines the output format of the final prompt.
+    #[builder(default)]
+    pub output_format: OutputFormat,
+
+    /// An optional custom Handlebars template string.
+    #[builder(default)]
+    pub custom_template: Option<String>,
+
+    /// The tokenizer encoding to use for counting tokens.
+    #[builder(default)]
+    pub encoding: TokenizerType,
+
+    /// The counting format to use for token counting.
+    #[builder(default)]
+    pub token_format: TokenFormat,
+
+    /// If true, the git diff between HEAD and index will be included.
+    #[builder(default)]
+    pub diff_enabled: bool,
+
+    /// If set, contains two branch names for which code2prompt will generate a git diff.
+    #[builder(default)]
+    pub diff_branches: Option<(String, String)>,
+
+    /// If set, contains two branch names for which code2prompt will retrieve the git log.
+    #[builder(default)]
+    pub log_branches: Option<(String, String)>,
+
+    /// The name of the template used.
+    #[builder(default)]
+    pub template_name: String,
+
+    /// The template string itself.
+    #[builder(default)]
+    pub template_str: String,
+}
+
+impl Code2PromptConfig {
+    pub fn builder() -> Code2PromptConfigBuilder {
+        Code2PromptConfigBuilder::default()
+    }
+}

crates/code2prompt-core/src/configuration.rs

@@ -18,7 +18,7 @@ use std::path::Path;
 /// # Returns
 ///
 /// * A `globset::GlobSet` containing all valid glob patterns from the input.
-fn build_globset(patterns: &[String]) -> GlobSet {
+pub fn build_globset(patterns: &[String]) -> GlobSet {
     let mut builder = GlobSetBuilder::new();
 
     for pattern in patterns {
@@ -63,14 +63,10 @@ fn build_globset(patterns: &[String]) -> GlobSet {
 /// * `bool` - Returns `true` if the file should be included; otherwise, returns `false`.
 pub fn should_include_file(
     path: &Path,
-    include_patterns: &[String],
-    exclude_patterns: &[String],
+    include_globset: &GlobSet,
+    exclude_globset: &GlobSet,
     include_priority: bool,
 ) -> bool {
-    // ~~~ Initialization ~~~
-    let include_globset = build_globset(include_patterns);
-    let exclude_globset = build_globset(exclude_patterns);
-
     // ~~~ Matching ~~~
     let included = include_globset.is_match(path);
     let excluded = exclude_globset.is_match(path);
@@ -80,7 +76,7 @@ pub fn should_include_file(
         (true, true) => include_priority, // If both include and exclude patterns match, use the include_priority flag
         (true, false) => true,            // If the path is included and not excluded, include it
         (false, true) => false,           // If the path is excluded, exclude it
-        (false, false) => include_patterns.is_empty(), // If no include patterns are provided, include everything
+        (false, false) => include_globset.is_empty(), // If no include patterns are provided, include everything
     };
 
     debug!(

crates/code2prompt-core/src/filter.rs

@@ -1,6 +1,9 @@
+//! Core library for code2prompt.
+pub mod configuration;
 pub mod filter;
 pub mod git;
 pub mod path;
+pub mod session;
 pub mod sort;
 pub mod template;
 pub mod tokenizer;