Release/ticker docs - #63
Merged
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughPlugin publishing guidance, package metadata, documentation URLs, and documentation harvesting are updated. Harvesting now processes both local plugins and installed external Tempo plugins with external collision handling. ChangesPlugin publishing and documentation
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant LocalPlugins
participant ExternalPlugins
participant HarvestPlugins
participant GeneratedDocs
LocalPlugins->>HarvestPlugins: Scan local plugin documentation
HarvestPlugins->>GeneratedDocs: Rewrite links and write output
ExternalPlugins->>HarvestPlugins: Scan installed tempo-plugin-* documentation
HarvestPlugins->>GeneratedDocs: Skip collisions or write external output
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
packages/plugins/.setup/community-plugin-template.md (1)
7-17: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winInclude the new package publication metadata in the template.
The
package.jsontemplate is missing several configuration fields that were recently standardized for Community plugin publishing in this PR (such as infinance/package.json). Consider adding the following requirements to this template to ensure new plugins are configured consistently and correctly exported:
"type": "module""files"array (e.g.,["dist", "src", "README.md", "CHANGELOG.md", "LICENSE"])"publishConfig"(registry and public access)"exports"(definingtypesandimportentrypoints)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/plugins/.setup/community-plugin-template.md` around lines 7 - 17, Update the package.json template in the community plugin configuration to include the standardized publication metadata: set type to module, add the published files array, configure public npm publishing through publishConfig, and define exports with types and import entrypoints. Preserve the existing version, license, scripts, keywords, and tempo.plan requirements.packages/plugins/snap/README.md (1)
9-9: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueConsider using hyphens for compound adjectives.
For better readability and grammatical correctness, consider using hyphens when forming compound adjectives like "15-minute" and "1-hour".
💡 Proposed fix
-A Community plugin for the [Tempo](https://github.com/magmacomputing/magma) library that provides robust time rounding and snapping functionality (e.g. snapping to the nearest 15 minutes or 1 hour block) for calendar and scheduling applications. +A Community plugin for the [Tempo](https://github.com/magmacomputing/magma) library that provides robust time rounding and snapping functionality (e.g. snapping to the nearest 15-minute or 1-hour block) for calendar and scheduling applications.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/plugins/snap/README.md` at line 9, Update the plugin description’s compound time-unit adjectives to use hyphens, changing “15 minutes” to “15-minute” and “1 hour” to “1-hour” while preserving the surrounding wording.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/plugins/.setup/community-plugin-template.md`:
- Around line 7-17: Update the package.json template in the community plugin
configuration to include the standardized publication metadata: set type to
module, add the published files array, configure public npm publishing through
publishConfig, and define exports with types and import entrypoints. Preserve
the existing version, license, scripts, keywords, and tempo.plan requirements.
In `@packages/plugins/snap/README.md`:
- Line 9: Update the plugin description’s compound time-unit adjectives to use
hyphens, changing “15 minutes” to “15-minute” and “1 hour” to “1-hour” while
preserving the surrounding wording.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: c3be2367-4bb0-413f-b11b-8249a337c4f6
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (15)
packages/plugins/.setup/community-plugin-template.mdpackages/plugins/astro/README.mdpackages/plugins/astro/package.jsonpackages/plugins/batch/README.mdpackages/plugins/batch/package.jsonpackages/plugins/finance/README.mdpackages/plugins/finance/package.jsonpackages/plugins/snap/README.mdpackages/plugins/snap/package.jsonpackages/plugins/sync/README.mdpackages/plugins/sync/package.jsonpackages/plugins/ticker/README.mdpackages/plugins/ticker/doc/index.mdpackages/tempo/bin/harvest-plugins.mjspackages/tempo/package.json
💤 Files with no reviewable changes (2)
- packages/plugins/ticker/doc/index.md
- packages/plugins/ticker/README.md
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Documentation
Maintenance