mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-02-16 01:50:14 +00:00
chore: modernize workflows, security scanning, and linting configuration (#50)
* build: update Go 1.25, CI workflows, and build tooling - Upgrade to Go 1.25 - Add benchmark targets to Makefile - Implement parallel gosec execution - Lock tool versions for reproducibility - Add shellcheck directives to scripts - Update CI workflows with improved caching * refactor: migrate from golangci-lint to revive - Replace golangci-lint with revive for linting - Configure comprehensive revive rules - Fix all EditorConfig violations - Add yamllint and yamlfmt support - Remove deprecated .golangci.yml * refactor: rename utils to shared and deduplicate code - Rename utils package to shared - Add shared constants package - Deduplicate constants across packages - Address CodeRabbit review feedback * fix: resolve SonarQube issues and add safety guards - Fix all 73 SonarQube OPEN issues - Add nil guards for resourceMonitor, backpressure, metricsCollector - Implement io.Closer for headerFileReader - Propagate errors from processing helpers - Add metrics and templates packages - Improve error handling across codebase * test: improve test infrastructure and coverage - Add benchmarks for cli, fileproc, metrics - Improve test coverage for cli, fileproc, config - Refactor tests with helper functions - Add shared test constants - Fix test function naming conventions - Reduce cognitive complexity in benchmark tests * docs: update documentation and configuration examples - Update CLAUDE.md with current project state - Refresh README with new features - Add usage and configuration examples - Add SonarQube project configuration - Consolidate config.example.yaml * fix: resolve shellcheck warnings in scripts - Use ./*.go instead of *.go to prevent dash-prefixed filenames from being interpreted as options (SC2035) - Remove unreachable return statement after exit (SC2317) - Remove obsolete gibidiutils/ directory reference * chore(deps): upgrade go dependencies * chore(lint): megalinter fixes * fix: improve test coverage and fix file descriptor leaks - Add defer r.Close() to fix pipe file descriptor leaks in benchmark tests - Refactor TestProcessorConfigureFileTypes with helper functions and assertions - Refactor TestProcessorLogFinalStats with output capture and keyword verification - Use shared constants instead of literal strings (TestFilePNG, FormatMarkdown, etc.) - Reduce cognitive complexity by extracting helper functions * fix: align test comments with function names Remove underscores from test comments to match actual function names: - benchmark/benchmark_test.go (2 fixes) - fileproc/filetypes_config_test.go (4 fixes) - fileproc/filetypes_registry_test.go (6 fixes) - fileproc/processor_test.go (6 fixes) - fileproc/resource_monitor_types_test.go (4 fixes) - fileproc/writer_test.go (3 fixes) * fix: various test improvements and bug fixes - Remove duplicate maxCacheSize check in filetypes_registry_test.go - Shorten long comment in processor_test.go to stay under 120 chars - Remove flaky time.Sleep in collector_test.go, use >= 0 assertion - Close pipe reader in benchmark_test.go to fix file descriptor leak - Use ContinueOnError in flags_test.go to match ResetFlags behavior - Add nil check for p.ui in processor_workers.go before UpdateProgress - Fix resource_monitor_validation_test.go by setting hardMemoryLimitBytes directly * chore(yaml): add missing document start markers Add --- document start to YAML files to satisfy yamllint: - .github/workflows/codeql.yml - .github/workflows/build-test-publish.yml - .github/workflows/security.yml - .github/actions/setup/action.yml * fix: guard nil resourceMonitor and fix test deadlock - Guard resourceMonitor before CreateFileProcessingContext call - Add ui.UpdateProgress on emergency stop and path error returns - Fix potential deadlock in TestProcessFile using wg.Go with defer close
This commit is contained in:
65
README.md
65
README.md
@@ -14,9 +14,11 @@ file sections with separators, and a suffix.
|
||||
- **Concurrent processing** with configurable worker pools
|
||||
- **Comprehensive configuration** via YAML with validation
|
||||
- **Production-ready** with structured error handling and benchmarking
|
||||
- **Modular architecture** - clean, focused codebase with ~63ns registry lookups
|
||||
- **Modular architecture** - clean, focused codebase (92 files, ~21.5K lines) with ~63ns registry lookups
|
||||
- **Enhanced CLI experience** - progress bars, colored output, helpful error messages
|
||||
- **Cross-platform** with Docker support
|
||||
- **Advanced template system** - 4 built-in templates (default, minimal, detailed, compact) with custom template support, variable substitution, and YAML-based configuration
|
||||
- **Comprehensive metrics and profiling** - real-time processing statistics, performance analysis, memory usage tracking, and automated recommendations
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -32,15 +34,16 @@ go build -o gibidify .
|
||||
|
||||
```bash
|
||||
./gibidify \
|
||||
-source <source_directory> \
|
||||
-destination <output_file> \
|
||||
-format markdown|json|yaml \
|
||||
-concurrency <num_workers> \
|
||||
--prefix="..." \
|
||||
--suffix="..." \
|
||||
--no-colors \
|
||||
--no-progress \
|
||||
--verbose
|
||||
-source <source_directory> \
|
||||
-destination <output_file> \
|
||||
-format markdown|json|yaml \
|
||||
-concurrency <num_workers> \
|
||||
--prefix="..." \
|
||||
--suffix="..." \
|
||||
--no-colors \
|
||||
--no-progress \
|
||||
--verbose \
|
||||
--log-level debug
|
||||
```
|
||||
|
||||
Flags:
|
||||
@@ -53,6 +56,7 @@ Flags:
|
||||
- `--no-colors`: disable colored terminal output.
|
||||
- `--no-progress`: disable progress bars.
|
||||
- `--verbose`: enable verbose output and detailed logging.
|
||||
- `--log-level`: set log level (default: warn; accepted values: debug, info, warn, error).
|
||||
|
||||
## Docker
|
||||
|
||||
@@ -66,13 +70,13 @@ Run the Docker container:
|
||||
|
||||
```bash
|
||||
docker run --rm \
|
||||
-v $(pwd):/workspace \
|
||||
-v $HOME/.config/gibidify:/config \
|
||||
ghcr.io/ivuorinen/gibidify:<tag> \
|
||||
-source /workspace/your_source_directory \
|
||||
-destination /workspace/output.txt \
|
||||
--prefix="Your prefix text" \
|
||||
--suffix="Your suffix text"
|
||||
-v $(pwd):/workspace \
|
||||
-v $HOME/.config/gibidify:/config \
|
||||
ghcr.io/ivuorinen/gibidify:<tag> \
|
||||
-source /workspace/your_source_directory \
|
||||
-destination /workspace/output.txt \
|
||||
--prefix="Your prefix text" \
|
||||
--suffix="Your suffix text"
|
||||
```
|
||||
|
||||
## Configuration
|
||||
@@ -123,6 +127,33 @@ backpressure:
|
||||
maxPendingWrites: 100 # Max writes in write channel buffer
|
||||
maxMemoryUsage: 104857600 # 100MB max memory usage
|
||||
memoryCheckInterval: 1000 # Check memory every 1000 files
|
||||
|
||||
# Output and template customization
|
||||
output:
|
||||
# Template selection: default, minimal, detailed, compact, or custom
|
||||
# Templates control output structure and formatting
|
||||
template: "default"
|
||||
# Metadata options
|
||||
metadata:
|
||||
includeStats: true
|
||||
includeTimestamp: true
|
||||
includeFileCount: true
|
||||
includeSourcePath: true
|
||||
includeMetrics: true
|
||||
# Markdown-specific options
|
||||
markdown:
|
||||
useCodeBlocks: true
|
||||
includeLanguage: true
|
||||
headerLevel: 2
|
||||
tableOfContents: false
|
||||
useCollapsible: false
|
||||
syntaxHighlighting: true
|
||||
lineNumbers: false
|
||||
# Custom template variables
|
||||
variables:
|
||||
project_name: "My Project"
|
||||
author: "Developer Name"
|
||||
version: "1.0.0"
|
||||
```
|
||||
|
||||
See `config.example.yaml` for a comprehensive configuration example.
|
||||
|
||||
Reference in New Issue
Block a user