Browse Source

♻️ refactor(helpers): standardize file naming conventions and improve code organization

- Rename files to follow camelCase naming convention:
  • auth-header.js → authUtils.js
  • other.js → logUtils.js
  • rehypeSplitWordsIntoSpans.js → textAnimationUtils.js

- Update import paths in affected components:
  • Update exports in helpers/index.js
  • Fix import in LogsTable.js for logUtils
  • Fix import in MarkdownRenderer.js for textAnimationUtils

- Remove old files after successful migration

- Improve file naming clarity:
  • authUtils.js better describes authentication utilities
  • logUtils.js clearly indicates log processing functions
  • textAnimationUtils.js concisely describes text animation functionality

This refactoring enhances code maintainability and follows consistent naming patterns throughout the helpers directory.
Apple\Apple 7 months ago
parent
commit
a7535aab99

+ 1 - 1
web/src/components/LogsTable.js

@@ -44,7 +44,7 @@ import {
   stringToColor,
 } from '../helpers/render';
 import Paragraph from '@douyinfe/semi-ui/lib/es/typography/paragraph';
-import { getLogOther } from '../helpers/other.js';
+import { getLogOther } from '../helpers/logUtils.js';
 import {
   IconRefresh,
   IconSetting,

+ 2 - 2
web/src/components/common/markdown/MarkdownRenderer.js

@@ -1,6 +1,6 @@
 import ReactMarkdown from 'react-markdown';
 import 'katex/dist/katex.min.css';
-import 'highlight.js/styles/default.css';
+import 'highlight.js/styles/github.css';
 import './markdown.css';
 import RemarkMath from 'remark-math';
 import RemarkBreaks from 'remark-breaks';
@@ -16,7 +16,7 @@ import { Button, Tooltip, Toast } from '@douyinfe/semi-ui';
 import { copy } from '../../../helpers/utils';
 import { IconCopy } from '@douyinfe/semi-icons';
 import { useTranslation } from 'react-i18next';
-import { rehypeSplitWordsIntoSpans } from '../../../utils/rehypeSplitWordsIntoSpans';
+import { rehypeSplitWordsIntoSpans } from '../../../helpers/textAnimationUtils';
 
 mermaid.initialize({
   startOnLoad: false,

+ 1 - 1
web/src/components/playground/configStorage.js

@@ -1,4 +1,4 @@
-import { STORAGE_KEYS, DEFAULT_CONFIG } from '../../utils/constants';
+import { STORAGE_KEYS, DEFAULT_CONFIG } from '../../constants/playground.constants';
 
 const MESSAGES_STORAGE_KEY = 'playground_messages';
 

+ 1 - 0
web/src/constants/index.js

@@ -3,3 +3,4 @@ export * from './user.constants';
 export * from './toast.constants';
 export * from './common.constant';
 export * from './model.constants';
+export * from './playground.constants';

+ 0 - 0
web/src/utils/constants.js → web/src/constants/playground.constants.js


+ 0 - 0
web/src/utils/apiUtils.js → web/src/helpers/apiUtils.js


+ 1 - 1
web/src/helpers/auth-header.js → web/src/helpers/authUtils.js

@@ -7,4 +7,4 @@ export function authHeader() {
   } else {
     return {};
   }
-}
+} 

+ 5 - 1
web/src/helpers/index.js

@@ -1,4 +1,8 @@
 export * from './history';
-export * from './auth-header';
+export * from './authUtils';
 export * from './utils';
 export * from './api';
+export * from './apiUtils';
+export * from './messageUtils';
+export * from './textAnimationUtils';
+export * from './logUtils';

+ 1 - 1
web/src/helpers/other.js → web/src/helpers/logUtils.js

@@ -4,4 +4,4 @@ export function getLogOther(otherStr) {
   }
   let other = JSON.parse(otherStr);
   return other;
-}
+} 

+ 1 - 1
web/src/utils/messageUtils.js → web/src/helpers/messageUtils.js

@@ -1,4 +1,4 @@
-import { THINK_TAG_REGEX, MESSAGE_ROLES } from './constants';
+import { THINK_TAG_REGEX, MESSAGE_ROLES } from '../constants/playground.constants';
 
 // 生成唯一ID
 let messageId = 4;

+ 0 - 0
web/src/utils/rehypeSplitWordsIntoSpans.js → web/src/helpers/textAnimationUtils.js


