Conversation
|
WalkthroughThis pull request introduces spell-checking infrastructure and fixes numerous typos and spelling errors across the codebase. A new cspell.json configuration file is added with vocabulary definitions and file/directory specifications. The package.json is updated to include cspell as a dev dependency and add spell-checking to the lint script. Multiple README files are corrected for typos and logo URL references. Source code files receive fixes for misspelled variable names, import aliases, method parameters, and comments. Component templates and test files are also updated with spelling corrections, and a constant identifier is renamed for consistency. 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
cspell.json (1)
41-41: Consider expanding file patterns for monorepo coverage.The current pattern
["*", "src/**/*"]may not cover source files underpackages/*/src/. For a monorepo structure, consider:- "files": ["*", "src/**/*"], + "files": ["*", "src/**/*", "packages/**/*"],Alternatively, use
**/*to cover all files and rely onignorePathsfor exclusions.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@cspell.json` at line 41, Update the cspell.json "files" patterns to cover monorepo packages by adding a pattern such as "packages/*/src/**/*" (or replace with a broader "**/*" and rely on ignorePaths) so source files under packages/*/src/ are linted; modify the "files" array entry that currently contains ["*", "src/**/*"] to include the new pattern or the global pattern accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@cspell.json`:
- Line 38: Remove the unused whitelist entry "Broutes" from cspell.json because
it's a typo and not referenced by active code; locate the "Broutes" string in
cspell.json and delete that array element so the spellchecker no longer ignores
this nonexistent token (no other code changes required).
In `@package.json`:
- Line 19: The CI lint script (`@ci`:lint) is missing the cspell check so CI can
miss spelling issues; update the "@ci:lint" script to include the same cspell
invocation used by "lint" (e.g., add cspell "**/*.{md,ts,marko}" with the same
flags) so `@ci`:lint and lint run identical checks; locate the package.json
scripts object and modify the "@ci:lint" entry to mirror the "lint" entry
(including eslint, prettier checks, and the cspell command and options).
---
Nitpick comments:
In `@cspell.json`:
- Line 41: Update the cspell.json "files" patterns to cover monorepo packages by
adding a pattern such as "packages/*/src/**/*" (or replace with a broader "**/*"
and rely on ignorePaths) so source files under packages/*/src/ are linted;
modify the "files" array entry that currently contains ["*", "src/**/*"] to
include the new pattern or the global pattern accordingly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f2030974-a3b2-4401-b11a-bfa338fff508
⛔ Files ignored due to path filters (2)
assets/marko-run-dark.pngis excluded by!**/*.pngand included by**package-lock.jsonis excluded by!**/package-lock.jsonand included by**
📒 Files selected for processing (19)
cspell.jsonpackage.jsonpackages/adapters/netlify/README.mdpackages/adapters/netlify/src/index.tspackages/adapters/node/README.mdpackages/adapters/static/README.mdpackages/explorer/src/routes/+layout.markopackages/explorer/src/routes/+page.markopackages/run/README.mdpackages/run/src/__tests__/fixtures/node-adapter-express-import/src/index.tspackages/run/src/adapter/dev-server.tspackages/run/src/adapter/index.tspackages/run/src/adapter/logger.tspackages/run/src/adapter/utils.tspackages/run/src/vite/__tests__/parse-flat-route.test.tspackages/run/src/vite/__tests__/route-builder.test.tspackages/run/src/vite/plugin.tspackages/run/src/vite/routes/builder.tspackages/run/src/vite/utils/server.ts
| "routetypes", | ||
| "jsnext", | ||
| "vdir", | ||
| "Broutes" |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for "Broutes" usage in the codebase to determine if it's intentional
rg -n -i 'broutes' --type=ts --type=js --type=markoRepository: marko-js/run
Length of output: 85
🏁 Script executed:
#!/bin/bash
# Search for "Broutes" and similar terms without type restrictions
echo "=== Searching for 'Broutes' (case-insensitive) ==="
rg -i 'broutes' --max-count=20
echo ""
echo "=== Searching for 'BRoutes' pattern ==="
rg 'BRoutes' --max-count=20
echo ""
echo "=== Checking cspell.json file context ==="
cat -n cspell.json | head -50Repository: marko-js/run
Length of output: 1491
🏁 Script executed:
#!/bin/bash
# Get context around the basePath comment in plugin.ts
echo "=== Context from plugin.ts around basePath line ==="
rg -B 5 -A 5 'basePath.*2Broutes' packages/run/src/vite/plugin.ts
echo ""
echo "=== Search for any actual code/variable using 'Broutes' (not comments) ==="
rg 'Broutes' --type-not=md --type-not=json -C 2
echo ""
echo "=== Search for 'routes' usage in the vite plugin ==="
rg -i '\.routes|broutes|\+routes' packages/run/src/vite/plugin.ts -A 2 -B 2Repository: marko-js/run
Length of output: 2146
Remove "Broutes" from the whitelist—it appears to be a typo.
"Broutes" is not used anywhere in the active codebase. The only occurrence outside cspell.json is in a commented-out code snippet in packages/run/src/vite/plugin.ts that contains %2Broutes (URL-encoded +routes), which is not "Broutes". This entry should be removed as it serves no purpose.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@cspell.json` at line 38, Remove the unused whitelist entry "Broutes" from
cspell.json because it's a typo and not referenced by active code; locate the
"Broutes" string in cspell.json and delete that array element so the
spellchecker no longer ignores this nonexistent token (no other code changes
required).
| "change": "changeset add", | ||
| "format": "eslint --format unix --fix .; prettier . --write --with-node-modules --log-level=warn", | ||
| "lint": "eslint --format unix . && prettier . --check --with-node-modules --log-level=warn", | ||
| "lint": "eslint --format unix . && prettier . --check --with-node-modules --log-level=warn && cspell \"**/*.{md,ts,marko}\"", |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Current lint scripts:"
jq '.scripts | {lint: .lint, "@ci:lint": .["@ci:lint"]}' package.json
echo
echo "Where lint entrypoints are referenced:"
rg -n --hidden -g '!node_modules' -g '!.git' -e '@ci:lint|npm run lint|lint-staged|pre-commit|husky'Repository: marko-js/run
Length of output: 1194
🏁 Script executed:
# Check for lint-staged configuration
rg -n 'lint-staged' package.json -A 10
cat .lintstagedrc* 2>/dev/null || echo "No .lintstagedrc file found"Repository: marko-js/run
Length of output: 616
Keep the CI lint path in sync with lint.
@ci:lint is missing cspell and is actively invoked by CI (.github/workflows/ci.yml). This means spelling errors can bypass CI checks even though npm run lint (with cspell) catches them locally. The scripts should run the same checks.
Suggested fix
- "@ci:lint": "eslint --format unix . && prettier . --check --with-node-modules --log-level=warn",
+ "@ci:lint": "eslint --format unix . && prettier . --check --with-node-modules --log-level=warn && cspell \"**/*.{md,ts,marko}\"",🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@package.json` at line 19, The CI lint script (`@ci`:lint) is missing the cspell
check so CI can miss spelling issues; update the "@ci:lint" script to include
the same cspell invocation used by "lint" (e.g., add cspell "**/*.{md,ts,marko}"
with the same flags) so `@ci`:lint and lint run identical checks; locate the
package.json scripts object and modify the "@ci:lint" entry to mirror the "lint"
entry (including eslint, prettier checks, and the cspell command and options).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #185 +/- ##
===========================
===========================
☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
Add spell checking to the pre-commit, and corrected spelling errors throughout the repo