Skip to content

Comments

Rule naming#915

Merged
elie222 merged 3 commits intomainfrom
fix/rule-naming
Nov 5, 2025
Merged

Rule naming#915
elie222 merged 3 commits intomainfrom
fix/rule-naming

Conversation

@elie222
Copy link
Owner

@elie222 elie222 commented Nov 5, 2025

Summary by CodeRabbit

  • Improvements

    • Strengthened rule-naming guidance to prefer short, concise (often single-word) names; AI-generated examples updated accordingly (e.g., "Newsletters", "Forward Urgent").
    • Added best-practice wording to AI prompts and schema help text to reinforce concise names.
    • Clarified assistant example prompts to better specify label targets (e.g., "Label emails from customers", "Label media inquiries to us").
    • Updated onboarding label descriptions for clearer wording.
  • Chores

    • Version bump to v2.17.40.

…for clarity and updated documentation to emphasize concise naming. Adjusted example rules to reflect new naming standards.
@vercel
Copy link

vercel bot commented Nov 5, 2025

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

Project Deployment Preview Updated (UTC)
inbox-zero Ready Ready Preview Nov 5, 2025 9:19pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 5, 2025

Caution

Review failed

The pull request is closed.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

Walkthrough

Updated naming guidance to favor short, single-word rule names; applied wording changes across AI prompts, schema descriptions, example rule entries, assistant docs, onboarding text, and bumped the version.

Changes

Cohort / File(s) Summary
AI rule prompts & schema
apps/web/utils/ai/rule/create-rule-schema.ts, apps/web/utils/ai/rule/create-rule.ts, apps/web/utils/ai/rule/prompt-to-rules.ts
Revised system prompts and schema description to instruct generating short, concise (preferably single-word) rule names; updated embedded example rule names to match guidance.
Assistant examples & docs
apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx, apps/web/app/(app)/[emailAccountId]/assistant/examples.ts, apps/web/utils/ai/assistant/chat.ts
Renamed example rule names and adjusted prompt/documentation text to use concise names and clearer target qualifiers (e.g., "Newsletters", "Label emails from customers"); added naming best-practice guidance in chat docs.
Onboarding content
apps/web/app/(app)/[emailAccountId]/onboarding/config.ts
Minor wording updates to suggested label descriptions to clarify recipient phrasing.
Version bump
version.txt
Bumped version from v2.17.39 to v2.17.40.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Mostly textual and prompt edits without behavioral or type changes.
  • Pay extra attention to:
    • apps/web/utils/ai/rule/prompt-to-rules.ts and create-rule.ts for prompt phrasing consistency.
    • Example files under assistant/ to ensure labels/names and descriptions remain coherent.

Possibly related PRs

Poem

🐰 I nibble words and trim the fluff,
Short names hop in, quick and enough.
"Newsletters" now bounces bright and clean,
Crisp rules, small hops — a tidy scene! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Rule naming' directly and clearly summarizes the main change of refining rule naming conventions across the AI assistant by shortening rule names and updating documentation.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 340e539 and 0e1f7cf.

📒 Files selected for processing (1)
  • apps/web/utils/ai/rule/prompt-to-rules.ts (4 hunks)

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

🧹 Nitpick comments (1)
apps/web/utils/ai/rule/prompt-to-rules.ts (1)

136-136: Consider updating this example for consistency.

While this line wasn't changed in this PR, the rule name "Matt Urgent Emails" doesn't follow the new short naming guidance. Consider whether this should be simplified to something like "Urgent" or "Matt Urgent" to maintain consistency across all examples.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 195d756 and 1f8e03d.

📒 Files selected for processing (6)
  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx (1 hunks)
  • apps/web/utils/ai/assistant/chat.ts (2 hunks)
  • apps/web/utils/ai/rule/create-rule-schema.ts (1 hunks)
  • apps/web/utils/ai/rule/create-rule.ts (1 hunks)
  • apps/web/utils/ai/rule/prompt-to-rules.ts (4 hunks)
  • version.txt (1 hunks)