+ 3 - 3
web/src/hooks/useApiRequest.js

@@ -6,15 +6,15 @@ import {
   API_ENDPOINTS,
   MESSAGE_STATUS,
   DEBUG_TABS
-} from '../utils/constants';
+} from '../constants/playground.constants';
 import {
   buildApiPayload,
   handleApiError
-} from '../utils/apiUtils';
+} from '../helpers/apiUtils';
 import {
   processThinkTags,
   processIncompleteThinkTags
-} from '../utils/messageUtils';
+} from '../helpers/messageUtils';
 
 export const useApiRequest = (
   setMessage,

+ 3 - 3
web/src/hooks/useDataLoader.js

@@ -1,8 +1,8 @@
 import { useCallback, useEffect } from 'react';
 import { useTranslation } from 'react-i18next';
-import { API, showError } from '../helpers/index.js';
-import { API_ENDPOINTS } from '../utils/constants';
-import { processModelsData, processGroupsData } from '../utils/apiUtils';
+import { API } from '../helpers/api';
+import { API_ENDPOINTS } from '../constants/playground.constants';
+import { processModelsData, processGroupsData } from '../helpers/apiUtils';
 
 export const useDataLoader = (
   userState,

+ 2 - 2
web/src/hooks/useMessageActions.js

@@ -1,8 +1,8 @@
 import { useCallback } from 'react';
 import { Toast, Modal } from '@douyinfe/semi-ui';
 import { useTranslation } from 'react-i18next';
-import { getTextContent } from '../utils/messageUtils';
-import { ERROR_MESSAGES } from '../utils/constants';
+import { getTextContent } from '../helpers/messageUtils';
+import { ERROR_MESSAGES } from '../constants/playground.constants';
 
 export const useMessageActions = (message, setMessage, onMessageSend, saveMessages) => {
   const { t } = useTranslation();

+ 2 - 2
web/src/hooks/useMessageEdit.js

@@ -1,8 +1,8 @@
 import { useCallback, useState, useRef } from 'react';
 import { Toast, Modal } from '@douyinfe/semi-ui';
 import { useTranslation } from 'react-i18next';
-import { getTextContent, buildApiPayload, createLoadingAssistantMessage } from '../utils/messageUtils';
-import { MESSAGE_ROLES } from '../utils/constants';
+import { getTextContent, buildApiPayload, createLoadingAssistantMessage } from '../helpers/messageUtils';
+import { MESSAGE_ROLES } from '../constants/playground.constants';
 
 export const useMessageEdit = (
   setMessage,

+ 2 - 2
web/src/hooks/usePlaygroundState.js

@@ -1,7 +1,7 @@
 import { useState, useCallback, useRef, useEffect } from 'react';
-import { DEFAULT_MESSAGES, DEFAULT_CONFIG, DEBUG_TABS, MESSAGE_STATUS } from '../utils/constants';
+import { DEFAULT_MESSAGES, DEFAULT_CONFIG, DEBUG_TABS, MESSAGE_STATUS } from '../constants/playground.constants';
 import { loadConfig, saveConfig, loadMessages, saveMessages } from '../components/playground/configStorage';
-import { processIncompleteThinkTags } from '../utils/messageUtils';
+import { processIncompleteThinkTags } from '../helpers/messageUtils';
 
 export const usePlaygroundState = () => {
   // 使用惰性初始化,确保只在组件首次挂载时加载配置和消息

+ 1 - 1
web/src/hooks/useSyncMessageAndCustomBody.js

@@ -1,5 +1,5 @@
 import { useCallback, useRef } from 'react';
-import { MESSAGE_ROLES } from '../utils/constants';
+import { MESSAGE_ROLES } from '../constants/playground.constants';
 
 export const useSyncMessageAndCustomBody = (
   customRequestMode,

+ 2 - 2
web/src/pages/Playground/index.js

@@ -22,14 +22,14 @@ import {
   DEFAULT_MESSAGES,
   MESSAGE_ROLES,
   ERROR_MESSAGES
-} from '../../utils/constants.js';
+} from '../../constants/playground.constants.js';
 import {
   buildMessageContent,
   createMessage,
   createLoadingAssistantMessage,
   getTextContent,
   buildApiPayload
-} from '../../utils/messageUtils.js';
+} from '../../helpers/messageUtils.js';
 
 // Components
 import {