[ENG-327] Add description field to the setting

[trangdoan982]

https://www.loom.com/share/a7e7c8983eed4ece87c62b1d29089f40

Summary by CodeRabbit

• New Features

  • Added support for an optional description field to node types, allowing users to provide additional details.
  • Node type descriptions are now displayed below the node name in the interface.

• Improvements

  • Enhanced layout and styling of node type list items for better readability and organization.

• Bug Fixes

  • Improved validation for node names and formats to provide more accurate uniqueness checks.

[linear]

ENG-327 Add description field to node type in Obsidian plugin settings menu

[supabase]

This pull request has been ignored for the connected project zytfjzqyijgagqxrzbmz because there are no changes detected in packages/database/supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.

---

Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

[trangdoan982]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

📝 Walkthrough

Walkthrough

This update refactors node type validation functions to accept a single object parameter and improves uniqueness checks by excluding the current node. It adds an optional description field to node types, updates related type definitions, and modifies the layout and rendering of node type items in the UI for clarity and consistency.

Changes

File(s)	Change Summary
apps/obsidian/src/components/NodeTypeSettings.tsx	Refactored validation calls to use object parameters; added optional description field to FIELD_CONFIGS; updated UI layout and rendering for node type items.
apps/obsidian/src/types.ts	Added optional description property to the DiscourseNode type definition.
apps/obsidian/src/utils/validateNodeType.ts	Refactored validation functions to accept object parameters; improved uniqueness logic; removed helper function; updated error messages and callers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant NodeTypeSettings (UI)
    participant validateNodeName
    participant validateNodeFormat

    User->>NodeTypeSettings (UI): Edit or add node type (name, format, description)
    NodeTypeSettings (UI)->>validateNodeName: validateNodeName({name, currentNode, allNodes})
    validateNodeName-->>NodeTypeSettings (UI): ValidationResult
    NodeTypeSettings (UI)->>validateNodeFormat: validateNodeFormat({format, currentNode, allNodes})
    validateNodeFormat-->>NodeTypeSettings (UI): ValidationResult
    NodeTypeSettings (UI)-->>User: Display validation results and updated node type list

Loading

Possibly related PRs

• DiscourseGraphs/discourse-graph#99: Introduces the initial NodeTypeSettings.tsx component, which is directly refined by this PR.
• DiscourseGraphs/discourse-graph#271: Restructures NodeTypeSettings, including introducing FIELD_CONFIGS and validation logic, which this PR further modifies.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 59557e7 and 97889e8.

📒 Files selected for processing (3)

• apps/obsidian/src/components/NodeTypeSettings.tsx (4 hunks)
• apps/obsidian/src/types.ts (1 hunks)
• apps/obsidian/src/utils/validateNodeType.ts (4 hunks)

🧰 Additional context used

🧠 Learnings (4)

📓 Common learnings

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `node.type` serves as the UID field rather than having a conventional `node.uid` field. This is an unusual naming convention where the type field actually contains the unique identifier.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `type` serves as the unique identifier field, not a type classification field. The interface has no `uid` or `id` field, making `node.type` the correct field to use for UID-related operations.

apps/obsidian/src/types.ts (4)

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `node.type` serves as the UID field rather than having a conventional `node.uid` field. This is an unusual naming convention where the type field actually contains the unique identifier.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `type` serves as the unique identifier field, not a type classification field. The interface has no `uid` or `id` field, making `node.type` the correct field to use for UID-related operations.

Learnt from: sid597
PR: DiscourseGraphs/discourse-graph#232
File: apps/roam/src/utils/getAllDiscourseNodesSince.ts:18-31
Timestamp: 2025-06-22T10:40:52.752Z
Learning: In apps/roam/src/utils/getAllDiscourseNodesSince.ts, the user confirmed that querying for `?title` with `:node/title` and mapping it to the `text` field in the DiscourseGraphContent type is the correct implementation for retrieving discourse node content from Roam Research, despite it appearing to query page titles rather than block text content.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#0
File: :0-0
Timestamp: 2025-07-13T16:47:14.352Z
Learning: In the discourse-graph codebase, types.gen.ts contains automatically generated database function type definitions that may have reordered signatures between versions. This reordering is expected behavior from the code generation process and should not be flagged as an issue requiring fixes.

apps/obsidian/src/components/NodeTypeSettings.tsx (4)

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `node.type` serves as the UID field rather than having a conventional `node.uid` field. This is an unusual naming convention where the type field actually contains the unique identifier.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `type` serves as the unique identifier field, not a type classification field. The interface has no `uid` or `id` field, making `node.type` the correct field to use for UID-related operations.

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to {apps/website,packages/ui}/**/*.tsx : Maintain visual consistency with the host application's design system

