feat: Improve AI functionality by chenxi-20 · Pull Request #297 · opentiny/tiny-editor

chenxi-20 · 2025-07-31T02:23:30Z

PR

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our Commit Message Guidelines
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

Yes
No

Other information

Summary by CodeRabbit

New Features
- Enhanced AI editing interface with new menus, tooltips, and interactive UI elements.
- Added configurable text length limit for AI-generated content.
- Introduced a selection bubble for quick AI actions on selected text.
- Added new icons and menu options for AI operations.
Style
- Comprehensive redesign and improvement of AI-related UI components with new animations, hover effects, and structured layouts.
- Updated icon styles and added a speech bubble to the AI icon.
Documentation
- Updated interface documentation to include new configuration options and default values.
Refactor
- Modularized and reorganized AI module code for better maintainability and clarity.
Chores
- Added new constants and TypeScript interfaces for AI menu items and configuration.

coderabbitai · 2025-07-31T02:23:39Z

Walkthrough

This update introduces a comprehensive overhaul of the AI module in the Fluent Editor, adding new UI elements, constants, icons, and TypeScript types. It refactors the AI integration for improved modularity, richer user interactions, and enhanced styling. Documentation and demo files are updated to reflect new configuration options and interface changes.

Changes

Cohort / File(s)	Change Summary
AI Module Refactor & Feature Expansion `packages/fluent-editor/src/modules/ai/index.ts`	Major refactor: modularizes AI UI, adds selection bubble, operation/result menus, streaming, new state variables, event handling, and richer user interactions. Updates constructor, methods, and UI logic.
AI Module Constants & Menus `packages/fluent-editor/src/modules/ai/constants.ts`	Adds exported string constants for UI text, menu data for editor/tone/adjust categories, and menu ID mapping for AI features.
AI Module SVG Icons `packages/fluent-editor/src/modules/ai/icons.ts`	Adds exported SVG icon constants for all AI UI elements and actions.
AI Module TypeScript Types `packages/fluent-editor/src/modules/ai/types.ts`	Adds interfaces for AI options, operation/result menu items, and config typing.
AI Demo & Documentation `packages/docs/fluent-editor/demos/ai.vue`, `packages/docs/fluent-editor/docs/demo/ai.md`	Demo: Updates toolbar config, adds `contentMaxLength` to AI config, and revises template content. Docs: Adds comments for AI options and documents new `contentMaxLength` property.
AI UI Styling `packages/fluent-editor/src/assets/ai.scss`	Major style overhaul: new containers, tooltips, hover effects, flex layouts, animations, and menu/result panel styling for AI UI.
Toolbar & Common Styling `packages/fluent-editor/src/assets/common.scss`, `packages/fluent-editor/src/assets/toolbar.scss`	Common: Excludes `.ql-ai-icon` from toolbar SVG color mixin. Toolbar: Adds `rotate` keyframes animation.
AI Icon UI Wrapper `packages/fluent-editor/src/ui/icons.config.ts`	Changes `AI_ICON` export from SVG-only to a div-wrapped HTML structure with tooltip bubble, text, and decorative SVGs.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Editor
    participant AI_Module
    participant AI_API

    User->>Editor: Selects text or clicks AI icon
    Editor->>AI_Module: Triggers AI input panel
    AI_Module->>User: Shows input box, menus, selection bubble
    User->>AI_Module: Enters prompt / selects menu / clicks send
    AI_Module->>AI_API: Sends prompt (with streaming)
    AI_API-->>AI_Module: Streams response chunks
    AI_Module->>Editor: Updates result popup live
    User->>AI_Module: Clicks insert/replace/copy/regenerate
    AI_Module->>Editor: Performs action (insert/replace/copy)
    User->>AI_Module: Closes panel or continues interaction

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~40 minutes

Poem

A rabbit hops through code anew,
With menus bright and icons too,
AI now sparkles, sleek and spry,
Tooltips and bubbles catch the eye.
Types and constants join the dance,
Styling gives the UI a chance—
Let’s nibble through this change, advanced! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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.
- 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 docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for 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.

coderabbitai

Actionable comments posted: 10

🔭 Outside diff range comments (3)

packages/fluent-editor/src/modules/ai/icons.ts (1)
1-334: Fix formatting violations: Replace tab characters with spaces.

The file contains extensive tab character violations that are causing linting failures. All tab characters must be replaced with spaces to comply with the project's ESLint configuration.

Apply this fix to replace all tab characters with spaces:
# Use sed to replace all tabs with spaces (assuming 2-space indentation)
sed -i 's/\t/  /g' packages/fluent-editor/src/modules/ai/icons.ts
Alternatively, configure your editor to use spaces instead of tabs and reformat the file.

