Skip to content

Conversation

@GTFalcao
Copy link
Collaborator

@GTFalcao GTFalcao commented Oct 7, 2025

PR that adds this rule: PipedreamHQ/eslint-plugin-pipedream#15

Note 1: package versions are not being updated as this info is irrelevant when importing the package (it is relevant when the components are used directly as MCP tools). This was the same when mass updating existing components to include the annotations.

Note 2: this can be tested by running npx eslint components/gmail/actions which should succeed with no warnings, then you can remove the annotations object or one of its properties from a gmail action, and the same command should emit an error.

Summary by CodeRabbit

  • Chores
    • Updated linting rules to enforce action annotations for source/action files and relaxed them for shared common files.
    • Upgraded ESLint plugin to v0.3.0.
    • Added descriptive annotation metadata and bumped manifest versions across many actions/components to improve metadata consistency; no runtime or user-facing behavior changes.

@vercel
Copy link

vercel bot commented Oct 7, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments
Project Deployment Preview Comments Updated (UTC)
pipedream-docs Ignored Ignored Oct 9, 2025 9:56pm
pipedream-docs-redirect-do-not-edit Ignored Ignored Oct 9, 2025 9:56pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 7, 2025

Walkthrough

Batch update: added an annotations object and bumped the version field in many action modules under components/*/actions/*/*.mjs; updated ESLint config to enforce the pipedream/action-annotations rule for actions/sources and disabled it for common files; bumped @pipedream/eslint-plugin-pipedream devDependency.

Changes

Cohort / File(s) Summary of Changes
ESLint rule configuration
eslint.config.mjs
Enabled pipedream/action-annotations as "error" for action/source files and set it to "off" for common files under actions/sources.
Dev dependency update
package.json
Bumped @pipedream/eslint-plugin-pipedream devDependency from 0.2.50.3.0.
Action metadata updates (many components)
components/*/actions/*/*.mjs
For numerous action modules: added an annotations object (keys: destructiveHint, openWorldHint, readOnlyHint) to the exported default action and incremented the exported version (e.g., "0.0.1""0.0.2"; some "0.0.2""0.0.3"). No runtime/control-flow changes.

Sequence Diagram(s)

(Skipped — changes are metadata-only; no control-flow or new feature to diagram.)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • pipedream-component-development
  • js07

Poem

"I’m a rabbit with a linting map,
I nudge annotations into each app.
Versions hop up, files stay neat,
Rules enforce a tidy fleet.
Carrots for reviewers — swift and sweet! 🥕"

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description does not conform to the repository’s required template: it lacks the “## WHY” section and does not follow the outlined structure, so the rationale is not explicitly documented. Please update the PR description to follow the repository template by adding a “## WHY” section and clearly describing the motivation and goals of the change.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly describes the primary change of the pull request—adding the new action-annotations ESLint rule—and directly reflects the modifications in the ESLint configuration without unnecessary detail or noise.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-eslint-annotations-rule

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af1feab and 74ffb5f.

📒 Files selected for processing (2)
  • eslint.config.mjs (2 hunks)
  • package.json (1 hunks)
🔇 Additional comments (1)
eslint.config.mjs (1)

219-219: LGTM! Rule configuration is consistent.

The action-annotations rule is appropriately enabled for action/source files and disabled for common utility files. This configuration aligns well with the existing pipedream rules pattern.

Also applies to: 240-240

@lcaresia lcaresia moved this from Ready for PR Review to Ready for QA in Component (Source and Action) Backlog Oct 9, 2025
@GTFalcao GTFalcao merged commit 4bb9102 into master Oct 9, 2025
9 of 10 checks passed
@GTFalcao GTFalcao deleted the add-eslint-annotations-rule branch October 9, 2025 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants