mirror of
https://github.com/ivuorinen/gibidify.git
synced 2026-01-26 03:24:05 +00:00
chore(lint): replace docker-based precommit (#29)
This commit is contained in:
@@ -1,10 +1,9 @@
|
||||
repos:
|
||||
- repo: https://github.com/oxsecurity/megalinter
|
||||
rev: v8.4.2 # Git tag specifying the hook, not mega-linter-runner, version
|
||||
- repo: https://github.com/golangci/golangci-lint
|
||||
rev: v1.57.2
|
||||
hooks:
|
||||
- id: megalinter-incremental # Faster, less thorough
|
||||
stages:
|
||||
- pre-commit
|
||||
- id: golangci-lint
|
||||
args: ["--timeout=5m"]
|
||||
- repo: https://github.com/tekwizely/pre-commit-golang
|
||||
rev: v1.0.0-rc.1
|
||||
hooks:
|
||||
|
||||
16
README.md
16
README.md
@@ -26,9 +26,23 @@ go build -o gibidify .
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
./gibidify -source <source_directory> -destination <output_file> [--prefix="..."] [--suffix="..."]
|
||||
./gibidify \
|
||||
-source <source_directory> \
|
||||
-destination <output_file> \
|
||||
-format markdown|json|yaml \
|
||||
-concurrency <num_workers> \
|
||||
--prefix="..." \
|
||||
--suffix="..."
|
||||
```
|
||||
|
||||
Flags:
|
||||
|
||||
- `-source`: directory to scan.
|
||||
- `-destination`: output file path (optional; defaults to `<source>.<format>`).
|
||||
- `-format`: output format (`markdown`, `json`, or `yaml`).
|
||||
- `-concurrency`: number of concurrent workers.
|
||||
- `--prefix` / `--suffix`: optional text blocks.
|
||||
|
||||
## Docker
|
||||
|
||||
A Docker image can be built using the provided Dockerfile:
|
||||
|
||||
Reference in New Issue
Block a user