fix(openapi): ensure output folder created

[ymc9]

fixes #2080

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes introduce a preparatory step in both the REST and RPC OpenAPI generators to ensure that the output directory exists before attempting to write the OpenAPI specification file. This is achieved by adding a call to fs.mkdirSync with the { recursive: true } option, which creates the required directory structure if it is missing. No changes were made to the signatures of exported or public entities, and the overall logic and control flow remain unchanged apart from this addition.

Changes

Files	Change Summary
packages/plugins/openapi/src/rest-generator.ts, packages/plugins/openapi/src/rpc-generator.ts	Added a call to fs.mkdirSync with { recursive: true } before writing the output file to ensure the output directory exists. No other logic or API changes.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure OpenAPI plugin (rest-generator and rpc-generator) creates output directory if missing (#2080)	✅

---

📜 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 c41addd and 4319b34.

📒 Files selected for processing (2)

• packages/plugins/openapi/src/rest-generator.ts (1 hunks)
• packages/plugins/openapi/src/rpc-generator.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/plugins/openapi/src/rest-generator.ts (1)

packages/schema/build/bundle.js (1)

• fs (4-4)

⏰ Context from checks skipped due to timeout of 90000ms (5)

• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: OSSAR-Scan
• GitHub Check: build-test (20.x)
• GitHub Check: build-test (20.x)
• GitHub Check: build-test (20.x)

🔇 Additional comments (2)

packages/plugins/openapi/src/rpc-generator.ts (1)

97-99: Good addition to prevent file write errors.

This change ensures that the output directory exists before attempting to write the OpenAPI specification file, which prevents errors that would occur if the output path's parent directories don't exist.

packages/plugins/openapi/src/rest-generator.ts (1)

82-84: Good addition for consistent error prevention.

This mirrors the same directory creation logic added to the RPC generator, ensuring that the output directory exists before writing the OpenAPI specification file. The recursive flag is appropriate here as it will create any missing directories in the path.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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