feat: add exporting log info #25

JounQin · 2025-05-20T05:21:56Z

Summary by CodeRabbit

Chores
- Added a changeset to document a patch update for the package.
- Updated the Node.js version requirement to v20.19.2.
Style
- Improved the formatting of the export completion message by removing an unnecessary leading newline.
Bug Fixes
- Error messages for empty PDF exports are now correctly sent to the error output stream.
Refactor
- Optimized internal logic for exporting PDFs and added a log statement showing language and page count before export.

changeset-bot · 2025-05-20T05:22:00Z

🦋 Changeset detected

Latest commit: 6555aab

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@alauda/doom	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

coderabbitai · 2025-05-20T05:22:03Z

Walkthrough

The changes introduce a new changeset file for documenting a patch update, update the Node.js version in the .nvmrc file, and make minor improvements to logging and error reporting in the PDF export CLI. Additionally, the export logic is refactored for clarity and efficiency, with enhanced logging of export details.

Changes

File(s)	Change Summary
.changeset/green-ants-raise.md	Added a changeset file describing a patch update for `@alauda/doom` with new log export functionality.
.nvmrc	Updated Node.js version from v20.19.1 to v20.19.2.
src/cli/export-pdf-core/generatePdf.ts	Removed leading newline from the export completion message output to stdout.
src/cli/export-pdf-core/utils/mergePDF.ts	Changed error message output stream from stdout to stderr for empty pages case.
src/cli/export.ts	Refactored to use a local `pages` variable, added a log statement for export details, and improved function clarity.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant ExportModule
    participant PDFGenerator

    User->>CLI: Run export command
    CLI->>ExportModule: collectPages(sidebarItems)
    ExportModule-->>CLI: pages
    CLI->>CLI: Log language and page count
    CLI->>PDFGenerator: generatePdf(pages, ...)
    PDFGenerator-->>CLI: PDF generated
    CLI->>User: Output "Exported to ..." message

Poem

In the warren of code, a patch hops in,
With logs more clear, and errors less grim.
Node’s version nudged, a newline trimmed,
Exporting pages, each bunny grinned.
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between da0affc and 6555aab.

📒 Files selected for processing (5)

.changeset/green-ants-raise.md (1 hunks)
.nvmrc (1 hunks)
src/cli/export-pdf-core/generatePdf.ts (1 hunks)
src/cli/export-pdf-core/utils/mergePDF.ts (1 hunks)
src/cli/export.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

src/cli/export.ts (1)

src/cli/export-pdf-core/generatePdf.ts (1)

generatePdf (40-151)

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

GitHub Check: Build and Lint with Node.js 24 on ubuntu-latest

🔇 Additional comments (5)

.nvmrc (1)

1-1: Node.js version update looks good.

The update to Node.js v20.19.2 keeps the development environment current with the latest minor version release.

src/cli/export-pdf-core/generatePdf.ts (1)

146-146: Output formatting improvement.

Removed the leading newline character from the export success message, resulting in cleaner console output. This change aligns well with the PR's goal of improving logging.

.changeset/green-ants-raise.md (1)

1-5: Appropriate changeset documentation.

The changeset properly documents the patch update for @alauda/doom with a clear feature description that matches the implemented changes to export logging.

src/cli/export.ts (1)

116-119: Good optimization and enhanced logging.

This change improves both efficiency and user feedback by:

Storing the collectPages result in a variable to avoid redundant calls

Adding informative logging about language and page count before PDF generation

This enhancement provides users with better visibility into the export process.

src/cli/export-pdf-core/utils/mergePDF.ts (1)

187-193: Great improvement! Using stderr for error messages.

Changing from stdout to stderr for error messages is the correct approach. This follows the Unix/Linux convention where:

stdout is for normal program output

stderr is specifically for diagnostic or error messages

This change improves script integration as it allows other tools to separate normal output from error conditions when piping or redirecting output.

✨ Finishing Touches

📝 Generate Docstrings

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

Copilot

Pull Request Overview

This PR enhances the export command by adding logging and improving error handling while updating the Node version.

Adds a log statement to provide feedback about the export process
Redirects error output to stderr in mergePDF for proper error indication
Adjusts the exported message format in generatePdf
Updates the Node version in .nvmrc

Reviewed Changes

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

File	Description
src/cli/export.ts	Introduces a logger.start message to indicate export parameters
src/cli/export-pdf-core/utils/mergePDF.ts	Switches error output from stdout to stderr for clearer error signaling
src/cli/export-pdf-core/generatePdf.ts	Removes an extraneous newline in the export success message
.nvmrc	Updates the Node version from v20.19.1 to v20.19.2

pkg-pr-new · 2025-05-20T05:23:03Z

Open in StackBlitz

npm i https://pkg.pr.new/@alauda/doom@25

commit: 6555aab

JounQin requested a review from Copilot May 20, 2025 05:21

JounQin self-assigned this May 20, 2025

JounQin added the internal label May 20, 2025

Copilot AI reviewed May 20, 2025

View reviewed changes

feat: add exporting log info

6555aab

JounQin force-pushed the feat/export_log branch from 574c7a0 to 6555aab Compare May 20, 2025 05:23

JounQin merged commit 9508fd5 into main May 20, 2025
16 checks passed

JounQin deleted the feat/export_log branch May 20, 2025 05:26

github-actions bot mentioned this pull request May 20, 2025

chore: release @alauda/doom #26

Merged

github-actions bot pushed a commit that referenced this pull request May 20, 2025

feat: add exporting log info (#25)

38c9f06

coderabbitai bot mentioned this pull request Aug 26, 2025

feat: migrate to mono repo #159

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add exporting log info #25

feat: add exporting log info #25

Uh oh!

JounQin commented May 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented May 20, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 20, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

pkg-pr-new bot commented May 20, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: add exporting log info #25

feat: add exporting log info #25

Uh oh!

Conversation

JounQin commented May 20, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

pkg-pr-new bot commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JounQin commented May 20, 2025 •

edited by coderabbitai bot

Loading

changeset-bot bot commented May 20, 2025 •

edited

Loading

coderabbitai bot commented May 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented May 20, 2025 •

edited

Loading