Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .cspell/custom-dictionary.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Custom Dictionary Words
Errorf
goexit
golangci
myapp
Println
retryable
Retryable
uintptr
2 changes: 1 addition & 1 deletion .github/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
go-version: "${{ steps.settings.outputs.go_version }}"
check-latest: true
- name: Cache Go modules
uses: actions/cache@v4
uses: actions/cache@v5
with:
path: |
~/go/pkg/mod
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/go.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6

- name: Set up Go
uses: actions/setup-go@v6
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
go-version: "${{ steps.settings.outputs.go_version }}"
check-latest: true
- name: Cache Go modules
uses: actions/cache@v4
uses: actions/cache@v5
with:
path: |
~/go/pkg/mod
Expand All @@ -45,4 +45,4 @@ jobs:
go install mvdan.cc/gofumpt@latest
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b "$(go env GOPATH)/bin" "${{ steps.settings.outputs.golangci_lint_version }}"
- name: Run pre-commit
run: pre-commit run --all-files
run: pre-commit run --config .pre-commit-ci-config.yaml --all-files
Copy link

Copilot AI Dec 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow references a configuration file .pre-commit-ci-config.yaml that does not appear to exist in the repository. This will cause the pre-commit workflow to fail when it tries to run with a non-existent config file.

Suggested change
run: pre-commit run --config .pre-commit-ci-config.yaml --all-files
run: pre-commit run --all-files

Copilot uses AI. Check for mistakes.
2 changes: 1 addition & 1 deletion .github/workflows/security.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
go-version: "${{ steps.settings.outputs.go_version }}"
check-latest: true
- name: Cache Go modules
uses: actions/cache@v4
uses: actions/cache@v5
with:
path: |
~/go/pkg/mod
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
go-version: "${{ steps.settings.outputs.go_version }}"
check-latest: true
- name: Cache Go modules
uses: actions/cache@v4
uses: actions/cache@v5
with:
path: |
~/go/pkg/mod
Expand All @@ -37,7 +37,7 @@ jobs:
- name: Test (race + coverage)
run: go test -race -coverprofile=coverage.out ./...
- name: Upload coverage artifact
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v6
with:
name: coverage
path: coverage.out
7 changes: 7 additions & 0 deletions .mdl_style.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
all
# Parameters: line_length, ignore_code_blocks, code_blocks, tables (number; default 80, boolean; default false, boolean; default true, boolean; default true)
exclude_rule 'MD013'
# default in next version, remove then
rule 'MD007', :indent => 3

