Skip to content

ci: integrate typos spell checker into CI pipeline#6833

Closed
ohmygod20260203 wants to merge 1 commit intoprojectdiscovery:devfrom
ohmygod20260203:feat/typos-ci
Closed

ci: integrate typos spell checker into CI pipeline#6833
ohmygod20260203 wants to merge 1 commit intoprojectdiscovery:devfrom
ohmygod20260203:feat/typos-ci

Conversation

@ohmygod20260203
Copy link

@ohmygod20260203 ohmygod20260203 commented Feb 5, 2026

Description

This PR integrates the typos spell checker into the CI pipeline as requested in #6532.

Changes

  • Add .github/workflows/typos.yaml - GitHub Action workflow for running typos
  • Add .typos.toml - Configuration file with appropriate exclusions for the project

Configuration

The typos action will run on:

  • Push to main/dev branches
  • Pull requests to main/dev branches

The config excludes:

  • Vendor directories
  • Generated files (*.pb.go, go.sum)
  • Test data
  • Base64/hex strings and URLs (via regex)

References

Fixes #6532

Summary by CodeRabbit

  • Chores
    • Added spell-checking configuration to enhance code quality standards.

This PR adds the typos spell checker to the CI pipeline as requested in projectdiscovery#6532.

Changes:
- Add .github/workflows/typos.yaml for running typos on push/PR
- Add .typos.toml configuration file with appropriate exclusions

The typos action will run on:
- Push to main/dev branches
- Pull requests to main/dev branches

Fixes projectdiscovery#6532
@auto-assign auto-assign bot requested a review from dwisiswant0 February 5, 2026 17:35
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 5, 2026

Walkthrough

A new .typos.toml configuration file is introduced that defines spelling checker rules, including file exclusion patterns for minified and vendor code, regex patterns to ignore common string formats, and project-specific words to exclude from spell-checking.

Changes

Cohort / File(s) Summary
Typos Configuration
.typos.toml
Introduces configuration for the typos spelling checker tool with file exclusion patterns, regex ignore patterns for base64 strings, hex strings, and URLs, and project-specific words to ignore from spell-checking.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hop hop, a config so clean and true,
Typos be gone, we know what to do!
Patterns and words in harmony aligned,
CI's watchful eye leaves none behind,
Quality maintained, one commit at a time! 🐇✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR adds .typos.toml configuration but does not include the GitHub Actions workflow file (.github/workflows/typos.yaml) mentioned in the PR objectives to integrate typos into CI, which is the core requirement of issue #6532. Add the .github/workflows/typos.yaml workflow file to complete the CI integration requirement from issue #6532.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title clearly and accurately summarizes the main change: integrating the typos spell checker into the CI pipeline, which aligns with the primary objective.
Out of Scope Changes check ✅ Passed The .typos.toml configuration file added is directly in scope with the typos CI integration objective and contains appropriate exclusion patterns for the project.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@ohmygod20260203
Copy link
Author

Hi team! 👋 Just checking in on this PR. All CI checks are passing and the implementation includes both the workflow file and proper typos.toml configuration with exclusions for vendor code, base64 strings, and project-specific terms. Let me know if there's anything I can improve or if you need any clarification. Thanks!

@dogancanbakir
Copy link
Member

Hi, thanks for your interest in contributing! Just a heads up, we ask contributors to work on 1 active issue at a time (see).

Also, we welcome AI-assisted development, but submissions must be complete, tested, and ready to merge. Please also make sure to fill out the PR template with proof that your changes work.

We're closing this PR along with your other open submissions. Once you're ready, feel free to pick one issue to focus on and resubmit; we'd be happy to review it.

Appreciate your understanding!

@dogancanbakir dogancanbakir removed the request for review from dwisiswant0 February 9, 2026 09:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Integrate typos tool into CI

2 participants