mirror of
https://github.com/kirill-markin/repo-to-text.git
synced 2025-12-06 03:22:23 -08:00
d124fa24cc
- Simplified the `get_tree_structure` function by extracting the tree command execution and filtering into separate functions: `run_tree_command` and `filter_tree_output`. - Introduced `process_line`, `extract_full_path`, and `mark_non_empty_dirs` to enhance readability and maintainability of the filtering process. - Updated `load_ignore_specs` to improve loading of ignore specifications from settings and .gitignore files. - Added clipboard functionality to copy output content after saving. - Cleaned up and clarified docstrings for better understanding of function purposes.
328 lines
12 KiB
Python
328 lines
12 KiB
Python
"""
|
|
Core functionality for repo-to-text
|
|
"""
|
|
|
|
import os
|
|
import subprocess
|
|
from typing import Tuple, Optional, List, Dict, Any, Set
|
|
from datetime import datetime, timezone
|
|
from importlib.machinery import ModuleSpec
|
|
import logging
|
|
import yaml
|
|
import pathspec
|
|
from pathspec import PathSpec
|
|
|
|
from ..utils.utils import check_tree_command, is_ignored_path
|
|
|
|
def get_tree_structure(
|
|
path: str = '.',
|
|
gitignore_spec: Optional[PathSpec] = None,
|
|
tree_and_content_ignore_spec: Optional[PathSpec] = None
|
|
) -> str:
|
|
"""Generate tree structure of the directory."""
|
|
if not check_tree_command():
|
|
return ""
|
|
|
|
logging.debug('Generating tree structure for path: %s', path)
|
|
tree_output = run_tree_command(path)
|
|
logging.debug('Tree output generated:\n%s', tree_output)
|
|
|
|
if not gitignore_spec and not tree_and_content_ignore_spec:
|
|
logging.debug('No .gitignore or ignore-tree-and-content specification found')
|
|
return tree_output
|
|
|
|
logging.debug('Filtering tree output based on ignore specifications')
|
|
return filter_tree_output(tree_output, path, gitignore_spec, tree_and_content_ignore_spec)
|
|
|
|
def run_tree_command(path: str) -> str:
|
|
"""Run the tree command and return its output."""
|
|
result = subprocess.run(
|
|
['tree', '-a', '-f', '--noreport', path],
|
|
stdout=subprocess.PIPE,
|
|
check=True
|
|
)
|
|
return result.stdout.decode('utf-8')
|
|
|
|
def filter_tree_output(
|
|
tree_output: str,
|
|
path: str,
|
|
gitignore_spec: Optional[PathSpec],
|
|
tree_and_content_ignore_spec: Optional[PathSpec]
|
|
) -> str:
|
|
"""Filter the tree output based on ignore specifications."""
|
|
lines: List[str] = tree_output.splitlines()
|
|
non_empty_dirs: Set[str] = set()
|
|
|
|
filtered_lines = [
|
|
process_line(line, path, gitignore_spec, tree_and_content_ignore_spec, non_empty_dirs)
|
|
for line in lines
|
|
]
|
|
|
|
filtered_tree_output = '\n'.join(filter(None, filtered_lines))
|
|
logging.debug('Filtered tree structure:\n%s', filtered_tree_output)
|
|
return filtered_tree_output
|
|
|
|
def process_line(
|
|
line: str,
|
|
path: str,
|
|
gitignore_spec: Optional[PathSpec],
|
|
tree_and_content_ignore_spec: Optional[PathSpec],
|
|
non_empty_dirs: Set[str]
|
|
) -> Optional[str]:
|
|
"""Process a single line of the tree output."""
|
|
full_path = extract_full_path(line, path)
|
|
if not full_path or full_path == '.':
|
|
return None
|
|
|
|
relative_path = os.path.relpath(full_path, path).replace(os.sep, '/')
|
|
|
|
if should_ignore_file(
|
|
full_path,
|
|
relative_path,
|
|
gitignore_spec,
|
|
None,
|
|
tree_and_content_ignore_spec
|
|
):
|
|
logging.debug('Ignored: %s', relative_path)
|
|
return None
|
|
|
|
if not os.path.isdir(full_path):
|
|
mark_non_empty_dirs(relative_path, non_empty_dirs)
|
|
|
|
if not os.path.isdir(full_path) or os.path.dirname(relative_path) in non_empty_dirs:
|
|
return line.replace('./', '', 1)
|
|
return None
|
|
|
|
def extract_full_path(line: str, path: str) -> Optional[str]:
|
|
"""Extract the full path from a line of tree output."""
|
|
idx = line.find('./')
|
|
if idx == -1:
|
|
idx = line.find(path)
|
|
return line[idx:].strip() if idx != -1 else None
|
|
|
|
def mark_non_empty_dirs(relative_path: str, non_empty_dirs: Set[str]) -> None:
|
|
"""Mark all parent directories of a file as non-empty."""
|
|
dir_path = os.path.dirname(relative_path)
|
|
while dir_path:
|
|
non_empty_dirs.add(dir_path)
|
|
dir_path = os.path.dirname(dir_path)
|
|
|
|
def load_ignore_specs(
|
|
path: str = '.',
|
|
cli_ignore_patterns: Optional[List[str]] = None
|
|
) -> Tuple[Optional[PathSpec], Optional[PathSpec], PathSpec]:
|
|
"""Load ignore specifications from various sources.
|
|
|
|
Args:
|
|
path: Base directory path
|
|
cli_ignore_patterns: List of patterns from command line
|
|
|
|
Returns:
|
|
Tuple[Optional[PathSpec], Optional[PathSpec], PathSpec]: Tuple of gitignore_spec,
|
|
content_ignore_spec, and tree_and_content_ignore_spec
|
|
"""
|
|
gitignore_spec = None
|
|
content_ignore_spec = None
|
|
tree_and_content_ignore_list: List[str] = []
|
|
use_gitignore = True
|
|
|
|
repo_settings_path = os.path.join(path, '.repo-to-text-settings.yaml')
|
|
if os.path.exists(repo_settings_path):
|
|
logging.debug('Loading .repo-to-text-settings.yaml from path: %s', repo_settings_path)
|
|
with open(repo_settings_path, 'r', encoding='utf-8') as f:
|
|
settings: Dict[str, Any] = yaml.safe_load(f)
|
|
use_gitignore = settings.get('gitignore-import-and-ignore', True)
|
|
if 'ignore-content' in settings:
|
|
content_ignore_spec: Optional[PathSpec] = pathspec.PathSpec.from_lines(
|
|
'gitwildmatch', settings['ignore-content']
|
|
)
|
|
if 'ignore-tree-and-content' in settings:
|
|
tree_and_content_ignore_list.extend(settings.get('ignore-tree-and-content', []))
|
|
|
|
if cli_ignore_patterns:
|
|
tree_and_content_ignore_list.extend(cli_ignore_patterns)
|
|
|
|
if use_gitignore:
|
|
gitignore_path = os.path.join(path, '.gitignore')
|
|
if os.path.exists(gitignore_path):
|
|
logging.debug('Loading .gitignore from path: %s', gitignore_path)
|
|
with open(gitignore_path, 'r', encoding='utf-8') as f:
|
|
gitignore_spec = pathspec.PathSpec.from_lines('gitwildmatch', f)
|
|
|
|
tree_and_content_ignore_spec = pathspec.PathSpec.from_lines(
|
|
'gitwildmatch', tree_and_content_ignore_list
|
|
)
|
|
return gitignore_spec, content_ignore_spec, tree_and_content_ignore_spec
|
|
|
|
def should_ignore_file(
|
|
file_path: str,
|
|
relative_path: str,
|
|
gitignore_spec: Optional[PathSpec],
|
|
content_ignore_spec: Optional[PathSpec],
|
|
tree_and_content_ignore_spec: Optional[PathSpec]
|
|
) -> bool:
|
|
"""Check if a file should be ignored based on various ignore specifications.
|
|
|
|
Args:
|
|
file_path: Full path to the file
|
|
relative_path: Path relative to the repository root
|
|
gitignore_spec: PathSpec object for gitignore patterns
|
|
content_ignore_spec: PathSpec object for content ignore patterns
|
|
tree_and_content_ignore_spec: PathSpec object for tree and content ignore patterns
|
|
|
|
Returns:
|
|
bool: True if file should be ignored, False otherwise
|
|
"""
|
|
relative_path = relative_path.replace(os.sep, '/')
|
|
|
|
if relative_path.startswith('./'):
|
|
relative_path = relative_path[2:]
|
|
|
|
if os.path.isdir(file_path):
|
|
relative_path += '/'
|
|
|
|
result = (
|
|
is_ignored_path(file_path) or
|
|
bool(
|
|
gitignore_spec and
|
|
gitignore_spec.match_file(relative_path)
|
|
) or
|
|
bool(
|
|
content_ignore_spec and
|
|
content_ignore_spec.match_file(relative_path)
|
|
) or
|
|
bool(
|
|
tree_and_content_ignore_spec and
|
|
tree_and_content_ignore_spec.match_file(relative_path)
|
|
) or
|
|
os.path.basename(file_path).startswith('repo-to-text_')
|
|
)
|
|
|
|
logging.debug('Checking if file should be ignored:')
|
|
logging.debug(' file_path: %s', file_path)
|
|
logging.debug(' relative_path: %s', relative_path)
|
|
logging.debug(' Result: %s', result)
|
|
return result
|
|
|
|
def save_repo_to_text(
|
|
path: str = '.',
|
|
output_dir: Optional[str] = None,
|
|
to_stdout: bool = False,
|
|
cli_ignore_patterns: Optional[List[str]] = None
|
|
) -> str:
|
|
"""Save repository structure and contents to a text file."""
|
|
logging.debug('Starting to save repo structure to text for path: %s', path)
|
|
gitignore_spec, content_ignore_spec, tree_and_content_ignore_spec = load_ignore_specs(
|
|
path, cli_ignore_patterns
|
|
)
|
|
tree_structure: str = get_tree_structure(
|
|
path, gitignore_spec, tree_and_content_ignore_spec
|
|
)
|
|
logging.debug('Final tree structure to be written: %s', tree_structure)
|
|
|
|
output_content = generate_output_content(
|
|
path,
|
|
tree_structure,
|
|
gitignore_spec,
|
|
content_ignore_spec,
|
|
tree_and_content_ignore_spec
|
|
)
|
|
|
|
if to_stdout:
|
|
print(output_content)
|
|
return output_content
|
|
|
|
output_file = write_output_to_file(output_content, output_dir)
|
|
copy_to_clipboard(output_content)
|
|
|
|
print(
|
|
"[SUCCESS] Repository structure and contents successfully saved to "
|
|
f"file: \"./{output_file}\""
|
|
)
|
|
|
|
return output_file
|
|
|
|
def generate_output_content(
|
|
path: str,
|
|
tree_structure: str,
|
|
gitignore_spec: Optional[PathSpec],
|
|
content_ignore_spec: Optional[PathSpec],
|
|
tree_and_content_ignore_spec: Optional[PathSpec]
|
|
) -> str:
|
|
"""Generate the output content for the repository."""
|
|
output_content: List[str] = []
|
|
project_name = os.path.basename(os.path.abspath(path))
|
|
output_content.append(f'Directory: {project_name}\n\n')
|
|
output_content.append('Directory Structure:\n')
|
|
output_content.append('```\n.\n')
|
|
|
|
if os.path.exists(os.path.join(path, '.gitignore')):
|
|
output_content.append('├── .gitignore\n')
|
|
|
|
output_content.append(tree_structure + '\n' + '```\n')
|
|
logging.debug('Tree structure written to output content')
|
|
|
|
for root, _, files in os.walk(path):
|
|
for filename in files:
|
|
file_path = os.path.join(root, filename)
|
|
relative_path = os.path.relpath(file_path, path)
|
|
|
|
if should_ignore_file(
|
|
file_path,
|
|
relative_path,
|
|
gitignore_spec,
|
|
content_ignore_spec,
|
|
tree_and_content_ignore_spec
|
|
):
|
|
continue
|
|
|
|
relative_path = relative_path.replace('./', '', 1)
|
|
|
|
output_content.append(f'\nContents of {relative_path}:\n')
|
|
output_content.append('```\n')
|
|
try:
|
|
with open(file_path, 'r', encoding='utf-8') as f:
|
|
output_content.append(f.read())
|
|
except UnicodeDecodeError:
|
|
logging.debug('Could not decode file contents: %s', file_path)
|
|
output_content.append('[Could not decode file contents]\n')
|
|
output_content.append('\n```\n')
|
|
|
|
output_content.append('\n')
|
|
logging.debug('Repository contents written to output content')
|
|
|
|
return ''.join(output_content)
|
|
|
|
def write_output_to_file(output_content: str, output_dir: Optional[str]) -> str:
|
|
"""Write the output content to a file."""
|
|
timestamp = datetime.now(timezone.utc).strftime('%Y-%m-%d-%H-%M-%S-UTC')
|
|
output_file = f'repo-to-text_{timestamp}.txt'
|
|
|
|
if output_dir:
|
|
if not os.path.exists(output_dir):
|
|
os.makedirs(output_dir)
|
|
output_file = os.path.join(output_dir, output_file)
|
|
|
|
with open(output_file, 'w', encoding='utf-8') as file:
|
|
file.write(output_content)
|
|
|
|
return output_file
|
|
|
|
def copy_to_clipboard(output_content: str) -> None:
|
|
"""Copy the output content to the clipboard if possible."""
|
|
try:
|
|
import importlib.util # pylint: disable=import-outside-toplevel
|
|
spec: Optional[ModuleSpec] = importlib.util.find_spec("pyperclip")
|
|
if spec:
|
|
import pyperclip # pylint: disable=import-outside-toplevel # type: ignore
|
|
pyperclip.copy(output_content) # type: ignore
|
|
logging.debug('Repository structure and contents copied to clipboard')
|
|
else:
|
|
print("Tip: Install 'pyperclip' package to enable automatic clipboard copying:")
|
|
print(" pip install pyperclip")
|
|
except ImportError as e:
|
|
logging.warning(
|
|
'Could not copy to clipboard. You might be running this '
|
|
'script over SSH or without clipboard support.'
|
|
)
|
|
logging.debug('Clipboard copy error: %s', e)
|