🧰 Additional context used
📓 Path-based instructions (19)
apps/web/**/*.{ts,tsx}

📄 CodeRabbit inference engine (apps/web/CLAUDE.md)

apps/web/**/*.{ts,tsx}: Use TypeScript with strict null checks
Path aliases: Use @/ for imports from project root
Use proper error handling with try/catch blocks
Format code with Prettier
Leverage TypeScript inference for better DX

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
!{.cursor/rules/*.mdc}

📄 CodeRabbit inference engine (.cursor/rules/cursor-rules.mdc)

Never place rule files in the project root, in subdirectories outside .cursor/rules, or in any other location

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • version.txt
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
**/*.ts

📄 CodeRabbit inference engine (.cursor/rules/form-handling.mdc)

**/*.ts: The same validation should be done in the server action too
Define validation schemas using Zod

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/logging.mdc)

**/*.{ts,tsx}: Use createScopedLogger for logging in backend TypeScript files
Typically add the logger initialization at the top of the file when using createScopedLogger
Only use .with() on a logger instance within a specific function, not for a global logger

Import Prisma in the project using import prisma from "@/utils/prisma";

**/*.{ts,tsx}: Don't use TypeScript enums.
Don't use TypeScript const enum.
Don't use the TypeScript directive @ts-ignore.
Don't use primitive type aliases or misleading types.
Don't use empty type parameters in type aliases and interfaces.
Don't use any or unknown as type constraints.
Don't use implicit any type on variable declarations.
Don't let variables evolve into any type through reassignments.
Don't use non-null assertions with the ! postfix operator.
Don't misuse the non-null assertion operator (!) in TypeScript files.
Don't use user-defined types.
Use as const instead of literal types and type annotations.
Use export type for types.
Use import type for types.
Don't declare empty interfaces.
Don't merge interfaces and classes unsafely.
Don't use overload signatures that aren't next to each other.
Use the namespace keyword instead of the module keyword to declare TypeScript namespaces.
Don't use TypeScript namespaces.
Don't export imported variables.
Don't add type annotations to variables, parameters, and class properties that are initialized with literal expressions.
Don't use parameter properties in class constructors.
Use either T[] or Array consistently.
Initialize each enum member value explicitly.
Make sure all enum members are literal values.

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
apps/web/utils/**

📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)

Create utility functions in utils/ folder for reusable logic

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
apps/web/utils/**/*.ts

📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)

apps/web/utils/**/*.ts: Use lodash utilities for common operations (arrays, objects, strings)
Import specific lodash functions to minimize bundle size

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

**/*.{js,jsx,ts,tsx}: Don't use elements in Next.js projects.
Don't use elements in Next.js projects.
Don't use namespace imports.
Don't access namespace imports dynamically.
Don't use global eval().
Don't use console.
Don't use debugger.
Don't use var.
Don't use with statements in non-strict contexts.
Don't use the arguments object.
Don't use consecutive spaces in regular expression literals.
Don't use the comma operator.
Don't use unnecessary boolean casts.
Don't use unnecessary callbacks with flatMap.
Use for...of statements instead of Array.forEach.
Don't create classes that only have static members (like a static namespace).
Don't use this and super in static contexts.
Don't use unnecessary catch clauses.
Don't use unnecessary constructors.
Don't use unnecessary continue statements.
Don't export empty modules that don't change anything.
Don't use unnecessary escape sequences in regular expression literals.
Don't use unnecessary labels.
Don't use unnecessary nested block statements.
Don't rename imports, exports, and destructured assignments to the same name.
Don't use unnecessary string or template literal concatenation.
Don't use String.raw in template literals when there are no escape sequences.
Don't use useless case statements in switch statements.
Don't use ternary operators when simpler alternatives exist.
Don't use useless this aliasing.
Don't initialize variables to undefined.
Don't use the void operators (they're not familiar).
Use arrow functions instead of function expressions.
Use Date.now() to get milliseconds since the Unix Epoch.
Use .flatMap() instead of map().flat() when possible.
Use literal property access instead of computed property access.
Don't use parseInt() or Number.parseInt() when binary, octal, or hexadecimal literals work.
Use concise optional chaining instead of chained logical expressions.
Use regular expression literals instead of the RegExp constructor when possible.
Don't use number literal object member names th...

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
!pages/_document.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

!pages/_document.{js,jsx,ts,tsx}: Don't import next/document outside of pages/_document.jsx in Next.js projects.
Don't import next/document outside of pages/_document.jsx in Next.js projects.

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • version.txt
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
apps/web/utils/ai/**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/llm.mdc)

apps/web/utils/ai/**/*.{ts,tsx}: Place main LLM feature implementations under apps/web/utils/ai/
LLM feature functions should follow the provided TypeScript pattern (separate system/user prompts, use createGenerateObject, Zod schema validation, early validation, return result.object)
Keep system prompts and user prompts separate
System prompt should define the LLM's role and task specifications
User prompt should contain the actual data and context
Always define a Zod schema for response validation
Make Zod schemas as specific as possible to guide LLM output
Use descriptive scoped loggers for each feature
Log inputs and outputs with appropriate log levels and include relevant context
Implement early returns for invalid inputs
Use proper error types and logging for failures
Implement fallbacks for AI failures
Add retry logic for transient failures using withRetry
Use XML-like tags to structure data in prompts
Remove excessive whitespace and truncate long inputs in prompts
Format prompt data consistently across similar functions
Use TypeScript types for all parameters and return values in LLM features
Define clear interfaces for complex input/output structures in LLM features

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
apps/web/utils/{ai,llms}/**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/llm.mdc)

Keep related AI functions co-located and extract common patterns into utilities; document complex AI logic with clear comments

Files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
apps/web/app/**

📄 CodeRabbit inference engine (apps/web/CLAUDE.md)

NextJS app router structure with (app) directory

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
apps/web/**/*.tsx

📄 CodeRabbit inference engine (apps/web/CLAUDE.md)

apps/web/**/*.tsx: Follow tailwindcss patterns with prettier-plugin-tailwindcss
Prefer functional components with hooks
Use shadcn/ui components when available
Ensure responsive design with mobile-first approach
Follow consistent naming conventions (PascalCase for components)
Use LoadingContent component for async data
Use result?.serverError with toastError and toastSuccess
Use LoadingContent component to handle loading and error states consistently
Pass loading, error, and children props to LoadingContent

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
**/*.tsx

📄 CodeRabbit inference engine (.cursor/rules/form-handling.mdc)

**/*.tsx: Use React Hook Form with Zod for validation
Validate form inputs before submission
Show validation errors inline next to form fields

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
apps/web/app/(app)/*/**

📄 CodeRabbit inference engine (.cursor/rules/page-structure.mdc)

Components for the page are either put in page.tsx, or in the apps/web/app/(app)/PAGE_NAME folder

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
apps/web/app/(app)/*/**/*.tsx

📄 CodeRabbit inference engine (.cursor/rules/page-structure.mdc)

If you need to use onClick in a component, that component is a client component and file must start with 'use client'

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
apps/web/app/(app)/*/**/**/*.tsx

📄 CodeRabbit inference engine (.cursor/rules/page-structure.mdc)

If we're in a deeply nested component we will use swr to fetch via API

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
apps/web/app/**/*.tsx

📄 CodeRabbit inference engine (.cursor/rules/project-structure.mdc)

Components with onClick must be client components with use client directive

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
**/*.{jsx,tsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

**/*.{jsx,tsx}: Don't destructure props inside JSX components in Solid projects.
Don't use both children and dangerouslySetInnerHTML props on the same element.
Don't use Array index in keys.
Don't assign to React component props.
Don't define React components inside other components.
Don't use event handlers on non-interactive elements.
Don't assign JSX properties multiple times.
Don't add extra closing tags for components without children.
Use <>...</> instead of ....
Don't insert comments as text nodes.
Don't use the return value of React.render.
Make sure all dependencies are correctly specified in React hooks.
Make sure all React hooks are called from the top level of component functions.
Don't use unnecessary fragments.
Don't pass children as props.
Use semantic elements instead of role attributes in JSX.

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
**/*.{html,jsx,tsx}

📄 CodeRabbit inference engine (.cursor/rules/ultracite.mdc)

**/*.{html,jsx,tsx}: Don't use or elements.
Don't use accessKey attribute on any HTML element.
Don't set aria-hidden="true" on focusable elements.
Don't add ARIA roles, states, and properties to elements that don't support them.
Only use the scope prop on elements.
Don't assign non-interactive ARIA roles to interactive HTML elements.
Make sure label elements have text content and are associated with an input.
Don't assign interactive ARIA roles to non-interactive HTML elements.
Don't assign tabIndex to non-interactive HTML elements.
Don't use positive integers for tabIndex property.
Don't include "image", "picture", or "photo" in img alt prop.
Don't use explicit role property that's the same as the implicit/default role.
Make static elements with click handlers use a valid role attribute.
Always include a title element for SVG elements.
Give all elements requiring alt text meaningful information for screen readers.
Make sure anchors have content that's accessible to screen readers.
Assign tabIndex to non-interactive HTML elements with aria-activedescendant.
Include all required ARIA attributes for elements with ARIA roles.
Make sure ARIA properties are valid for the element's supported roles.
Always include a type attribute for button elements.
Make elements with interactive roles and handlers focusable.
Give heading elements content that's accessible to screen readers (not hidden with aria-hidden).
Always include a lang attribute on the html element.
Always include a title attribute for iframe elements.
Accompany onClick with at least one of: onKeyUp, onKeyDown, or onKeyPress.
Accompany onMouseOver/onMouseOut with onFocus/onBlur.
Include caption tracks for audio and video elements.
Make sure all anchors are valid and navigable.
Ensure all ARIA properties (aria-*) are valid.
Use valid, non-abstract ARIA roles for elements with ARIA roles.
Use valid ARIA state and property values.
Use valid values for the autocomplete attribute on input eleme...

Files:

  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
🧠 Learnings (13)
📓 Common learnings
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-07-18T15:04:36.476Z
Learning: Applies to .cursor/rules/*.mdc : Follow the naming convention: use kebab-case for filenames, always use .mdc extension, and make names descriptive of the rule's purpose
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : Make Zod schemas as specific as possible to guide LLM output

Applied to files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : LLM feature functions should follow the provided TypeScript pattern (separate system/user prompts, use createGenerateObject, Zod schema validation, early validation, return result.object)

Applied to files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/{ai,llms}/**/*.{ts,tsx} : Keep related AI functions co-located and extract common patterns into utilities; document complex AI logic with clear comments

Applied to files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : System prompt should define the LLM's role and task specifications

Applied to files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-07-18T17:27:58.249Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/server-actions.mdc:0-0
Timestamp: 2025-07-18T17:27:58.249Z
Learning: Applies to apps/web/utils/actions/*.validation.ts : Define input validation schemas using Zod in the corresponding `.validation.ts` file. These schemas are used by `next-safe-action` (`.schema()`) and can also be reused on the client for form validation.

Applied to files:

  • apps/web/utils/ai/rule/create-rule-schema.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : Remove excessive whitespace and truncate long inputs in prompts

Applied to files:

  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : Keep system prompts and user prompts separate

Applied to files:

  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : Format prompt data consistently across similar functions

Applied to files:

  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : Use XML-like tags to structure data in prompts

Applied to files:

  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : User prompt should contain the actual data and context

Applied to files:

  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/rule/create-rule.ts
📚 Learning: 2025-09-17T22:05:28.646Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/llm.mdc:0-0
Timestamp: 2025-09-17T22:05:28.646Z
Learning: Applies to apps/web/utils/ai/**/*.{ts,tsx} : Place main LLM feature implementations under apps/web/utils/ai/

