Skip to content

fix(remote): ensure output directories exist before file writing#383

Merged
yamadashy merged 1 commit intomainfrom
fix/create-output-directories
Mar 2, 2025
Merged

fix(remote): ensure output directories exist before file writing#383
yamadashy merged 1 commit intomainfrom
fix/create-output-directories

Conversation

@yamadashy
Copy link
Owner

When using nested output paths (e.g. --output docs/nested/file.xml), the tool fails because parent directories are not automatically created. This PR fixes the issue by ensuring folders exist before writing files.

related: #378

Checklist

  • Run npm run test
  • Run npm run lint

@yamadashy yamadashy requested a review from Copilot March 2, 2025 15:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

PR Overview

This PR fixes an issue where file writing fails by ensuring that the necessary directories exist prior to file operations.

  • In src/core/packager/writeOutputToDisk.ts, a directory creation step is added before writing files.
  • In src/cli/actions/remoteAction.ts, a similar step is added before copying files.

Reviewed Changes

File Description
src/core/packager/writeOutputToDisk.ts Added mkdir to create parent folder for output file before writing.
src/cli/actions/remoteAction.ts Added mkdir to create target folder for copying the output file.

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 2, 2025

📝 Walkthrough

Walkthrough

The pull request updates two functions responsible for writing output files. In the CLI action function copyOutputToCurrentDirectory, a new line is added to ensure that the target directory is created using fs.mkdir with the { recursive: true } option before copying the file. Similarly, in the writeOutputToDisk function, a directory creation step is introduced based on the directory of the output path, also using fs.mkdir with { recursive: true }. These changes ensure the necessary directory structures exist before proceeding with file operations, thereby preventing potential errors due to missing directories. The overall control flow and error handling remain unchanged, with the new steps executed prior to the file operations.

Sequence Diagram(s)

sequenceDiagram
    participant C as Caller
    participant F as copyOutputToCurrentDirectory
    participant FS as File System

    C->>F: Invoke copyOutputToCurrentDirectory(source, target)
    F->>FS: fs.mkdir(target, {recursive: true})
    FS-->>F: Directory created (or already exists)
    F->>FS: Execute file copy operation
    FS-->>F: File copied successfully
    F-->>C: Return success (or error if any)
Loading
sequenceDiagram
    participant C as Caller
    participant W as writeOutputToDisk
    participant L as Logger
    participant FS as File System

    C->>W: Invoke writeOutputToDisk(outputPath, data)
    W->>L: Log output path
    W->>FS: fs.mkdir(path.dirname(outputPath), {recursive: true})
    FS-->>W: Directory created (or already exists)
    W->>FS: Write data to disk
    FS-->>W: File written successfully
    W-->>C: Return success (or error if any)
Loading

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6963513 and 0055b36.

📒 Files selected for processing (3)
  • src/cli/actions/remoteAction.ts (1 hunks)
  • src/core/packager/writeOutputToDisk.ts (1 hunks)
  • tests/cli/actions/remoteAction.test.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/core/packager/writeOutputToDisk.ts
  • src/cli/actions/remoteAction.ts
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Test (windows-latest, 23.x)
  • GitHub Check: Test (windows-latest, 22.x)
  • GitHub Check: Test (windows-latest, 21.x)
  • GitHub Check: Test (windows-latest, 20.x)
  • GitHub Check: Test (windows-latest, 19.x)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (1)
tests/cli/actions/remoteAction.test.ts (1)

18-18: Good addition of the mkdir mock

The mock for mkdir has been properly added to support the new directory creation functionality introduced in the PR.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
  • @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.

@yamadashy yamadashy force-pushed the fix/create-output-directories branch from 6963513 to 0055b36 Compare March 2, 2025 15:20
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 2, 2025

Deploying repomix with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0055b36
Status: ✅  Deploy successful!
Preview URL: https://0df16432.repomix.pages.dev
Branch Preview URL: https://fix-create-output-directorie.repomix.pages.dev

View logs

@codecov
Copy link

codecov bot commented Mar 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.17%. Comparing base (55f38b5) to head (0055b36).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #383   +/-   ##
=======================================
  Coverage   90.17%   90.17%           
=======================================
  Files          72       72           
  Lines        3470     3472    +2     
  Branches      750      750           
=======================================
+ Hits         3129     3131    +2     
  Misses        341      341           

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

@yamadashy yamadashy merged commit 8200f34 into main Mar 2, 2025
53 checks passed
@yamadashy yamadashy deleted the fix/create-output-directories branch March 2, 2025 15:26
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.

2 participants