Skip to content

Expand spellcheck to entire repository including .github directory #6058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Signor1 wants to merge 5 commits into from
Closed

Expand spellcheck to entire repository including .github directory #6058

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b37a32
feat: expand spellcheck to entire repository
Signor1 Sep 9, 2025
18dbd16
feat: merge from main
Signor1 Sep 9, 2025
90a7c70
fix: resolve all spellcheck issues and address bot feedback
Signor1 Sep 10, 2025
7d07a1d
feat: merge from main
Signor1 Sep 10, 2025
1e0e8b2
fix: removed .dockerignore
Signor1 Sep 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/spellcheck.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Spellcheck

on:
push:
branches: [ main ]
paths:
- '**/*.md'
pull_request:
branches: [ main ]
paths:
- '**/*.md'

@coderabbitai coderabbitai Bot Sep 9, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Trigger on dictionary and config changes too.

Currently only Markdown edits run the job. Include dictionary and config so edits are validated in CI.

Apply:

 on:
   push:
     branches: [ main ]
     paths:
-      - '**/*.md'
+      - '**/*.md'
+      - 'dictionary.txt'
+      - 'package.json'
+      - '.github/workflows/spellcheck.yml'
   pull_request:
     branches: [ main ]
     paths:
-      - '**/*.md'
+      - '**/*.md'
+      - 'dictionary.txt'
+      - 'package.json'
+      - '.github/workflows/spellcheck.yml'
+  workflow_dispatch:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
on:
push:
branches: [ main ]
paths:
- '**/*.md'
pull_request:
branches: [ main ]
paths:
- '**/*.md'
on:
push:
branches: [ main ]
paths:
- '**/*.md'
- 'dictionary.txt'
- 'package.json'
- '.github/workflows/spellcheck.yml'
pull_request:
branches: [ main ]
paths:
- '**/*.md'
- 'dictionary.txt'
- 'package.json'
- '.github/workflows/spellcheck.yml'
workflow_dispatch:
🤖 Prompt for AI Agents 
.github/workflows/spellcheck.yml around lines 3 to 11: the workflow only
triggers on Markdown file changes, so updates to spellcheck dictionaries or
config won't run CI; update the push and pull_request path filters to also
include the dictionary and config files (for example add patterns for your
spellcheck dictionary and config locations such as '.github/**/spellcheck/**',
'.github/**/dict*', or specific filenames like '.spellcheck.yml' or
'spell-dictionary.txt') so edits to those files will trigger the job; ensure
both push and pull_request sections receive the same additional path patterns.


jobs:
spellcheck:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
cache: 'yarn'

- name: Install dependencies
run: yarn install

- name: Run spellcheck
run: yarn spellcheck
120 changes: 120 additions & 0 deletions dictionary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
2k
APIs
backend
benchmarking
blockstore
BLS
Butterflynet
Calibnet
calibnet
calibnet-related
cardinality
ChainSafe
chainsafe
ChainSafe's
changelog
CIDs
CLI
cli
Cloudflare
codebase
config
Datacap
datacap
devnet
Devops
Devs
DHT
DigitalOcean
Drand
enums
Ethereum
F3
f3
f3-sidecar
FFI
FIL
fil
Filecoin
filecoin-project
Filfox
FilOz
FIP
FIPs
FVM
GC
GiB
Github
Grafana
Comment on lines +52 to +53

@coderabbitai coderabbitai Bot Sep 10, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Use canonical brand casing; remove incorrect variants.

Whitelist only the official spellings so the checker catches brand-case mistakes.

Apply:

- Github
+ GitHub
- CloudFlare
- MacOS
- github

Optional adds (if you want to allow correct forms explicitly):

+ Cloudflare
+ macOS

Also applies to: 183-183, 285-286, 533-533

hardcoded
hotfix
ie.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated
Implementers
implementers
io
IPFS
JSON
JSON-RPC
JWT
JWTs
keypair
keystore
Kubernetes
kubernetes
libp2p
Linux
Liveness
liveness
localhost
localhost's
LRU
M1
M2
macOS
Mainnet
mainnet
multiaddress
namespace
NetworkEvents
NV22
NV23
NV24
NVMe
onwards
orchestrator
Organisation
P2P
Comment on lines +91 to +92

@coderabbitai coderabbitai Bot Sep 10, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Align with en-US dictionary (project uses -l en-US).

These British/incorrect forms will mask style issues.

Apply:

- Organisation
- organisation
- standardised
- cancelled
- cancelation
+ organization
+ standardized
+ canceled
+ cancellation

If UK spellings are desired in specific docs, prefer file-scoped ignores instead of global whitelist.

Also applies to: 340-341, 568-568, 496-497

🤖 Prompt for AI Agents 
In dictionary.txt around lines 91-92 (and also update occurrences at 340-341,
496-497, 568), replace British spellings with en-US forms so the project-wide
en-US dictionary stays consistent: change "Organisation" to "Organization" (and
any other UK variants found at the referenced lines) and remove or correct
entries that mask style issues (do not add UK forms to the global whitelist); if
a UK spelling is genuinely required in a specific file, add a file-scoped ignore
there instead of adding it to dictionary.txt.

p2p
performant
pre-compiled
preload
preloaded
pubsub
Q4
README
RNG
Roadmap
roadmap
RPC
rustup
S3-compatible
SecP256k1
semver
serverless
stateroots
struct
subcommands
swappiness
SyncStateMachine
TabItem
TBD
Terraform
testnet
Tipset
tipset
tipsets
V0
V1
VPS
WIP
zstd
9 changes: 7 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,19 @@
"private": true,
"devDependencies": {
"@docusaurus/tsconfig": "^3.8.1",
"prettier": "^3.6.2"
"prettier": "^3.6.2",
"spellchecker-cli": "^7.0.0"
},
"scripts": {
"prettier-version": "prettier --version",
"md-fmt": "prettier --write '**/*.md'",
"md-check": "prettier --check '**/*.md'",
"yaml-fmt": "prettier --write '**/*.{yml,yaml}'",
"yaml-check": "prettier --check '**/*.{yml,yaml}'"
"yaml-check": "prettier --check '**/*.{yml,yaml}'",
"spellcheck": "spellchecker -f '**/*.md' -l en-US -q -d ./dictionary.txt -i '^[0-9]+$' -i '^[A-Z]+$'",
"spellcheck:github": "spellchecker -f '.github/**/*.md' -l en-US -q -d ./dictionary.txt -i '^[0-9]+$' -i '^[A-Z]+$'",
"spellcheck:docs": "spellchecker -f './docs/**/*.md' -l en-US -q -d ./dictionary.txt -i '^[0-9]+$' -i '^[A-Z]+$'",
"spellcheck:fix": "spellchecker -f '**/*.md' -l en-US -d ./dictionary.txt -i '^[0-9]+$' -i '^[A-Z]+$'"
},
"packageManager": "yarn@4.9.2"
}
Loading