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

fix: make sure copy file parent dir exits #5

Merged
merged 1 commit into from
Feb 2, 2025
Merged

Conversation

fengmk2
Copy link
Member

@fengmk2 fengmk2 commented Feb 2, 2025

Summary by CodeRabbit

  • New Features
    • Improved file processing now automatically creates needed directories before transferring files, reducing potential errors.
    • Updated HTML templates with additional content for a cleaner output.
  • Tests
    • Enhanced test coverage to verify that the updated HTML files are correctly deployed in the output paths.

Copy link

coderabbitai bot commented Feb 2, 2025

Walkthrough

The changes enhance the file copying process by ensuring that the target directories exist before copying files. The copyFiles function in the main module now invokes mkdirSync (with the recursive: true option) for both CommonJS and ESM output directories. Additionally, a new line ("hello world") is added to two HTML template files, and corresponding test assertions are inserted to verify the presence of these HTML files in the output directories using fs.statSync.

Changes

Files Change Summary
src/index.ts Added mkdirSync import and inserted two calls in the copyFiles function to ensure directories exist (for both CommonJS and ESM outputs).
test/fixtures/.../templates/foo.html
test/fixtures/.../templates/bar.html
Added a new line "hello world" to both HTML template files.
test/index.test.ts Added assertions using fs.statSync to verify that foo.html and bar.html exist in the dist/commonjs/templates and dist/esm/templates directories after build.

Sequence Diagram(s)

sequenceDiagram
    participant CF as copyFiles Function
    participant FS as File System
    Note over CF: Prepare CommonJS output
    CF->>FS: mkdirSync(commonjs_dir, { recursive: true })
    CF->>FS: copyFileSync(file)
    Note over CF: Prepare ESM output
    CF->>FS: mkdirSync(esm_dir, { recursive: true })
    CF->>FS: copyFileSync(file)
Loading

Possibly related PRs

Poem

I'm a bunny with code so light,
Hopping through directories day and night,
mkdirSync paves my way so clear,
Copying files without a fear,
"hello world" in HTML brings a smile so bright,
Hoppy changes make my coding heart take flight!
🐇💻


📜 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 e2321c7 and 461094d.

📒 Files selected for processing (4)
  • src/index.ts (2 hunks)
  • test/fixtures/demo/src/templates/bar.html (1 hunks)
  • test/fixtures/demo/src/templates/foo.html (1 hunks)
  • test/index.test.ts (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • test/fixtures/demo/src/templates/foo.html
  • test/fixtures/demo/src/templates/bar.html
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Node.js / Test (windows-latest, 23)
  • GitHub Check: Node.js / Test (windows-latest, 22)
  • GitHub Check: Node.js / Test (windows-latest, 18)
  • GitHub Check: Node.js / Test (windows-latest, 16)
🔇 Additional comments (3)
test/index.test.ts (1)

55-62: LGTM! Test coverage is comprehensive.

The new test assertions follow the established pattern and thoroughly verify HTML file copying for both CommonJS and ESM outputs.

src/index.ts (2)

3-3: LGTM! Import is correctly ordered.

The mkdirSync import is properly added to the existing fs imports.


81-81: LGTM! Changes effectively address the PR objective.

The addition of mkdirSync with { recursive: true } ensures parent directories exist before file copying, preventing potential failures. Implementation follows Node.js best practices.

Also applies to: 85-85

✨ 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

pkg-pr-new bot commented Feb 2, 2025

Open in Stackblitz

npm i https://pkg.pr.new/node-modules/tshy-after@5

commit: 461094d

@fengmk2 fengmk2 merged commit 19c442a into master Feb 2, 2025
17 checks passed
@fengmk2 fengmk2 deleted the fix-mkdir-not-exists branch February 2, 2025 04:59
fengmk2 pushed a commit that referenced this pull request Feb 2, 2025
[skip ci]

## [1.4.1](v1.4.0...v1.4.1) (2025-02-02)

### Bug Fixes

* make sure copy file parent dir exits ([#5](#5)) ([19c442a](19c442a))
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