Skip to content

[Test] Set up npm workspace for doc-detective/common #29

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

Merged
merged 2 commits into from
Jun 20, 2025
Merged

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jun 19, 2025

Thanks for assigning this issue to me. I'm starting to work on it and will keep this PR's description up to date as I form a plan and make progress.

Original issue description:

We should be able to modify all dependent related libraries in one go, and npm workspace could help us achieve this. Add a workspace for doc-detective/common, including a helper post-install script to pull and install the workspace repos.

Fixes #28.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@hawkeyexl
Copy link
Contributor

@copilot Take another go at this.

Copy link
Contributor Author

Copilot AI commented Jun 20, 2025

@copilot Take another go at this.

Implementation complete! I've successfully set up npm workspace functionality for doc-detective/common with:

  • Automatic workspace setup via post-install script
  • Manual setup command: npm run workspace:install
  • Workspace-aware test/build commands
  • CI environment detection with skip/force options
  • Updated documentation

The workspace setup automatically clones and manages the doc-detective/common repository, enabling seamless development of both packages together as requested in issue #28.

Commit: 7b3adb3

@Copilot Copilot AI requested a review from hawkeyexl June 20, 2025 02:08
Copilot finished work on behalf of hawkeyexl June 20, 2025 02:08
@hawkeyexl
Copy link
Contributor

@copilot Does this affect how the dependency is managed when published to NPM? Any special considerations?

Copy link
Contributor Author

Copilot AI commented Jun 20, 2025

@copilot Does this affect how the dependency is managed when published to NPM? Any special considerations?

The workspace setup doesn't affect NPM publishing or dependency management for the published package. Here are the key considerations:

No Impact on Published Package:

  • The workspaces/ directory is gitignored and excluded from the published package
  • The regular dependency "doc-detective-common": "^3.1.1-dev.1" in package.json remains unchanged
  • When users install the published package, they get the standard NPM version of doc-detective-common

Development vs Production:

  • Development: npm prefers the local workspace version when available
  • Production: Uses the published NPM version specified in dependencies
  • CI/CD: Workspace setup is automatically skipped in CI environments

Special Considerations:

  • Version synchronization between workspace and published versions should be maintained
  • Testing should verify compatibility with both workspace and published versions
  • The post-install script only runs during development setup, not when the package is installed by end users

The workspace is purely a development convenience that enables simultaneous modification of both packages without affecting the published package structure or dependencies.

Copilot finished work on behalf of hawkeyexl June 20, 2025 02:13
@hawkeyexl hawkeyexl marked this pull request as ready for review June 20, 2025 02:26
Copy link
Contributor

coderabbitai bot commented Jun 20, 2025

Important

Review skipped

Bot user detected.

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.


🪧 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? Join our Discord community 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 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.

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.

@hawkeyexl hawkeyexl changed the title [WIP] Set up npm workspace for doc-detective/common [Test] Set up npm workspace for doc-detective/common Jun 20, 2025
@hawkeyexl hawkeyexl merged commit 269ad70 into main Jun 20, 2025
16 checks passed
@hawkeyexl hawkeyexl deleted the copilot/fix-28 branch June 20, 2025 02:26
Copy link

promptless bot commented Jun 20, 2025

📝 Documentation updates detected!

New suggestion: Document doc-detective-resolver repository and npm workspace development workflow

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.

Set up npm workspace for doc-detective/common
2 participants