rule "MD029", style => "one"
1 change: 1 addition & 0 deletions .mdlrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
style '.mdl_style.rb'
67 changes: 67 additions & 0 deletions .pre-commit-ci-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: check-json
- id: pretty-format-json
exclude: cspell.json
- id: end-of-file-fixer
- id: mixed-line-ending
- id: trailing-whitespace
- id: fix-byte-order-marker
- id: check-executables-have-shebangs
- id: debug-statements
- id: check-yaml
files: .*\.(yaml|yml)$
exclude: mkdocs.yml
args: [--allow-multiple-documents]
- id: requirements-txt-fixer
- repo: https://github.com/adrienverge/yamllint.git
rev: v1.37.1
hooks:
- id: yamllint
files: \.(yaml|yml)$
types: [file, yaml]
entry: yamllint --strict -f parsable
- repo: https://github.com/hadolint/hadolint
rev: v2.14.0
hooks:
- id: hadolint-docker
- repo: https://github.com/streetsidesoftware/cspell-cli
rev: v9.3.3
hooks:
# Spell check changed files
- id: cspell
# Spell check the commit message
- id: cspell
name: check commit message spelling
args:
- --no-must-find-files
- --no-progress
- --no-summary
- --files
- .git/COMMIT_EDITMSG
stages: [commit-msg]
always_run: true
- repo: https://github.com/markdownlint/markdownlint.git
rev: v0.15.0
hooks:
- id: markdownlint
name: Markdownlint
description: Run markdownlint on your Markdown files
entry: mdl
language: ruby
files: \.(md|mdown|markdown)$
- repo: local
hooks:
- id: go-verify
name: go-verify
language: system
entry: ./.pre-commit/go-mod-hook
require_serial: true
- id: gci
name: gci
language: system
entry: ./.pre-commit/gci-hook
require_serial: true
11 changes: 8 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,21 @@ repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: check-merge-conflict
- id: check-json
- id: pretty-format-json
- id: end-of-file-fixer
- id: trailing-whitespace
- id: mixed-line-ending
- id: trailing-whitespace
- id: fix-byte-order-marker
- id: check-executables-have-shebangs
- id: check-merge-conflict
- id: debug-statements
- id: check-yaml
files: .*\.(yaml|yml)$
exclude: mkdocs.yml
args: [--allow-multiple-documents]
- id: requirements-txt-fixer
- id: no-commit-to-branch
- repo: https://github.com/adrienverge/yamllint.git
rev: v1.37.1
hooks:
Expand All @@ -25,7 +30,7 @@ repos:
hooks:
- id: hadolint-docker
- repo: https://github.com/streetsidesoftware/cspell-cli
rev: v9.3.3
rev: v9.4.0
hooks:
# Spell check changed files
- id: cspell
Expand Down
22 changes: 11 additions & 11 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"recommendations": [
"github.vscode-github-actions",
"golang.go",
"ms-vscode.makefile-tools",
"esbenp.prettier-vscode",
"pbkit.vscode-pbkit",
"trunk.io",
"streetsidesoftware.code-spell-checker",
"ms-azuretools.vscode-docker",
"eamodio.gitlens"
]
"recommendations": [
"github.vscode-github-actions",
"golang.go",
"ms-vscode.makefile-tools",
"esbenp.prettier-vscode",
"pbkit.vscode-pbkit",
"trunk.io",
"streetsidesoftware.code-spell-checker",
"ms-azuretools.vscode-docker",
"eamodio.gitlens"
]
}
137 changes: 1 addition & 136 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,138 +1,3 @@
{
"makefile.configureOnOpen": false,
"cSpell.words": [
"arithmatex",
"asasalint",
"asciicheck",
"azuretools",
"benchmem",
"betterem",
"bidichk",
"bodyclose",
"canonicalheader",
"containedctx",
"contextcheck",
"copyloopvar",
"Cosentino",
"cpuprofile",
"cyclop",
"daixiang",
"decorder",
"depguard",
"dupl",
"dupword",
"durationcheck",
"eamodio",
"emperror",
"errcheck",
"errchkjson",
"errname",
"errorlint",
"esbenp",
"ewrap",
"fatcontext",
"fieldalignment",
"fontawesome",
"forbidigo",
"forcetypeassert",
"Francesco",
"funlen",
"ginkgolinter",
"GITVERSION",
"gocheckcompilerdirectives",
"gochecknoglobals",
"gochecknoinits",
"gochecksumtype",
"gocognit",
"goconst",
"gocritic",
"gocyclo",
"godox",
"GOFILES",
"gofmt",
"gofumpt",
"goheader",
"goimports",
"golangci",
"GOMAXPROCS",
"gomoddirectives",
"gomodguard",
"GOPATH",
"goprintffuncname",
"gosec",
"gosimple",
"gosmopolitan",
"govet",
"honnef",
"importas",
"inamedparam",
"ineffassign",
"inlinehilite",
"interfacebloat",
"intrange",
"ireturn",
"linenums",
"loggercheck",
"logrus",
"magiclink",
"maintidx",
"makezero",
"memprofile",
"mkdocs",
"multierror",
"musttag",
"mvdan",
"nakedret",
"nestif",
"Newf",
"nilerr",
"nilnil",
"nlreturn",
"noctx",
"nolint",
"nolintlint",
"nonamedreturns",
"nosprintfhostport",
"NOVENDOR",
"paralleltest",
"pbkit",
"perfsprint",
"prealloc",
"predeclared",
"promlinter",
"proto",
"protogetter",
"pygments",
"pymdownx",
"rowserrcheck",
"sirupsen",
"sloglint",
"smartsymbols",
"spancheck",
"sqlclosecheck",
"staticcheck",
"stdlib",
"stretchr",
"stylecheck",
"superfences",
"tasklist",
"tenv",
"testableexamples",
"testifylint",
"testpackage",
"thelper",
"toplevel",
"tparallel",
"typecheck",
"unconvert",
"unparam",
"usestdlibvars",
"varnamelen",
"wastedassign",
"wrapcheck",
"Wrapf",
"zaptest",
"zerolog",
"zerologlint"
]
"makefile.configureOnOpen": false
}
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ ewrap.RegisterGlobalObserver(myObserver)
git clone https://github.com/hyp3rd/ewrap.git
```

2. Install VS Code Extensions Recommended (optional):
1. Install VS Code Extensions Recommended (optional):

```json
{
Expand All @@ -424,15 +424,15 @@ ewrap.RegisterGlobalObserver(myObserver)
```

1. Install [**Golang**](https://go.dev/dl).
2. Install [**GitVersion**](https://github.com/GitTools/GitVersion).
3. Install [**Make**](https://www.gnu.org/software/make/), follow the procedure for your OS.
4. **Set up the toolchain:**
1. Install [**GitVersion**](https://github.com/GitTools/GitVersion).
1. Install [**Make**](https://www.gnu.org/software/make/), follow the procedure for your OS.
1. **Set up the toolchain:**

```bash
make prepare-toolchain
```

5. Initialize `pre-commit` (strongly recommended to create a virtual env, using for instance [PyEnv](https://github.com/pyenv/pyenv)) and its hooks:
1. Initialize `pre-commit` (strongly recommended to create a virtual env, using for instance [PyEnv](https://github.com/pyenv/pyenv)) and its hooks:

```bash
pip install pre-commit
Expand Down Expand Up @@ -477,10 +477,10 @@ ewrap.RegisterGlobalObserver(myObserver)
## Contributing

1. Fork the repository
2. Create your feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request
1. Create your feature branch
1. Commit your changes
1. Push to the branch
1. Create a Pull Request

Refer to [CONTRIBUTING](CONTRIBUTING.md) for more information.

Expand Down
Loading
Loading