Lint file names and directories via cSpell too (#3703)

2024-10-31 22:38:49 +00:00 · 2024-05-14 02:45:03 +02:00 · 2024-05-14 02:45:03 +02:00 · 7b3b09d628
commit 7b3b09d628
parent 89e100cfd1
7 changed files with 125 additions and 100 deletions
--- a/.cspell.json
+++ b/.cspell.json
@ -2,120 +2,139 @@
  "version": "0.2",
  "language": "en",
  "words": [
-    "ciphertext",
-    "evenodd",
-    "gitea",
-    "gonic",
+    "BUILDPLATFORM",
+    "Codeberg",
+    "Curr",
+    "DATASOURCE",
+    "Debugf",
+    "Fediverse",
+    "Fogas",
+    "GOARCH",
+    "GOBIN",
+    "GODEBUG",
+    "GOPATH",
+    "Georgiana",
+    "HEALTHCHECK",
+    "HTTPFS",
+    "Hetzner",
+    "Infof",
+    "Ionescu",
+    "Kaniko",
+    "Keyfunc",
+    "Laszlo",
+    "Msgf",
    "Netrc",
-    "prismjs",
-    "rawurl",
+    "PROTOC",
+    "Pinia",
+    "Println",
    "Refspec",
+    "Reviewdog",
+    "Rydzewski",
+    "TARGETARCH",
+    "TARGETOS",
+    "Upsert",
+    "WORKDIR",
+    "Warnf",
+    "Weblate",
+    "Wrapf",
+    "anbraten",
+    "autoincr",
+    "autoscaler",
+    "binutils",
+    "bitbucketdatacenter",
+    "bradrydzewski",
+    "brightbox",
+    "buildx",
+    "ccmenu",
+    "charmbracelet",
+    "ciphertext",
+    "compatiblelicenses",
+    "corepack",
+    "creativecommons",
+    "datacenter",
+    "desaturate",
+    "devx",
+    "doublestar",
+    "envsubst",
+    "estree",
+    "evenodd",
+    "excalidraw",
+    "favicons",
+    "fsnotify",
+    "gitea",
+    "golangci",
+    "gomod",
+    "gonic",
+    "httpsig",
+    "httputil",
+    "iconify",
+    "intlify",
+    "kyvg",
+    "laszlocph",
+    "logfile",
+    "loglevel",
+    "markdownlint",
+    "multiarch",
+    "multierr",
+    "netdns",
+    "nfpm",
+    "nixos",
+    "nocolor",
+    "nolint",
+    "octocat",
+    "posix",
+    "ppid",
+    "prismjs",
+    "proto",
+    "protoc",
+    "rawurl",
+    "repology",
    "securecookie",
    "sess",
+    "stepbuilder",
+    "stretchr",
+    "sublicensable",
    "techknowlogick",
+    "testdata",
+    "tink",
+    "tinycolor",
+    "typecheck",
+    "unplugin",
+    "urfave",
+    "varchar",
+    "vite",
+    "vitejs",
    "vueuse",
+    "waivable",
+    "windi",
    "windicss",
+    "woodpeckerci",
+    "xlog",
    "xorm",
    "xormigrate",
    "zerolog",
-    "Msgf",
-    "varchar",
-    "autoincr",
-    "stretchr",
-    "bradrydzewski",
-    "octocat",
-    "brightbox",
-    "anbraten",
-    "Codeberg",
-    "Fediverse",
-    "Weblate",
-    "Hetzner",
-    "windi",
-    "intlify",
-    "unplugin",
-    "Pinia",
-    "woodpeckerci",
-    "tinycolor",
-    "favicons",
-    "Laszlo",
-    "Fogas",
-    "Georgiana",
-    "Ionescu",
-    "typecheck",
-    "HTTPFS",
-    "Println",
-    "ppid",
-    "xlog",
-    "Debugf",
-    "Warnf",
-    "Infof",
-    "Wrapf",
-    "urfave",
-    "creativecommons",
-    "compatiblelicenses",
-    "sublicensable",
-    "waivable",
-    "kyvg",
-    "iconify",
-    "Upsert",
-    "Rydzewski",
-    "fsnotify",
-    "tink",
-    "desaturate",
-    "golangci",
-    "Kaniko",
-    "Reviewdog",
-    "DATASOURCE",
-    "httpsig",
-    "envsubst",
-    "TARGETOS",
-    "TARGETARCH",
-    "GOARCH",
-    "Curr",
-    "doublestar",
-    "multierr",
-    "markdownlint",
-    "buildx",
-    "HEALTHCHECK",
-    "devx",
-    "gomod",
-    "laszlocph",
-    "charmbracelet",
-    "GODEBUG",
-    "netdns",
-    "BUILDPLATFORM",
-    "repology",
-    "WORKDIR",
-    "corepack",
-    "binutils",
-    "nocolor",
-    "logfile",
-    "Keyfunc",
-    "protoc",
-    "PROTOC",
-    "GOBIN",
-    "GOPATH"
+    "zerologger"
  ],
  "ignorePaths": [
    "**/node_modules/**/*",
-    "pnpm-lock.yaml",
-    ".gitignore",
-    ".git/**/*",
-    ".cspell.json",
-    ".golangci.yaml",
-    ".vscode/extensions.json",
-    "web/src/assets/locales/**/*",
-    "web/components.d.ts",
-    "server/store/datastore/migration/**/*",
-    "go.mod",
-    "go.sum",
    "*.excalidraw",
    "*.svg",
-    "Makefile",
-    "flake.nix",
-    "flake.lock",
-    // TODO: remove the following
+    ".cspell.json",
+    ".git/**/*",
+    ".gitignore",
+    ".golangci.yaml",
+    ".vscode/extensions.json",
    "CHANGELOG.md",
+    "Makefile",
+    "flake.lock",
+    "flake.nix",
+    "go.mod",
+    "go.sum",
+    "pnpm-lock.yaml",
+    "server/store/datastore/migration/**/*",
+    "web/components.d.ts",
+    "web/src/assets/locales/**/*",
+    // TODO: remove the following
    ".woodpecker/",
    "agent/",
    "cli/",
--- a/.woodpecker/static.yaml
+++ b/.woodpecker/static.yaml
@ -18,6 +18,8 @@ steps:
    commands:
      - corepack enable
      - pnpx cspell lint --no-progress --gitignore '{**,.*}/{*,.*}'
+      - apk add --no-cache -U tree # busybox tree dont understand "-I"
+      - tree --gitignore -I 012_columns_rename_procs_to_steps.go -I versioned_docs -I '*opensource.svg'| pnpx cspell lint --no-progress stdin

  - name: prettier
    image: docker.io/woodpeckerci/plugin-prettier:0.1.0
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -218,7 +218,7 @@
 - Remove contributing/security to use globally defined [[#3192](https://github.com/woodpecker-ci/woodpecker/pull/3192)]
 - Add "Kaniko" Plugin [[#3183](https://github.com/woodpecker-ci/woodpecker/pull/3183)]
 - Document core development ideas [[#3184](https://github.com/woodpecker-ci/woodpecker/pull/3184)]
- Add continous deployment cookbook [[#3098](https://github.com/woodpecker-ci/woodpecker/pull/3098)]
+- Add continuous deployment cookbook [[#3098](https://github.com/woodpecker-ci/woodpecker/pull/3098)]
 - Make k8s backend configuration docs in the same format as others [[#3081](https://github.com/woodpecker-ci/woodpecker/pull/3081)]
 - Hide backend config options from TOC [[#3126](https://github.com/woodpecker-ci/woodpecker/pull/3126)]
 - Add X/Twitter account [[#3127](https://github.com/woodpecker-ci/woodpecker/pull/3127)]
@ -637,7 +637,7 @@
 - Fix active tab not updating on prop change [[#2712](https://github.com/woodpecker-ci/woodpecker/pull/2712)]
 - Unique status for matrix  [[#2695](https://github.com/woodpecker-ci/woodpecker/pull/2695)]
 - Fix secret image filter regex [[#2674](https://github.com/woodpecker-ci/woodpecker/pull/2674)]
- local backend ignore errors in commands inbetween [[#2636](https://github.com/woodpecker-ci/woodpecker/pull/2636)]
+- local backend ignore errors in commands in between [[#2636](https://github.com/woodpecker-ci/woodpecker/pull/2636)]
 - Do not print log level on CLI [[#2638](https://github.com/woodpecker-ci/woodpecker/pull/2638)]
 - Fix error when closing logs [[#2637](https://github.com/woodpecker-ci/woodpecker/pull/2637)]
 - Fix `CI_WORKSPACE` in local backend [[#2627](https://github.com/woodpecker-ci/woodpecker/pull/2627)]
--- a/4
+++ b/4
@ -309,6 +309,10 @@ bundle: bundle-agent bundle-server bundle-cli ## Create all bundles
 .PHONY: spellcheck
 spellcheck:
 	pnpx cspell lint --no-progress --gitignore '{**,.*}/{*,.*}'
+	tree --gitignore \
+	  -I 012_columns_rename_procs_to_steps.go \
+	  -I versioned_docs -I '*opensource.svg' | \
+	  pnpx cspell lint --no-progress stdin

 ##@ Docs
 .PHONY: docs
--- a/docs/cookbook/2024-1-1-continuous-deployment/index.md
+++ b/docs/cookbook/2024-1-1-continuous-deployment/index.md
--- a/pipeline/frontend/metadata/substitution.go
+++ b/pipeline/frontend/metadata/substitution.go
--- a/pipeline/frontend/metadata/substitution_test.go
+++ b/pipeline/frontend/metadata/substitution_test.go