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(content-utils): Add support for new CC config file #198

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Fryuni
Copy link
Owner

@Fryuni Fryuni commented Feb 7, 2025

Summary by CodeRabbit

  • New Features
    • Introduced a dedicated content collections configuration option to streamline content organization.
    • Enhanced the system’s ability to detect and load configuration files, providing a more flexible and efficient content management experience.

@Fryuni Fryuni requested a review from BryceRussell February 7, 2025 17:47
@Fryuni Fryuni self-assigned this Feb 7, 2025
Copy link

coderabbitai bot commented Feb 7, 2025

Walkthrough

The changes introduce a new patch for the @inox-tools/content-utils package by adding support for a dedicated content collections configuration file. Additionally, the configuration resolution logic has been updated. The possible configuration filenames now include additional entries, and the approach used in resolveContentPaths has been modified to utilize a new validConfigPaths array with baseResolver. A fallback mechanism now returns the first valid config if none of the candidates are found.

Changes

File(s) Change Summary
.changeset/popular-terms-pump.md Added patch for @inox-tools/content-utils to support a dedicated content collections configuration file.
packages/…/resolver.ts Expanded the possibleConfigs array to include more candidate filenames/paths and modified resolveContentPaths to use validConfigPaths via baseResolver with a fallback to the first valid config.

Sequence Diagram(s)

sequenceDiagram
  participant Caller as Caller
  participant Resolver as Resolver
  participant FileSystem as FileSystem

  Caller->>Resolver: Call resolveContentPaths()
  Resolver->>Resolver: Generate validConfigPaths from possibleConfigs using baseResolver
  Resolver->>FileSystem: Check existence of each candidate config file
  FileSystem-->>Resolver: Return existence status
  alt Config Found
    Resolver->>Caller: Return found config file
  else No Config Found
    Resolver->>Caller: Return first candidate as fallback
  end
Loading

Poem

I'm a bunny coding with glee,
Hopping through files as swift as can be.
New config paths laid out in a row,
Like carrots waiting for the code to grow.
With every tweak I joyfully leap,
Celebrating changes small and deep.
🐇 Let the code garden forever keep!

✨ 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

vercel bot commented Feb 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
inox-tools ❌ Failed (Inspect) Feb 7, 2025 5:47pm

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/content-utils/src/internal/resolver.ts (1)

35-37: Consider adding a comment to explain the fallback behavior.

The logic is correct, but it would be helpful to add a comment explaining why we fallback to the first valid path when no config exists.

 const existingConfig = validConfigPaths.find((configPath) => existsSync(configPath));

+// Fallback to the first valid path (content.config.ts) when no config exists
+// This ensures consistent behavior and enables type checking in IDEs
 const configFile = existingConfig ?? validConfigPaths[0];
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f7fc76e and 0aa1df7.

📒 Files selected for processing (2)
  • .changeset/popular-terms-pump.md (1 hunks)
  • packages/content-utils/src/internal/resolver.ts (2 hunks)
🔇 Additional comments (3)
packages/content-utils/src/internal/resolver.ts (2)

7-16: LGTM! Well-structured configuration paths.

The expanded configuration paths follow a consistent pattern and prioritize root-level content config files. The changes align well with the PR objectives.


31-33: LGTM! Proper path resolution.

Using baseResolver ensures all paths are correctly resolved relative to the source directory.

.changeset/popular-terms-pump.md (1)

1-6: LGTM! Clear and appropriate changeset.

The patch version bump and description accurately reflect the changes made.

Copy link
Collaborator

@BryceRussell BryceRussell left a comment

Choose a reason for hiding this comment

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

LGTM!!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants