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

feat: output filename #1725

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

feat: output filename #1725

wants to merge 6 commits into from

Conversation

stormslowly
Copy link
Member

@stormslowly stormslowly commented Dec 17, 2024

a simple support for filename in output config

  • only enabled in prod mode within ast_impl.rs
  • [name] [id] [hash] [contenthash] supported, [hash] [contenthash] are same

@stormslowly stormslowly marked this pull request as draft December 17, 2024 05:58
Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

Walkthrough

This pull request introduces a new feature that allows specifying an output filename in the configuration. It modifies several components to accommodate this change, including the addition of a filename field in the OutputConfig struct and updates to chunk generation logic to utilize this new field.

Changes

File Summary
crates/mako/src/config/output.rs Added filename field to OutputConfig struct.
crates/mako/src/generate/chunk.rs Renamed filename method to name and added a new filename method.
crates/mako/src/generate/chunk_pot.rs Added chunk_name field and updated logic to use chunk.name().
crates/mako/src/generate/chunk_pot/ast_impl.rs Added chunk_name and file_name_template fields to structures.
crates/mako/src/generate/chunk_pot/str_impl.rs Added chunk_name and file_name_template fields to structures.
crates/mako/src/generate/generate_chunks.rs Added chunk_name and file_name_template fields, and updated filename generation logic.

@@ -117,6 +117,10 @@ impl Chunk {
}
}

pub fn filename(&self) -> String {

Choose a reason for hiding this comment

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

The new filename method returns a string with .js appended to the chunk name. Ensure that this logic aligns with the intended use of the filename field in the configuration.

Copy link

codecov bot commented Dec 17, 2024

Codecov Report

Attention: Patch coverage is 26.31579% with 56 lines in your changes missing coverage. Please review.

Project coverage is 54.88%. Comparing base (af25d70) to head (a082a7a).

Files with missing lines Patch % Lines
crates/mako/src/generate/generate_chunks.rs 15.78% 48 Missing ⚠️
crates/mako/src/generate/chunk_pot/ast_impl.rs 42.85% 4 Missing ⚠️
crates/mako/src/generate/chunk_pot/str_impl.rs 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1725      +/-   ##
==========================================
+ Coverage   54.83%   54.88%   +0.04%     
==========================================
  Files         179      179              
  Lines       17896    17923      +27     
==========================================
+ Hits         9814     9837      +23     
- Misses       8082     8086       +4     

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

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