The SVG icon definitions themselves look comprehensive and well-structured for the AI functionality.
packages/fluent-editor/src/modules/ai/index.ts (2)
679-683: Improve error handling with user feedback

The current error handling only logs to console without informing users or resetting the UI state.

Enhance error handling:
   } catch (error) {
     console.error('AI查询失败:', error)
-    return 'AI查询失败，请重试'
+    this.isThinking = false
+    this.showResultPopupEl = false
+    
+    // Show user-friendly error message
+    const errorMessage = error.message.includes('401') 
+      ? 'API密钥无效，请检查配置'
+      : error.message.includes('network')
+      ? '网络连接失败，请检查网络'
+      : 'AI查询失败，请重试'
+    
+    this.showAlert(errorMessage)
+    return ''
   }
38-807: Consider splitting the AI class into smaller, focused modules

The AI class has grown to 800+ lines handling multiple responsibilities, making it difficult to maintain and test.

Consider refactoring into separate modules:
// ai/AIService.ts - Handle API communication
export class AIService {
  async query(prompt: string, options: AIOptions): Promise<string> { }
}

// ai/AIUIBuilder.ts - Handle UI creation
export class AIUIBuilder {
  createInputPanel(): HTMLElement { }
  createResultPanel(): HTMLElement { }
  createMenus(): HTMLElement { }
}

// ai/AIStateManager.ts - Handle state
export class AIStateManager {
  private state = {
    isThinking: false,
    showResults: false,
    // etc
  }
}

// ai/AI.ts - Orchestrate the modules
export class AI {
  constructor(
    private service: AIService,
    private uiBuilder: AIUIBuilder,
    private stateManager: AIStateManager
  ) {}
}
This separation would improve testability and maintainability.

🧹 Nitpick comments (4)

packages/docs/fluent-editor/demos/ai.vue (1)

10-10: Fix missing trailing commas for consistency.

Add trailing commas to maintain consistent code style and comply with ESLint rules.

Apply these fixes:
-  ['clean']
+  ['clean'],
-          container: TOOLBAR_CONFIG
+          container: TOOLBAR_CONFIG,
-          contentMaxLength: 1000
-        }
-      }
+          contentMaxLength: 1000,
+        },
+      },
Also applies to: 22-22, 28-30

packages/fluent-editor/src/modules/ai/types.ts (2)

1-18: Fix style issues: semicolons and EOF newline

The file has inconsistent delimiter style and is missing a newline at the end.

Apply this diff to match the project's style guide:

 export interface OperationMenuItem {
-  id: string;
-  text: string;
-  icon?: string;
+  id: string
+  text: string
+  icon?: string
 }

 export interface ResultMenuItem {
-  text: string;
-  icon: string;
-  selectText?: string;
+  text: string
+  icon: string
+  selectText?: string
 }

 export interface AIOptions {
-  host?: string;
-  apiKey: string;
-  model?: string;
-  contentMaxLength?: number;
-}
+  host?: string
+  apiKey: string
+  model?: string
+  contentMaxLength?: number
+}
+

7-11: Consider adding JSDoc comments for unclear fields

The selectText field's purpose is not immediately clear from its name.

Consider adding documentation:

 export interface ResultMenuItem {
   text: string
   icon: string
+  /** Alternative text to display when in selection mode */
   selectText?: string
 }

packages/fluent-editor/src/modules/ai/index.ts (1)

3-36: Clean up imports and fix ordering

There are unused imports and ordering issues.

Fix the imports:

 import type TypeToolbar from 'quill/modules/toolbar'
 import type FluentEditor from '../../core/fluent-editor'
+import type { AIOptions, OperationMenuItem, ResultMenuItem } from './types'
+import {
+  CLOSE,
+  INPUT_PLACEHOLDER,
+  INSERT_SUB_CONTENT_TEXT,
+  INSERT_TEXT,
+  MENU_ID_MAP,
+  MENU_TITLE_DATA,
+  REGENERATE,
+  REPLACE_SELECT,
+  RESULT_HEADER_TEXT,
+  SELECT_PLACEHOLDER,
+  STOP_ANSWER,
+  THINK_TEXT,
+} from './constants'
 import {
   ADJUST_ICON,
   AI_ICON,
   CALL_ICON,
   CLOSE_ICON,
   COPY_ICON,
   EDITOR_ICON,
   INSERT_ICON,
   MENU_CLOSE_ICON,
   REBUILD_ICON,
   REFRESH_ICON,
   REPLACE_SELECT_ICON,
   RIGHT_ARROW_ICON,
   SEND_BTN_ICON,
   STOP_ICON,
   THINK_ICON,
-  SHARE_ICON,
-  VOICE_ICON
 } from './icons'
