Skip to content

root: add spell checker and fix typos - #1661

Merged
BeryJu merged 5 commits into
mainfrom
root/spellcheck
Oct 12, 2026
Merged

BeryJu merged 5 commits into
mainfrom
root/spellcheck

Conversation

@GirlBossRush

@GirlBossRush GirlBossRush commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

This PR ports authentik's typo-only cspell setup to the platform repo. It only reports known misspellings and British spellings, so crate names and project jargon pass without needing dictionary entries. There's a standalone make lint-spellcheck target, same as the monorepo, and a new spellcheck job in the test workflow.

It also pins the Node version the same way authentik does, with engines in package.json for CI and a copy of the monorepo's .nvmrc for local version managers.

The last commit fixes the handful of British spellings it found in comments and the README (behaviour, colour, serialised, recognise). The rest were false positives. "unparseable" goes in a small overrides dictionary under hack/cspell since it shows up in several files, and the ratatui crate name and an intentional NUL-byte test string get inline ignores. Xcode-generated files, generated protobuf code and vendored code are excluded.

@codecov

codecov Bot commented Oct 10, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 46.59%. Comparing base (9fbbb03) to head (fcc73fb).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1661      +/-   ##
==========================================
- Coverage   49.72%   46.59%   -3.13%     
==========================================
  Files         209      205       -4     
  Lines       21683    16941    -4742     
  Branches    16516    16210     -306     
