Skip to content
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.

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

Validate source directory existence. #252

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cryptoryda
Copy link

@cryptoryda cryptoryda commented Jan 15, 2025

  • Validate source directory existence.
if (!existsSync(srcDir)) {
  console.error(`Source directory does not exist: ${srcDir}`);
  process.exit(1);
}

Summary by CodeRabbit

  • Bug Fixes
    • Added source directory validation to prevent potential errors during file operations.
    • Improved error handling to gracefully exit if source directory is missing.

Copy link

coderabbitai bot commented Jan 15, 2025

Walkthrough

The changes enhance error handling in the main script by adding a validation step to check for the existence of the source directory before proceeding with file operations. This modification ensures that the script gracefully handles scenarios where the source directory is missing, preventing potential runtime errors and providing clear console feedback.

Changes

File Change Summary
_api/src/main.ts - Added import for existsSync from fs module
- Implemented source directory existence check
- Added error logging and process exit if source directory is missing

Poem

🐰 A rabbit's tale of directory care,
Checking paths with a vigilant stare,
No source? No stress, we'll kindly depart,
Exiting softly, with code-checking art!
Safe and sound, our script stands clear. 🕵️‍♀️

Finishing Touches

  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
_api/src/main.ts (1)

31-34: Consider these refinements to enhance the error handling.

While the current implementation is functional, consider these improvements:

  1. Use process.stderr.write for error output
  2. Add more context about the impact
  3. Consider moving the validation to a separate function
+function validateSourceDirectory(srcDir: string): void {
+    if (!existsSync(srcDir)) {
+        process.stderr.write(
+            `Error: Source directory not found: ${srcDir}\n` +
+            `Please ensure the directory exists before running this script.\n`
+        );
+        process.exit(1);
+    }
+}
+
-if (!existsSync(srcDir)) {
-    console.error(`Source directory does not exist: ${srcDir}`);
-    process.exit(1);
-}
+validateSourceDirectory(srcDir);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 431e72a and 8579e0e.

📒 Files selected for processing (1)
  • _api/src/main.ts (2 hunks)
🔇 Additional comments (2)
_api/src/main.ts (2)

16-16: LGTM! Appropriate import for directory validation.

The addition of existsSync from the Node.js fs module is the correct choice for synchronous directory existence checking.


28-34: LGTM! Early validation prevents undefined behavior.

The validation is correctly placed before any file operations and uses appropriate error handling with a non-zero exit code.

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