diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..b1ce0b75 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,7 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git*,*.svg,go.sum,.codespellrc,vendor,i18n,Keybindings_*.md +check-hidden = true +# camel-cased +ignore-regex = (\b[A-Za-z][a-z]*[A-Z]\S+\b|\.edn\b|\S+…|\\nd\b) +ignore-words-list = fomrat,inbetween diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 00000000..b026c855 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,25 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [master] + pull_request: + branches: [master] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Annotate locations with typos + uses: codespell-project/codespell-problem-matcher@v1 + - name: Codespell + uses: codespell-project/actions-codespell@v2 diff --git a/.goreleaser.yml b/.goreleaser.yml index 232c385c..a2e71beb 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -81,7 +81,7 @@ brews: # 386: x86 # amd64: x86_64 # -# # Wether to publish the snap to the snapcraft store. +# # Whether to publish the snap to the snapcraft store. # # Remember you need to `snapcraft login` first. # # Defaults to false. # publish: false diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md index 308f11a1..7cd70690 100644 --- a/CODE-OF-CONDUCT.md +++ b/CODE-OF-CONDUCT.md @@ -6,7 +6,7 @@ In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal +level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards diff --git a/README.md b/README.md index 97967d36..48c77d77 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ A simple terminal UI for both docker and docker-compose, written in Go with the ## Elevator Pitch -Minor rant incoming: Something's not working? Maybe a service is down. `docker-compose ps`. Yep, it's that microservice that's still buggy. No issue, I'll just restart it: `docker-compose restart`. Okay now let's try again. Oh wait the issue is still there. Hmm. `docker-compose ps`. Right so the service must have just stopped immediately after starting. I probably would have known that if I was reading the log stream, but there is a lot of clutter in there from other services. I could get the logs for just that one service with `docker compose logs --follow myservice` but that dies everytime the service dies so I'd need to run that command every time I restart the service. I could alternatively run `docker-compose up myservice` and in that terminal window if the service is down I could just `up` it again, but now I've got one service hogging a terminal window even after I no longer care about its logs. I guess when I want to reclaim the terminal realestate I can do `ctrl+P,Q`, but... wait, that's not working for some reason. Should I use ctrl+C instead? I can't remember if that closes the foreground process or kills the actual service. +Minor rant incoming: Something's not working? Maybe a service is down. `docker-compose ps`. Yep, it's that microservice that's still buggy. No issue, I'll just restart it: `docker-compose restart`. Okay now let's try again. Oh wait the issue is still there. Hmm. `docker-compose ps`. Right so the service must have just stopped immediately after starting. I probably would have known that if I was reading the log stream, but there is a lot of clutter in there from other services. I could get the logs for just that one service with `docker compose logs --follow myservice` but that dies every time the service dies so I'd need to run that command every time I restart the service. I could alternatively run `docker-compose up myservice` and in that terminal window if the service is down I could just `up` it again, but now I've got one service hogging a terminal window even after I no longer care about its logs. I guess when I want to reclaim the terminal realestate I can do `ctrl+P,Q`, but... wait, that's not working for some reason. Should I use ctrl+C instead? I can't remember if that closes the foreground process or kills the actual service. What a headache! diff --git a/pkg/gui/menu_panel.go b/pkg/gui/menu_panel.go index 99c65807..18f588b0 100644 --- a/pkg/gui/menu_panel.go +++ b/pkg/gui/menu_panel.go @@ -28,7 +28,7 @@ func (gui *Gui) getMenuPanel() *panels.SideListPanel[*types.MenuItem] { return gui.resizePopupPanel(gui.Views.Menu) }, // so that we can avoid some UI trickiness, the menu will not have filtering - // abillity yet. To support it, we would need to have filter state against + // ability yet. To support it, we would need to have filter state against // each panel (e.g. for when you filter the images panel, then bring up // the options menu, then try to filter that too. DisableFilter: true, diff --git a/pkg/tasks/tasks.go b/pkg/tasks/tasks.go index 06fac38f..38f444d3 100644 --- a/pkg/tasks/tasks.go +++ b/pkg/tasks/tasks.go @@ -133,7 +133,7 @@ func (t *TaskManager) NewTickerTask(duration time.Duration, before func(ctx cont t.Log.Info("exiting ticker task due to notifyStopped channel") return case <-ctx.Done(): - t.Log.Info("exiting ticker task due to stopped cahnnel") + t.Log.Info("exiting ticker task due to stopped channel") return case <-tickChan.C: t.Log.Info("running ticker task again")