==========================================
- Hits        10781     7894    -2887     
+ Misses      10520     8616    -1904     
- Partials      382      431      +49     
Flag Coverage Δ
rs-e2e-24.04 ?
rs-e2e-25.10 ?
rs-e2e-26.04 ?
rs-macos-26-ak-agent 37.89% <ø> (-1.70%) ⬇️
rs-macos-26-ak-agent-desktop 0.39% <ø> (ø)
rs-macos-26-ak-api-cli 100.00% <ø> (ø)
rs-macos-26-ak-api-cli-gen 66.71% <ø> (ø)
rs-macos-26-ak-browser-support 23.68% <ø> (ø)
rs-macos-26-ak-cli 21.19% <ø> (ø)
rs-macos-26-ak-flow-executor 13.07% <ø> (ø)
rs-macos-26-ak-meta 0.00% <ø> (ø)
rs-macos-26-ak-meta-macros 0.00% <ø> (ø)
rs-macos-26-ak-platform 67.17% <ø> (-0.05%) ⬇️
rs-macos-26-ak-platform-authz 0.00% <ø> (ø)
rs-macos-26-ak-platform-facts 83.44% <ø> (ø)
rs-macos-26-ak-platform-keyring 65.64% <ø> (ø)
rs-macos-26-ak-sysd 38.08% <ø> (ø)
rs-ubuntu-26.04-ak-agent 37.89% <ø> (-1.70%) ⬇️
rs-ubuntu-26.04-ak-agent-desktop 0.40% <ø> (ø)
rs-ubuntu-26.04-ak-api-cli 100.00% <ø> (ø)
rs-ubuntu-26.04-ak-api-cli-gen 66.71% <ø> (ø)
rs-ubuntu-26.04-ak-browser-support 23.68% <ø> (ø)
rs-ubuntu-26.04-ak-cli 21.19% <ø> (ø)
rs-ubuntu-26.04-ak-flow-executor 13.07% <ø> (ø)
rs-ubuntu-26.04-ak-meta 0.00% <ø> (ø)
rs-ubuntu-26.04-ak-meta-macros 0.00% <ø> (ø)
rs-ubuntu-26.04-ak-nss 77.37% <100.00%> (ø)
rs-ubuntu-26.04-ak-pam 0.00% <ø> (ø)
rs-ubuntu-26.04-ak-platform 66.63% <ø> (-0.05%) ⬇️
rs-ubuntu-26.04-ak-platform-authz 0.00% <ø> (ø)
rs-ubuntu-26.04-ak-platform-facts 82.64% <ø> (ø)
rs-ubuntu-26.04-ak-platform-keyring 53.08% <ø> (ø)
rs-ubuntu-26.04-ak-sysd 36.73% <ø> (ø)
rs-ubuntu-26.04-arm-ak-agent 39.58% <ø> (ø)
rs-ubuntu-26.04-arm-ak-agent-desktop 0.40% <ø> (ø)
rs-ubuntu-26.04-arm-ak-api-cli 100.00% <ø> (ø)
rs-ubuntu-26.04-arm-ak-api-cli-gen 66.71% <ø> (ø)
rs-ubuntu-26.04-arm-ak-browser-support 23.68% <ø> (ø)
rs-ubuntu-26.04-arm-ak-cli 21.19% <ø> (ø)
rs-ubuntu-26.04-arm-ak-flow-executor 13.07% <ø> (ø)
rs-ubuntu-26.04-arm-ak-meta 0.00% <ø> (ø)
rs-ubuntu-26.04-arm-ak-meta-macros 0.00% <ø> (ø)
rs-ubuntu-26.04-arm-ak-nss 77.37% <100.00%> (ø)
rs-ubuntu-26.04-arm-ak-pam 0.00% <ø> (ø)
rs-ubuntu-26.04-arm-ak-platform 66.68% <ø> (+0.04%) ⬆️
rs-ubuntu-26.04-arm-ak-platform-authz 0.00% <ø> (ø)
rs-ubuntu-26.04-arm-ak-platform-facts 82.64% <ø> (ø)
rs-ubuntu-26.04-arm-ak-platform-keyring 53.08% <ø> (ø)
rs-ubuntu-26.04-arm-ak-sysd 36.73% <ø> (ø)
rs-windows-2025-ak-agent 36.09% <ø> (ø)
rs-windows-2025-ak-agent-desktop 0.38% <ø> (ø)
rs-windows-2025-ak-api-cli 100.00% <ø> (ø)
rs-windows-2025-ak-api-cli-gen 66.71% <ø> (ø)
rs-windows-2025-ak-browser-support 23.68% <ø> (ø)
rs-windows-2025-ak-cli 21.19% <ø> (ø)
rs-windows-2025-ak-flow-executor 13.07% <ø> (ø)
rs-windows-2025-ak-meta 0.00% <ø> (ø)
rs-windows-2025-ak-meta-macros 0.00% <ø> (ø)
rs-windows-2025-ak-platform 63.23% <ø> (ø)
rs-windows-2025-ak-platform-authz 0.00% <ø> (ø)
rs-windows-2025-ak-platform-facts 78.89% <ø> (ø)
rs-windows-2025-ak-platform-keyring 76.25% <ø> (ø)
rs-windows-2025-ak-sysd 35.64% <ø> (ø)
rs-windows-2025-ee/wcp 44.39% <ø> (-0.02%) ⬇️
swift 3.00% <ø> (ø)

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

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

@authentik-automation

Copy link
Copy Markdown
Contributor

🚀 Deployed on https://pr-1661--authentik-pkg.netlify.app

@authentik-automation
authentik-automation Bot temporarily deployed to pull request October 10, 2026 14:41 Inactive
Port authentik's typo-only cspell setup. It reports known misspellings and
British spellings only, so project jargon needs no dictionary entries.
Match the authentik monorepo: engines for CI's node-version-file, and
.nvmrc for local version managers.
@authentik-automation
authentik-automation Bot temporarily deployed to pull request October 10, 2026 15:17 Inactive
@github-project-automation github-project-automation Bot moved this from Todo to In Progress in authentik Core Oct 12, 2026
# Conflicts:
#	pnpm-lock.yaml
@authentik-automation
authentik-automation Bot temporarily deployed to pull request October 12, 2026 15:10 Inactive
@BeryJu
BeryJu merged commit 38e95d3 into main Oct 12, 2026
117 of 119 checks passed
@BeryJu
BeryJu deleted the root/spellcheck branch October 12, 2026 17:01
@github-project-automation github-project-automation Bot moved this from In Progress to Done in authentik Core Oct 12, 2026

This branch was previously deployed

1 inactive deployment
pull request — fcc73fb0 Deployed Oct 12, 2026 by authentik-automation[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants