feat(mono-pub): add ignoreDependencies option to resolve cycles

[SavelevMatthew]

Summary by CodeRabbit

• New Features
  • Added the ability to ignore specific dependencies when determining execution order during publishing, allowing for more flexible handling of dependency cycles.
• Tests
  • Introduced new test cases to verify correct behavior when dependencies are ignored, including scenarios with cyclic dependencies.

[coderabbitai]

Walkthrough

The changes introduce an ignoreDependencies option to the publishing and dependency resolution process. This option allows specific dependencies to be ignored when determining execution order, affecting both the internal logic and type declarations. New tests verify correct behavior when dependency cycles are broken using this feature.

Changes

File(s)	Change Summary
.../src/index.ts	Added ignoreDependencies extraction from options and included it in the publishing context.
.../src/types/config.ts	Introduced IgnoringDependencies type; updated MonoPubContext and MonoPubOptions to include ignoreDependencies; added comments.
.../src/utils/deps.ts	Added ignoreDependencies to TaskPlanningOptions and updated getExecutionOrder to filter dependencies accordingly.
.../src/utils/deps.spec.ts	Added tests for getExecutionOrder with various ignoreDependencies scenarios, including cycle-breaking and batching.
.../src/utils/plugins.spec.ts	Added ignoreDependencies as empty object in test context for CombinedPlugin suite.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant publish (index.ts)
    participant getExecutionOrder (deps.ts)
    participant Context

    User->>publish (index.ts): Call publish(paths, plugins, { ignoreDependencies, ... })
    publish (index.ts)->>Context: Create context with ignoreDependencies
    publish (index.ts)->>getExecutionOrder (deps.ts): Call getExecutionOrder(packages, { ignoreDependencies })
    getExecutionOrder (deps.ts)->>getExecutionOrder (deps.ts): Filter dependencies per ignoreDependencies
    getExecutionOrder (deps.ts)-->>publish (index.ts): Return execution order
    publish (index.ts)-->>User: Complete publishing process

Loading

---

📜 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 31bf9c9 and 1c2f199.

📒 Files selected for processing (2)

• packages/mono-pub/src/utils/deps.spec.ts (2 hunks)
• packages/mono-pub/src/utils/plugins.spec.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/mono-pub/src/utils/deps.spec.ts

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/mono-pub/src/utils/plugins.spec.ts (1)

packages/mono-pub/src/logger.ts (1)

• getLogger (8-18)

🔇 Additional comments (1)

packages/mono-pub/src/utils/plugins.spec.ts (1)

176-181:

Details

✅ Verification successful

LGTM! Test context properly updated for new interface.

The addition of ignoreDependencies: {} correctly aligns the test context with the updated MonoPubContext type. Using an empty object as the default value is appropriate for test scenarios.

Let me verify that this change aligns with the actual type definition:

---

🏁 Script executed:

#!/bin/bash
# Description: Verify that the MonoPubContext type includes ignoreDependencies property
# Expected: The type definition should include ignoreDependencies as a property

# Search for MonoPubContext type definition
ast-grep --pattern 'interface MonoPubContext {
  $$$
}'

# Also search for any type alias definitions
ast-grep --pattern 'type MonoPubContext = {
  $$$
}'

Length of output: 1243

---

Approve test context update for ignoreDependencies

Verified that MonoPubContext (in packages/mono-pub/src/types/config.ts) indeed defines

ignoreDependencies: IgnoringDependencies

and an empty object ({}) is a valid default for that index-signature type in tests. No further changes needed.

✨ 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:

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