Skip to content

Audit project health and refresh docs - #53

Merged
SPerekrestova merged 2 commits into
mainfrom
devin/1781971883-project-health-audit
Jun 24, 2026
Merged

Audit project health and refresh docs#53
SPerekrestova merged 2 commits into
mainfrom
devin/1781971883-project-health-audit

Conversation

@SPerekrestova

@SPerekrestova SPerekrestova commented Jun 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • Refreshes README install/config guidance so npm and MCP examples consistently use @sperekrestova/interactive-leetcode-mcp, and adds a clean-directory npm smoke-test recipe that explicitly distinguishes CLI install checks from stdio MCP validation.
  • Brings the README tool inventory back in sync with the registered MCP tools (get_started, session/hint tools, runner tools, solution tools, and current user-history tool names).
  • Makes project health checks runnable with npm run lint by treating .cjs scripts as CommonJS in ESLint, removes two unused dev-only packages plus stale inferred schema type exports.

Link to Devin session: https://app.devin.ai/sessions/c77c9ce4cbbd45178be1fd19f2e2a5ce
Requested by: @SPerekrestova

@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9a915cbc-b0c8-4da6-be5f-19542aab84d2

📥 Commits

Reviewing files that changed from the base of the PR and between e88c6b8 and bbe055c.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

The PR expands README documentation with CLI smoke test commands, an @latest MCP config update, a full tool catalog (session, runner, solution, user tools), and a rewritten learning mode flow. It also fixes ESLint globals for Node/CJS environments, adds a lint script, removes two unused dev dependencies, and drops the SubmitResponse/CheckResponse exported type aliases.

Changes

README Documentation

Layer / File(s) Summary
Installation verification and MCP config
README.md
Adds --version/--help smoke commands after global install, introduces a Fresh Environment Smoke Test section, and updates Claude Desktop args to use the scoped package at @latest.
Tool catalog and learning mode flow
README.md
Documents get_started, adds Session/Learning/Local Runner/Solution tool sections with parameters and prerequisites, replaces get_user_submissions with six newer submission/status/progress tools, and rewrites the How to Use Learning Mode numbered steps.

ESLint Config and Code Cleanup

Layer / File(s) Summary
ESLint Node/CJS config and package.json cleanup
eslint.config.js, package.json
Switches base globals from globals.browser to globals.node, adds a **/*.cjs override with sourceType: "commonjs" and @typescript-eslint/no-require-imports disabled, adds a lint npm script, and removes esbuild and eslint-plugin-prettier from devDependencies.
Remove unused Zod type aliases
src/leetcode/schemas.ts
Drops the exported SubmitResponse and CheckResponse type aliases that were inferred from the corresponding Zod schemas.
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch devin/1781971883-project-health-audit

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

@SPerekrestova SPerekrestova self-assigned this Jun 20, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 69-71: The documentation in the smoke test section overstates the
validation coverage by claiming that the commands "start the MCP server
entrypoint," when in reality --version and --help flags only execute CLI
commands without establishing server startup or stdio handshake. Revise the
sentence to accurately reflect what actually occurs: state that the commands
confirm Node can install the package and expose the CLI binary, then add
guidance that for actual MCP server validation, an integration test with stdio
handshake should be implemented instead.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 45c203a6-72ca-47fa-bd7e-7bbdeef5b0b8

📥 Commits

Reviewing files that changed from the base of the PR and between 4ceefe4 and e88c6b8.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • README.md
  • eslint.config.js
  • package.json
  • src/leetcode/schemas.ts
💤 Files with no reviewable changes (1)
  • src/leetcode/schemas.ts

Comment thread README.md Outdated
@SPerekrestova
SPerekrestova merged commit 3fe780d into main Jun 24, 2026
2 checks passed
@SPerekrestova
SPerekrestova deleted the devin/1781971883-project-health-audit branch June 24, 2026 22:43
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.

1 participant