Skip to content

feat: support ~/.gitingest and repo-level .gitingest config files #111

@filipchristiansen

Description

@filipchristiansen

It would be helpful to allow users to configure gitingest behavior via a configuration file. This file could be located in the user’s home directory as ~/.gitingest or within the repository itself (e.g., .gitingest in the root).

The configuration could include:

  • Exclude patterns: To specify files or directories to ignore.
  • Custom prompts: Predefined instructions or prompts to prepend to gitingest output through user defined command-line flags.

A proposed format could be TOML or something similar for simplicity and readability.

Example:

[EXCLUDE]
patterns = ["*/tests", "*.csv"]

[PROMPTS]
refactor = "This file contains my entire codebase. Please review the overall structure and suggest any improvements or refactoring opportunities, focusing on maintainability and scalability."

docs = "This file contains undocumented or partially documented functions and modules. Please identify areas where documentation is missing and suggest detailed descriptions or examples to improve clarity and usability using the numpy docstring format”

This feature would provide users with centralized and/or project-specific control over how gitingest operates, making it more flexible and user-friendly.

Metadata

Metadata

Assignees

No one assigned

    Labels

    suggestionNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions