🧹 chore: Add spell check CI workflow by gaby · Pull Request #3814 · gofiber/fiber

gaby · 2025-10-22T03:45:41Z

Summary

Automated spell checking to the CI/CD pipeline using cspell. The workflow runs on pull requests

coderabbitai · 2025-10-22T03:45:50Z

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

This PR performs documentation improvements and minor code cleanup across multiple files: grammar corrections in comments ("unmarshals" to "unmarshal"), variable naming consistency (newval to newValue), documentation wording refinements, example value updates, and typo fixes.

Changes

Cohort / File(s)	Summary
Client response code and documentation `client/response.go`, `docs/client/response.md`	Updated comment grammar from "unmarshals" to "unmarshal" for JSON, CBOR, and XML method documentation
Documentation examples `docs/api/log.md`, `docs/client/request.md`	Updated example values: "Master Shifu" → "John Smith" in logging examples; JSON parameter name "efectn" → "joe" in request example
Learning resources documentation `docs/extra/learning-resources.md`	Refined wording: "master Fiber concepts" → "learn Fiber concepts"; "Master input validation" → "Input validation"; improved resource descriptions
Middleware configuration documentation `middleware/cors/config.go`, `middleware/redirect/config.go`, `middleware/rewrite/config.go`	Updated documentation comments: "subdomains wildcarding" → "wildcard matching for subdomains" (CORS); example path "/public/javascripts/$1" → "/public/javascript/$1" (redirect and rewrite)
Code cleanup and typo fixes `helpers.go`, `middleware/adaptor/adaptor.go`, `path.go`, `req.go`	Variable renaming (newval → newValue); comment corrections (removed extra 'k' in "checkk"); nolint directive clarification; attribution URL update

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

All changes are cosmetic, involving grammar corrections, wording refinements, example data updates, and variable naming consistency
No logic changes, control flow modifications, or functional behavior alterations
Homogeneous nature of edits (repeated pattern of comment/documentation improvements) reduces review complexity

Possibly related PRs

📒 docs: Add Learning Resources section with Go Interview Practice platform #3691: Modifies the same documentation file with related wording changes ("master" to "learn" terminology)
📒 docs: Full audit of documentation #3717: Changes the same "unmarshals" to "unmarshal" grammar in overlapping files
Bump golangci-lint to v1.62.0 #3196: Edits the same nolint comment line in middleware/adaptor/adaptor.go

Suggested reviewers

sixcolors
ReneWerner87
efectn

Poem

A rabbit hops through the code with glee, 🐰
Fixing typos and grammar with care so keen,
From "unmarshals" to "unmarshal," the paths align clean,
newValue bounds with newval's plight—consistency reigns supreme!
Through docs and helpers, we polish with pride. ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The PR description is largely incomplete compared to the required template. The provided description contains only a brief summary sentence under "Summary" covering the general intent, but it lacks the required structure including a detailed Description section explaining the purpose and benefits, a "Fixes" section for issue references, a "Changes introduced" section with marked checkboxes (Benchmarks, Documentation Update, Changelog, Migration Guide, etc.), a "Type of change" section with selections, and completion of the Checklist items. This represents a significant departure from the template's comprehensive structure.	Expand the PR description to follow the template structure. Include a detailed Description section explaining the purpose and benefits of adding the spell-check workflow, mark relevant checkboxes under "Changes introduced" (such as Documentation Update if docs were corrected), select the appropriate "Type of change" (likely "Code consistency" or "Enhancement"), confirm the Checklist items have been addressed, and reference any related issues with "Fixes #" if applicable.
Docstring Coverage	⚠️ Warning	Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.
Title Check	❓ Inconclusive	The PR title claims to "Add spell check CI workflow," suggesting the primary change is introducing a new CI/CD workflow file for spell checking. However, the raw_summary shows only corrections across existing source code and documentation files—no workflow file appears in the provided changeset. The changes visible are spell-check corrections (e.g., "unmarshals" → "unmarshal," "Master Shifu" → "John Smith," "static checkk" → "static check"), which appear to be the results of spell checking rather than the addition of the workflow infrastructure itself. This creates a disconnect between what the title claims and what the provided summary shows.	Clarify whether the PR includes the actual spell-check workflow file (which should appear in the changeset summary) or if the title should be adjusted to reflect that this PR contains only the spell-check corrections rather than the workflow addition itself. If the workflow file exists but isn't shown in the summary, confirm the summary is complete; otherwise, revise the title to accurately describe the actual changes.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch add-github-workflow-for-cspell-action

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ba9d619 and ce77897.

⛔ Files ignored due to path filters (11)

.cspell.json is excluded by !**/*.json
.github/workflows/benchmark.yml is excluded by !**/*.yml
.github/workflows/codeql-analysis.yml is excluded by !**/*.yml
.github/workflows/linter.yml is excluded by !**/*.yml
.github/workflows/markdown.yml is excluded by !**/*.yml
.github/workflows/modernize.yml is excluded by !**/*.yml
.github/workflows/release-drafter.yml is excluded by !**/*.yml
.github/workflows/spell-check.yml is excluded by !**/*.yml
.github/workflows/sync-docs.yml is excluded by !**/*.yml
.github/workflows/test.yml is excluded by !**/*.yml
.github/workflows/vulncheck.yml is excluded by !**/*.yml

📒 Files selected for processing (12)

client/response.go (1 hunks)
docs/api/log.md (2 hunks)
docs/client/request.md (1 hunks)
docs/client/response.md (2 hunks)
docs/extra/learning-resources.md (2 hunks)
helpers.go (1 hunks)
middleware/adaptor/adaptor.go (1 hunks)
middleware/cors/config.go (1 hunks)
middleware/redirect/config.go (1 hunks)
middleware/rewrite/config.go (1 hunks)
path.go (1 hunks)
req.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.go

📄 CodeRabbit inference engine (AGENTS.md)

**/*.go: Apply formatting using gofumpt (Make target: format)
Optimize struct field alignment using betteralign (Make target: betteralign)
Modernize code using gopls modernize (Make target: modernize)

Files:

middleware/redirect/config.go
client/response.go
middleware/cors/config.go
middleware/adaptor/adaptor.go
helpers.go
req.go
path.go
middleware/rewrite/config.go

docs/**

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Review and update the contents of the docs folder if necessary when modifying code

Files:

docs/client/request.md
docs/extra/learning-resources.md
docs/client/response.md
docs/api/log.md

🧠 Learnings (6)

📚 Learning: 2024-11-15T07:56:21.623Z

Learnt from: ReneWerner87
PR: gofiber/fiber#3161
File: app.go:923-932
Timestamp: 2024-11-15T07:56:21.623Z
Learning: In the Fiber framework, breaking changes are acceptable when moving from version 2 to version 3, including modifications to method signatures such as in the `Test` method in `app.go`.

Applied to files:

docs/extra/learning-resources.md

📚 Learning: 2025-05-13T00:19:16.407Z

Learnt from: sixcolors
PR: gofiber/fiber#3446
File: docs/middleware/logger.md:44-44
Timestamp: 2025-05-13T00:19:16.407Z
Learning: In documentation files for the Fiber framework, code examples are often partial and don't repeat import statements that were shown in earlier examples, focusing instead on demonstrating specific usage patterns.

Applied to files:

docs/extra/learning-resources.md

📚 Learning: 2025-10-16T07:15:26.529Z

Learnt from: grivera64
PR: gofiber/fiber#3807
File: adapter_test.go:118-144
Timestamp: 2025-10-16T07:15:26.529Z
Learning: In Fiber v3, net/http handlers (http.Handler, http.HandlerFunc, or raw func(http.ResponseWriter, *http.Request)) can be passed directly to routing methods like app.Get(), app.Post(), etc. The framework automatically detects and wraps them internally via toFiberHandler/collectHandlers. The github.com/gofiber/fiber/v3/middleware/adaptor package is legacy and should not be suggested for tests or code using native net/http handler support.

Applied to files:

docs/extra/learning-resources.md
path.go

📚 Learning: 2025-10-16T07:19:52.418Z

Learnt from: grivera64
PR: gofiber/fiber#3807
File: adapter_test.go:118-144
Timestamp: 2025-10-16T07:19:52.418Z
Learning: In the Fiber codebase, the linter does not allow `require` assertions from within HTTP handlers (including net/http-style handlers). Use `t.Fatalf`, `t.Errorf`, or similar `testing.T` methods for error handling inside handler functions instead.

Applied to files:

docs/extra/learning-resources.md
req.go

📚 Learning: 2024-11-10T23:44:13.704Z

Learnt from: gaby
PR: gofiber/fiber#3193
File: middleware/adaptor/adaptor.go:111-111
Timestamp: 2024-11-10T23:44:13.704Z
Learning: In the `middleware/adaptor/adaptor.go` file of the Fiber framework, when updating context handling, replacing `c.Context()` with `c.RequestCtx()` is appropriate to access the `fasthttp.RequestCtx`.

Applied to files:

middleware/adaptor/adaptor.go

📚 Learning: 2024-10-08T19:06:06.583Z

Learnt from: sixcolors
PR: gofiber/fiber#3016
File: middleware/session/config.go:122-122
Timestamp: 2024-10-08T19:06:06.583Z
Learning: In `DefaultErrorHandler(c *fiber.Ctx, err error)`, since `c` is a pointer to an interface, we need to dereference `*c` when calling interface methods like `SendStatus`.

Applied to files:

req.go

🧬 Code graph analysis (1)

req.go (2)

res.go (1)

DefaultRes (125-127)

constants.go (1)

StatusNotImplemented (104-104)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: repeated
GitHub Check: Compare

🔇 Additional comments (10)

middleware/redirect/config.go (1)

20-20: LGTM! Documentation example updated.

The path example has been simplified from "javascripts" to "javascript", which is a reasonable standardization.

middleware/rewrite/config.go (1)

20-20: LGTM! Consistent documentation update.

This change aligns with the same update in middleware/redirect/config.go, maintaining consistency across related middleware examples.

docs/client/request.md (1)

403-403: LGTM! Documentation example updated.

The example value change from "efectn" to "joe" uses a more generic name for documentation purposes.

middleware/cors/config.go (1)

24-24: LGTM! Documentation clarity improved.

The revised wording "wildcard matching for subdomains" is clearer and more idiomatic than "subdomains wildcarding".

middleware/adaptor/adaptor.go (1)

242-242: LGTM! Minor comment clarification.

The nolint comment explanation has been updated for clarity. The actual linter directives (forcetypeassert,errcheck) remain unchanged.

path.go (1)

4-4: LGTM! Improved attribution.

Updating the comment to reference the actual GitHub URL provides clearer attribution to the original source.

docs/api/log.md (1)

81-81: Documentation example values updated for consistency.

The changes update example names in the formatted and key-value logging code snippets, improving consistency across documentation examples. These are documentation-only changes with no impact on API behavior.

Also applies to: 93-93

req.go (1)

176-179: Comment typo corrected.

Line 178 fixes a typo in the nolint directive comment ("static checkk" → "static check"). This is a minor spelling correction with no functional impact.

helpers.go (1)

62-67: Variable naming improved to follow Go conventions.

The variable newval is renamed to newValue across all three usages, making the naming consistent with Go idioms (camelCase). This is a non-functional refactor that improves code readability.

docs/extra/learning-resources.md (1)

5-5: Documentation wording refined for clarity and inclusivity.

The updates improve documentation phrasing: "master" is replaced with "learn" (more inclusive), and minor text enhancements make the content clearer. These are editorial improvements with no functional impact.

Also applies to: 15-15, 23-23

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

codecov · 2025-10-22T03:47:16Z

Codecov Report

❌ Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 92.19%. Comparing base (ba9d619) to head (ce77897).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
helpers.go	66.66%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3814      +/-   ##
==========================================
- Coverage   92.25%   92.19%   -0.07%     
==========================================
  Files         115      115              
  Lines        9734     9734              
==========================================
- Hits         8980     8974       -6     
- Misses        480      485       +5     
- Partials      274      275       +1

Flag	Coverage Δ
unittests	`92.19% <80.00%> (-0.07%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull Request Overview

This PR adds automated spell checking to the CI/CD pipeline using cspell. The workflow runs on pull requests and pushes to main/master branches, checking spelling across multiple file types with specialized dictionaries for different programming languages and technologies.

Key Changes:

Adds GitHub Actions workflow for spell checking with cspell
Configures cspell with comprehensive dictionary support for multiple languages and tools
Sets up file type-specific spell checking rules

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
`.github/workflows/spellcheck.yml`	GitHub Actions workflow configuration for running cspell on PRs and main branch pushes
`.cspell.json`	cspell configuration with dictionaries, ignore patterns, and file-specific overrides

Added 'internal', 'go.mod', and 'go.sum' to ignorePaths and words.

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.50.

Benchmark suite	Current: `6cb5998`	Previous: `534aa88`	Ratio
`Benchmark_Compress_Levels_Parallel/Zstd_LevelDefault - B/op`	`1` B/op	`0` B/op	`+∞`

This comment was automatically generated by workflow using github-action-benchmark.

gaby · 2025-10-29T04:00:02Z

@codex review

gaby · 2025-10-29T04:00:14Z

/gemini review

gemini-code-assist

Code Review

This pull request introduces automated spell checking with cspell, which is a great addition for maintaining code and documentation quality. The changes mostly consist of fixing typos and adjusting wording based on the spell checker's feedback. I've found a few instances where the grammatical corrections were incorrect and have suggested fixes. I also have a suggestion for the cspell configuration to include test files in the spell check scope.

.cspell.json

client/response.go

docs/client/response.md

middleware/cors/config.go

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

.cspell.json

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

.cspell.json

Add common misspellings dictionary to cspell setup

769c310

gaby added the codex label Oct 22, 2025 — with ChatGPT Codex Connector

gaby changed the title ~~Add common misspellings dictionary to cspell setup~~ 🧹 chore: Add spellcheck ci workflow Oct 22, 2025

Rename job and update Node.js setup action

af0f444

gaby changed the title ~~🧹 chore: Add spellcheck ci workflow~~ 🧹 chore: Add spell check CI workflow Oct 22, 2025

Remove npm cache from Node.js setup

f6870db

gaby requested a review from Copilot October 22, 2025 03:53

gaby added 🧹 Updates v3 labels Oct 22, 2025

gaby added this to v3 Oct 22, 2025

Copilot AI reviewed Oct 22, 2025

View reviewed changes

gaby added this to the v3 milestone Oct 22, 2025

gaby added 16 commits October 21, 2025 23:56

Update spellcheck workflow configuration

38bdb9a

Update .cspell.json to include new ignore patterns

9a0fb2a

Added 'internal', 'go.mod', and 'go.sum' to ignorePaths and words.

Update spell check workflow

b8eca2c

Simplify config

7639733

Ignore unknown words, add EN-GB locale

6942778

fix typo

81bc9b9

add golang dict

bada126

updates

1683aaf

Merge branch 'main' into add-github-workflow-for-cspell-action

a1e6820

update cspell config

b7a584d

cspell updates

5ed104b

Ignore test files

2a6145e

update ignoreword list

459c3b8

update cspell config

9f54004

update cspell

f9f7f58

update config

e5824c0

update config

6cb5998

github-actions bot reviewed Oct 23, 2025

View reviewed changes

Update .cspell.json

4e9f985

gaby mentioned this pull request Oct 23, 2025

Q: How to check only typos? streetsidesoftware/cspell-action#2466

Closed

gaby moved this to In Progress in v3 Oct 23, 2025

Merge branch 'main' into add-github-workflow-for-cspell-action

3a9b30e

gemini-code-assist bot reviewed Oct 29, 2025

View reviewed changes

chatgpt-codex-connector bot reviewed Oct 29, 2025

View reviewed changes

.cspell.json Show resolved Hide resolved

gaby and others added 4 commits October 29, 2025 09:55

Update middleware/cors/config.go

f68f571

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Merge branch 'main' into add-github-workflow-for-cspell-action

5ba9079

Update spell-check config

47b8dcb

Fix formatting in middleware/cors/config.go

ce77897

gaby marked this pull request as ready for review October 30, 2025 12:45

gaby requested a review from a team as a code owner October 30, 2025 12:46

gaby requested review from ReneWerner87, efectn and sixcolors October 30, 2025 12:46

chatgpt-codex-connector bot reviewed Oct 30, 2025

View reviewed changes

.cspell.json Show resolved Hide resolved

ReneWerner87 merged commit 7fa858c into main Oct 30, 2025
16 of 17 checks passed

ReneWerner87 deleted the add-github-workflow-for-cspell-action branch October 30, 2025 13:44

github-project-automation bot moved this from In Progress to Done in v3 Oct 30, 2025

Uh oh!

Conversation

gaby commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

coderabbitai bot commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Other AI code review bot(s) detected

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

codecov bot commented Oct 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

Uh oh!

gaby commented Oct 29, 2025

Uh oh!

gaby commented Oct 29, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gaby commented Oct 22, 2025 •

edited

Loading

coderabbitai bot commented Oct 22, 2025 •

edited

Loading

codecov bot commented Oct 22, 2025 •

edited

Loading