Skip to content

Allow the afe commit hash fragment in the typos check - #7979

Open
kamilikamil wants to merge 1 commit into
projectdiscovery:devfrom
kamilikamil:typos-afe-fragment
Open

kamilikamil wants to merge 1 commit into
projectdiscovery:devfrom
kamilikamil:typos-afe-fragment

Conversation

@kamilikamil

@kamilikamil kamilikamil commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Proposed changes

Fixes #7978

Spell Check fails on dev with five error: `afe` should be `safe` . All five are the commit hash 0da993afe6 in SECURITY_CONTEXT.md, which typos splits at its digits. This allows afe in _typos.toml, next to the other hash and encoded-data fragments already listed there.

Proof

Spell Check fails on dev and passes on this branch.

I used an AI assistant while working on this.

Checklist

  • Pull request is created against the dev branch
  • All checks passed (lint, unit/integration/regression tests etc.) with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Summary by CodeRabbit

  • Improvements
    • The spelling checker now accepts “afe” as a valid term. This prevents the term from being flagged as a spelling error when it appears in relevant project documentation. No other user-facing changes are included in this update.

typos splits commit hash 0da993a in SECURITY_CONTEXT.md at its digits
and flags 'afe', failing Spell Check on dev and on every pull request.
@coderabbitai

coderabbitai Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ed583a5a-c9ca-49c6-8896-d2c1742c308b
Commits

Reviewing files that changed from the base of the PR and between 1f79f78 and fc1e26c.

Files selected for processing: 1
  • _typos.toml

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

Walkthrough

The default spelling configuration now allows afe, a fragment of the commit hash in SECURITY_CONTEXT.md.

Changes

Spelling Configuration

Layer / File(s) Summary
Allow commit-hash fragment
_typos.toml
The default allowed words include afe, with a comment identifying it as a commit-hash fragment.

Priority: Normal

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Bug fix · Severity of issue fixed: Medium

Possibly related PRs

  • projectdiscovery/nuclei#7972: Both PRs address spelling-check failures from SECURITY_CONTEXT.md; that PR excludes the file, while this one allows the specific hash fragment.

Suggested labels: Type: Maintenance

Suggested reviewers: mzack9999

Merge Risk: Minimal · up to fc1e2

No actionable merge-blocking risk is evident; the targeted spelling workflow fix is ready for normal checks.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title states the main change: adding afe to the typos check allowlist so the commit hash fragment in SECURITY_CONTEXT.md is no longer flagged. The raw summary confirms the only change is a two-l…
Linked Issues check Passed Issue #7978 requires the Spell Check workflow to pass when typos reports the afe fragment in commit hash 0da993afe6 from SECURITY_CONTEXT.md. The pull request adds afe = "afe" to `_typos.tom…
Out of Scope Changes check Passed The reviewed change only updates _typos.toml with the required afe spelling exception and its comment. The change supports issue #7978 and introduces no unrelated implementation or documentation c…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Full details: Title check

Explanation

The title states the main change: adding afe to the typos check allowlist so the commit hash fragment in SECURITY_CONTEXT.md is no longer flagged. The raw summary confirms the only change is a two-line addition to _typos.toml, and the objectives describe the same fix for the failing Spell Check on dev. The title is specific, short, and accurate.

Full details: Linked Issues check

Explanation

Issue #7978 requires the Spell Check workflow to pass when typos reports the afe fragment in commit hash 0da993afe6 from SECURITY_CONTEXT.md. The pull request adds afe = "afe" to _typos.toml and documents the affected hash fragment. This directly addresses the reported spelling error.

Full details: Out of Scope Changes check

Explanation

The reviewed change only updates _typos.toml with the required afe spelling exception and its comment. The change supports issue #7978 and introduces no unrelated implementation or documentation changes.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

A rabbit checks each word with care,
Then finds afe hiding there.
The hash stays whole, the check moves on,
A spelling snag is neatly gone.
I hop away beneath the moon.

Comment @coderabbitai help to get the list of available commands.

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.

[BUG] Spell Check fails on dev on a commit hash in SECURITY_CONTEXT.md

1 participant