-import {
-  INPUT_PLACEHOLDER,
-  // ... rest of constants
-} from './constants'
-import type { ResultMenuItem, OperationMenuItem, AIOptions } from './types'

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 53fb899 and 11775ef.

📒 Files selected for processing (10)

packages/docs/fluent-editor/demos/ai.vue (2 hunks)
packages/docs/fluent-editor/docs/demo/ai.md (1 hunks)
packages/fluent-editor/src/assets/ai.scss (4 hunks)
packages/fluent-editor/src/assets/common.scss (1 hunks)
packages/fluent-editor/src/assets/toolbar.scss (1 hunks)
packages/fluent-editor/src/modules/ai/constants.ts (1 hunks)
packages/fluent-editor/src/modules/ai/icons.ts (1 hunks)
packages/fluent-editor/src/modules/ai/index.ts (4 hunks)
packages/fluent-editor/src/modules/ai/types.ts (1 hunks)
packages/fluent-editor/src/ui/icons.config.ts (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (3)

packages/fluent-editor/src/modules/ai/constants.ts (1)

packages/fluent-editor/src/modules/ai/icons.ts (4)

RICH_CONTENT_ICON (247-255)

STREAMLINE_CONTENT_ICON (258-264)

SYMBOL_ICON (267-273)

TRANSLATE_ICON (276-319)

packages/fluent-editor/src/ui/icons.config.ts (1)

packages/fluent-editor/src/modules/ai/icons.ts (1)

AI_ICON (321-333)

packages/fluent-editor/src/modules/ai/icons.ts (1)

packages/fluent-editor/src/ui/icons.config.ts (1)

AI_ICON (318-361)

🪛 ESLint

packages/docs/fluent-editor/demos/ai.vue

[error] 10-11: Missing trailing comma.

(style/comma-dangle)

[error] 10-11: Missing trailing comma.

(comma-dangle)

[error] 22-23: Missing trailing comma.

(style/comma-dangle)

[error] 22-23: Missing trailing comma.

(comma-dangle)

[error] 28-29: Missing trailing comma.

(style/comma-dangle)

[error] 28-29: Missing trailing comma.

(comma-dangle)

[error] 29-30: Missing trailing comma.

(style/comma-dangle)

[error] 29-30: Missing trailing comma.

(comma-dangle)

[error] 30-31: Missing trailing comma.

(style/comma-dangle)

[error] 30-31: Missing trailing comma.

(comma-dangle)

packages/fluent-editor/src/modules/ai/constants.ts

[error] 1-2: Too many blank lines at the beginning of file. Max of 0 allowed.

(style/no-multiple-empty-lines)

[error] 3-3: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 4-4: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 5-5: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 6-6: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 7-7: Expected indentation of 0 spaces but found 2.

(style/indent)

[error] 9-9: Extra semicolon.

(style/semi)

[error] 10-10: Extra semicolon.

(style/semi)

[error] 11-11: Extra semicolon.

(style/semi)

[error] 12-12: Extra semicolon.

(style/semi)

[error] 13-13: Extra semicolon.

(style/semi)

[error] 14-14: Extra semicolon.

(style/semi)

[error] 15-15: Extra semicolon.

(style/semi)

[error] 16-16: Extra semicolon.

(style/semi)

[error] 17-17: Extra semicolon.

(style/semi)

[error] 18-18: Extra semicolon.

(style/semi)

[error] 21-21: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 22-22: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 23-23: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 24-24: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 25-25: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 26-26: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 27-27: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 28-28: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 29-29: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 30-30: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 31-31: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 32-32: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 33-33: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 34-34: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 35-35: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 36-36: Expected indentation of 4 spaces but found 6.

(style/indent)

[error] 37-37: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 37-38: Missing trailing comma.

(style/comma-dangle)

[error] 37-38: Missing trailing comma.

(comma-dangle)

[error] 38-38: Extra semicolon.

(style/semi)

[error] 41-41: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 42-42: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 43-43: Expected indentation of 2 spaces but found 4.

(style/indent)

[error] 44-44: Extra semicolon.

(style/semi)

[error] 44-44: Newline required at end of file but not found.

(style/eol-last)

[error] 44-44: Newline required at end of file but not found.

(eol-last)

packages/fluent-editor/src/modules/ai/types.ts

[error] 2-2: Unexpected separator (;).