Skip to content

Todoist - adding info label #16196

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Conversation

GTFalcao
Copy link
Collaborator

@GTFalcao GTFalcao commented Apr 8, 2025

Closes #16092

Summary by CodeRabbit

  • New Features

    • Added an on-screen guidance message for creating recurring tasks, featuring an example ("every week") and a link for more information.
  • Chores

    • Performed minor version and dependency updates to ensure continued system reliability.

Copy link

vercel bot commented Apr 8, 2025

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

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Apr 15, 2025 0:15am
pipedream-docs ⬜️ Ignored (Inspect) Apr 15, 2025 0:15am
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Apr 15, 2025 0:15am

Copy link
Contributor

coderabbitai bot commented Apr 8, 2025

Walkthrough

This pull request updates version numbers and adds new informational guidance within the Todoist integration. In the create-task module, the version is bumped from 0.0.4 to 0.0.5 and a new property, recurringInfoLabel, is introduced to inform users on creating recurring tasks. The package.json file is similarly updated, with its version incremented and the dependency on @pipedream/platform upgraded.

Changes

File(s) Change Summary
components/todoist/actions/create-task/create-task.mjs Updated version from 0.0.4 to 0.0.5; added new recurringInfoLabel property (alert type: info) with instructions for creating recurring tasks.
components/todoist/package.json Updated version from 0.1.3 to 0.1.4; upgraded dependency @pipedream/platform from ^1.2.1 to ^3.0.3.

Assessment against linked issues

Objective Addressed Explanation
Add Todoist is_recurring property (#16092) The PR adds an informational label but does not implement the expected boolean "is_recurring" prop.

Poem

I'm the rabbit of code, with hops so spry,
Bumping versions and hints as time goes by.
A label with secrets for recurring tasks unfolds,
In Todoist's realm, where each detail boldly holds.
With a twitch of my whiskers, I cheer this update anew! 🐰✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/todoist/actions/create-task/create-task.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

✨ 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
🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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
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 a34b8f1 and 5869300.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • components/todoist/actions/create-task/create-task.mjs (1 hunks)
  • components/todoist/package.json (2 hunks)
🧰 Additional context used
🪛 GitHub Check: Lint Code Base
components/todoist/actions/create-task/create-task.mjs

[warning] 11-11:
Component prop recurringInfoLabel must have a label. See https://pipedream.com/docs/components/guidelines/#props


[warning] 11-11:
Component prop recurringInfoLabel must have a description. See https://pipedream.com/docs/components/guidelines/#props

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: pnpm publish
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Publish TypeScript components
🔇 Additional comments (3)
components/todoist/package.json (2)

3-3: LGTM: Version number updated appropriately

The version number has been correctly incremented from 0.1.3 to 0.1.4, which aligns with the addition of new functionality in the Todoist component.


13-13:

❓ Verification inconclusive

Significant platform dependency upgrade

The @pipedream/platform dependency has been updated from ^1.2.1 to ^3.0.3, which is a major version jump. This could include breaking changes, but seems intentional to support the new functionality.


🏁 Script executed:

#!/bin/bash
# Check for any breaking changes mentioned in release notes or changelogs
# that might affect this component
fd -t f "CHANGELOG.md" . | xargs grep -l "@pipedream/platform" | xargs cat

Length of output: 72


Major Dependency Upgrade – Manual Verification Recommended

The upgrade of @pipedream/platform from version ^1.2.1 to ^3.0.3 represents a major version jump and may introduce breaking changes. An automated scan of available changelog files didn’t return any indications of breaking changes, but this result is inconclusive. Please manually verify the dependency’s release notes or migration guide to ensure that no critical changes are overlooked.

  • Location: components/todoist/package.json (Line 13)
  • Action Required: Manually review the official documentation/changelog for @pipedream/platform to confirm that the upgrade is safe.
components/todoist/actions/create-task/create-task.mjs (1)

7-7: LGTM: Version number updated appropriately

The version number has been correctly incremented from 0.0.4 to 0.0.5, which reflects the addition of the new informational property.

Comment on lines +11 to +15
recurringInfoLabel: {
type: "alert",
alertType: "info",
content: "To create a recurring task, use the `Due String` prop with a value such as `every week`. [See the Todoist documentation on recurring dates](https://www.todoist.com/help/articles/introduction-to-recurring-dates-YUYVJJAV) for more examples and information.",
},
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add missing 'label' and 'description' to the recurringInfoLabel prop

The new property correctly provides useful information about creating recurring tasks, but it's missing the required label and description fields according to the component guidelines.

Please update the prop definition as follows:

 recurringInfoLabel: {
   type: "alert",
   alertType: "info",
+  label: "Recurring Tasks Information",
+  description: "Information about creating recurring tasks in Todoist",
   content: "To create a recurring task, use the `Due String` prop with a value such as `every week`. [See the Todoist documentation on recurring dates](https://www.todoist.com/help/articles/introduction-to-recurring-dates-YUYVJJAV) for more examples and information.",
 },
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
recurringInfoLabel: {
type: "alert",
alertType: "info",
content: "To create a recurring task, use the `Due String` prop with a value such as `every week`. [See the Todoist documentation on recurring dates](https://www.todoist.com/help/articles/introduction-to-recurring-dates-YUYVJJAV) for more examples and information.",
},
recurringInfoLabel: {
type: "alert",
alertType: "info",
label: "Recurring Tasks Information",
description: "Information about creating recurring tasks in Todoist",
content: "To create a recurring task, use the `Due String` prop with a value such as `every week`. [See the Todoist documentation on recurring dates](https://www.todoist.com/help/articles/introduction-to-recurring-dates-YUYVJJAV) for more examples and information.",
},
🧰 Tools
🪛 GitHub Check: Lint Code Base

[warning] 11-11:
Component prop recurringInfoLabel must have a label. See https://pipedream.com/docs/components/guidelines/#props


[warning] 11-11:
Component prop recurringInfoLabel must have a description. See https://pipedream.com/docs/components/guidelines/#props

luancazarine
luancazarine previously approved these changes Apr 8, 2025
Copy link
Collaborator

@luancazarine luancazarine left a comment

Choose a reason for hiding this comment

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

Hi @GTFalcao, LGTM! Ready for QA!

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.

[FEATURE] Todoist - Recurring prop
2 participants