Learnt from: CR
PR: DiscourseGraphs/discourse-graph#0
File: .cursor/rules/main.mdc:0-0
Timestamp: 2025-06-30T18:58:32.668Z
Learning: Applies to **/*.{ts,tsx} : Maintain consistent naming conventions: PascalCase for components and types

apps/obsidian/src/utils/validateNodeType.ts (5)

Learnt from: sid597
PR: DiscourseGraphs/discourse-graph#232
File: apps/roam/src/utils/getAllDiscourseNodesSince.ts:15-16
Timestamp: 2025-06-22T10:40:21.679Z
Learning: In the getAllDiscourseNodesSince function in apps/roam/src/utils/getAllDiscourseNodesSince.ts, date validation is performed before the function is called, so additional date validation within the function is not needed.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `node.type` serves as the UID field rather than having a conventional `node.uid` field. This is an unusual naming convention where the type field actually contains the unique identifier.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#220
File: apps/roam/src/utils/conceptConversion.ts:42-56
Timestamp: 2025-06-17T23:37:45.289Z
Learning: In the DiscourseNode interface from apps/roam/src/utils/getDiscourseNodes.ts, the field `type` serves as the unique identifier field, not a type classification field. The interface has no `uid` or `id` field, making `node.type` the correct field to use for UID-related operations.

Learnt from: sid597
PR: DiscourseGraphs/discourse-graph#232
File: apps/roam/src/utils/getAllDiscourseNodesSince.ts:18-31
Timestamp: 2025-06-22T10:40:52.752Z
Learning: In apps/roam/src/utils/getAllDiscourseNodesSince.ts, the user confirmed that querying for `?title` with `:node/title` and mapping it to the `text` field in the DiscourseGraphContent type is the correct implementation for retrieving discourse node content from Roam Research, despite it appearing to query page titles rather than block text content.

Learnt from: maparent
PR: DiscourseGraphs/discourse-graph#0
File: :0-0
Timestamp: 2025-07-13T16:47:14.352Z
Learning: In the discourse-graph codebase, types.gen.ts contains automatically generated database function type definitions that may have reordered signatures between versions. This reordering is expected behavior from the code generation process and should not be flagged as an issue requiring fixes.

🧬 Code Graph Analysis (1)

apps/obsidian/src/utils/validateNodeType.ts (1)

apps/obsidian/src/types.ts (1)

• DiscourseNode (3-11)

🔇 Additional comments (11)

apps/obsidian/src/types.ts (1)

8-8: LGTM! Clean addition of optional description field.

The optional description field is correctly typed and follows TypeScript conventions. The optional nature ensures backward compatibility with existing code.

apps/obsidian/src/utils/validateNodeType.ts (5)

8-16: LGTM! Improved function signature for better validation.

The refactored function signature using a single object parameter improves readability and makes the validation logic clearer.

---

43-50: Excellent fix for uniqueness validation.

The updated logic correctly excludes the current node from uniqueness checks, preventing false positives when editing existing nodes. This is a significant improvement over the previous implementation.

---

68-76: Consistent refactoring maintains code quality.

The validateNodeName function follows the same improved pattern as validateNodeFormat, ensuring consistency across the validation utilities.

---

81-82: Proper implementation of duplicate detection.

The logic correctly filters out the current node and uses some() for efficient duplicate detection, which is more performant than the previous approach.

---

103-118: Validation calls updated correctly.

The calls to both validation functions have been properly updated to use the new object parameter format, maintaining consistency with the refactored function signatures.

apps/obsidian/src/components/NodeTypeSettings.tsx (5)

34-38: Validation call updated correctly.

The validateNodeName call has been properly updated to use the new object parameter format, maintaining consistency with the refactored validation functions.

---

49-53: Validation call updated correctly.

The validateNodeFormat call has been properly updated to use the new object parameter format, ensuring consistency across the validation system.

---

56-63: Well-configured description field.

The description field configuration is properly set up with appropriate label, description, and placeholder text. The optional nature aligns with the type definition.

---

361-361: Good React practice with key prop.

Adding the key prop to the FieldWrapper component ensures stable React keys and prevents potential rendering issues.

---

390-427: Improved UI layout with description support.

The updated layout uses proper flex containers and spacing, and the conditional rendering of the description with appropriate styling (text-muted text-sm) enhances the user experience.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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? Create a ticket on our support page 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.

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.

[mdroidian]

👍
Small nit, then can merge.