Applied to files:

  • apps/web/utils/ai/rule/prompt-to-rules.ts
  • apps/web/utils/ai/assistant/chat.ts
📚 Learning: 2025-07-18T15:04:36.476Z
Learnt from: CR
Repo: elie222/inbox-zero PR: 0
File: .cursor/rules/cursor-rules.mdc:0-0
Timestamp: 2025-07-18T15:04:36.476Z
Learning: Applies to .cursor/rules/*.mdc : Follow the naming convention: use kebab-case for filenames, always use .mdc extension, and make names descriptive of the rule's purpose

Applied to files:

  • apps/web/utils/ai/assistant/chat.ts
  • apps/web/utils/ai/rule/create-rule.ts
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: cubic · AI code reviewer
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: test
🔇 Additional comments (7)
apps/web/utils/ai/rule/create-rule.ts (1)

11-11: Short-name guidance looks good.

Explicitly nudging the model toward single-word rule names aligns with the new schema description and examples. 👍

version.txt (1)

1-1: Version bump aligns with the doc changes.

Thanks for keeping version.txt in sync with the naming-guideline updates.

apps/web/utils/ai/assistant/chat.ts (1)

708-750: Assistant guidance stays consistent.

The new best-practice bullet plus the shortened example name reinforce the concise naming rule without altering logic—nice polish.

apps/web/utils/ai/rule/create-rule-schema.ts (1)

115-118: Schema description matches the new convention.

Clear, concrete examples will keep generated rule names on target—looks great.

apps/web/app/(app)/[emailAccountId]/assistant/create/examples.tsx (1)

39-54: Example rule name fits the new standard.

Swapping in “Newsletters” keeps the showcase aligned with the concise naming guidance.

apps/web/utils/ai/rule/prompt-to-rules.ts (2)

61-62: Clear and effective naming guidance.

The new directive for short, concise rule names is well-articulated with concrete examples. This will help the LLM generate more user-friendly rule names.


79-79: Consistent updates to example rule names.

The shortened names ("Newsletters", "Call Requests") effectively demonstrate the new naming convention and align well with the guidance added above.

Also applies to: 171-171

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 6 files

Prompt for AI agents (all 1 issues)

Understand the root cause of the following 1 issues and fix them.


<file name="apps/web/utils/ai/rule/prompt-to-rules.ts">

<violation number="1" location="apps/web/utils/ai/rule/prompt-to-rules.ts:106">
Invalid JSON in prompt: the name value is missing the opening quote and trailing comma. Quote the string and add a comma to ensure a valid example.</violation>
</file>

React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.

{
"rules": [{
"name": "Forward Urgent Emails",
"name": Forward Urgent"
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Nov 5, 2025

Choose a reason for hiding this comment

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

Invalid JSON in prompt: the name value is missing the opening quote and trailing comma. Quote the string and add a comma to ensure a valid example.

Prompt for AI agents
Address the following comment on apps/web/utils/ai/rule/prompt-to-rules.ts at line 106:

<comment>Invalid JSON in prompt: the name value is missing the opening quote and trailing comma. Quote the string and add a comma to ensure a valid example.</comment>

<file context>
@@ -101,7 +103,7 @@ IMPORTANT: You must return a JSON object.
       {
         &quot;rules&quot;: [{
-          &quot;name&quot;: &quot;Forward Urgent Emails&quot;,
+          &quot;name&quot;: Forward Urgent&quot;
           &quot;condition&quot;: {
             &quot;aiInstructions&quot;: &quot;Apply this rule to emails mentioning system outages or critical issues&quot;
</file context>
Suggested change
"name": Forward Urgent"
"name": "Forward Urgent",

✅ Addressed in 0e1f7cf

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

@elie222 elie222 changed the title Refine rule naming conventions in AI assistant. Shortened rule names for clarity and updated documentation to emphasize concise naming. Adjusted example rules to reflect new naming standards. Rule naming Nov 5, 2025
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@elie222 elie222 merged commit 6dde27b into main Nov 5, 2025
12 of 14 checks passed
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

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.

1 participant