refactor(setting): 重命名排除歌词和评论相关字段

起码好点了 不是吗.jpg

Author: MoYingJi

src/components/Modal/Setting/ExcludeLyrics.vue

@@ -115,8 +115,8 @@ const emit = defineEmits(["close"]);
 const settingStore = useSettingStore();
 
 const enableExcludeLyrics = ref(settingStore.enableExcludeLyrics);
-const enableExcludeTTML = ref(settingStore.enableExcludeTTML);
-const enableExcludeLocalLyrics = ref(settingStore.enableExcludeLocalLyrics);
+const enableExcludeTTML = ref(settingStore.enableExcludeLyricsTTML);
+const enableExcludeLocalLyrics = ref(settingStore.enableExcludeLyricsLocal);
 
 const filterKeywords = ref<string[]>([]);
 const filterRegexes = ref<string[]>([]);
@@ -141,8 +141,8 @@ const clearAll = () => {
 // 导出规则
 const exportFilters = () => {
   const data = {
-    keywords: settingStore.excludeUserKeywords || [],
-    regexes: settingStore.excludeUserRegexes || [],
+    keywords: settingStore.excludeLyricsUserKeywords || [],
+    regexes: settingStore.excludeLyricsUserRegexes || [],
   };
   const blob = new Blob([JSON.stringify(data, null, 2)], { type: "application/json" });
   const url = URL.createObjectURL(blob);
@@ -185,10 +185,10 @@ const importFilters = () => {
 // 保存过滤
 const saveFilter = () => {
   settingStore.enableExcludeLyrics = enableExcludeLyrics.value;
-  settingStore.enableExcludeTTML = enableExcludeTTML.value;
-  settingStore.enableExcludeLocalLyrics = enableExcludeLocalLyrics.value;
-  settingStore.excludeUserKeywords = filterKeywords.value;
-  settingStore.excludeUserRegexes = filterRegexes.value;
+  settingStore.enableExcludeLyricsTTML = enableExcludeTTML.value;
+  settingStore.enableExcludeLyricsLocal = enableExcludeLocalLyrics.value;
+  settingStore.excludeLyricsUserKeywords = filterKeywords.value;
+  settingStore.excludeLyricsUserRegexes = filterRegexes.value;
   window.$message.success("设置已保存");
   handleClose();
 };
@@ -199,10 +199,10 @@ const handleClose = () => {
 
 onMounted(() => {
   enableExcludeLyrics.value = settingStore.enableExcludeLyrics;
-  enableExcludeTTML.value = settingStore.enableExcludeTTML;
-  enableExcludeLocalLyrics.value = settingStore.enableExcludeLocalLyrics;
-  filterKeywords.value = [...(settingStore.excludeUserKeywords || [])];
-  filterRegexes.value = [...(settingStore.excludeUserRegexes || [])];
+  enableExcludeTTML.value = settingStore.enableExcludeLyricsTTML;
+  enableExcludeLocalLyrics.value = settingStore.enableExcludeLyricsLocal;
+  filterKeywords.value = [...(settingStore.excludeLyricsUserKeywords || [])];
+  filterRegexes.value = [...(settingStore.excludeLyricsUserRegexes || [])];
 });
 </script>
 

src/core/player/LyricManager.ts

@@ -583,13 +583,14 @@ class LyricManager {
     const statusStore = useStatusStore();
     const musicStore = useMusicStore();
 
-    const { enableExcludeLyrics, excludeUserKeywords, excludeUserRegexes } = settingStore;
+    const { enableExcludeLyrics, excludeLyricsUserKeywords, excludeLyricsUserRegexes } =
+      settingStore;
 
     if (!enableExcludeLyrics) return lyricData;
 
     // 合并默认规则和用户自定义规则
-    const mergedKeywords = [...new Set([...defaultKeywords, ...(excludeUserKeywords ?? [])])];
-    const mergedRegexes = [...new Set([...defaultRegexes, ...(excludeUserRegexes ?? [])])];
+    const mergedKeywords = [...new Set([...defaultKeywords, ...(excludeLyricsUserKeywords ?? [])])];
+    const mergedRegexes = [...new Set([...defaultRegexes, ...(excludeLyricsUserRegexes ?? [])])];
 
     const { name, artists } = musicStore.playSong;
     const songMetadataRegexes: string[] = [];
@@ -622,7 +623,7 @@ class LyricManager {
     const lrcData = stripLyricMetadata(lyricData.lrcData || [], options);
     let yrcData = lyricData.yrcData || [];
 
-    if (!statusStore.usingTTMLLyric || settingStore.enableExcludeTTML) {
+    if (!statusStore.usingTTMLLyric || settingStore.enableExcludeLyricsTTML) {
       yrcData = stripLyricMetadata(yrcData, options);
     }
 
@@ -836,14 +837,14 @@ class LyricManager {
         // 进行本地歌词对齐
         lyricData = this.alignLocalLyrics(lyricData);
         // 排除本地歌词内容
-        if (settingStore.enableExcludeLocalLyrics) {
+        if (settingStore.enableExcludeLyricsLocal) {
           lyricData = this.handleLyricExclude(lyricData);
         }
         lyricData = await this.applyChineseVariant(lyricData);
       } else if (song.path) {
         lyricData = await this.handleLocalLyric(song.path);
         // 排除本地歌词内容
-        if (settingStore.enableExcludeLocalLyrics) {
+        if (settingStore.enableExcludeLyricsLocal) {
           lyricData = this.handleLyricExclude(lyricData);
         }
       } else {

src/stores/migrations/settingMigrations.ts

@@ -6,7 +6,7 @@ import type { SettingState } from "../setting";
 /**
  * 当前设置 Schema 版本号
  */
-export const CURRENT_SETTING_SCHEMA_VERSION = 7;
+export const CURRENT_SETTING_SCHEMA_VERSION = 8;
 
 /**
  * 迁移函数类型
@@ -73,9 +73,10 @@ export const settingMigrations: Record<number, MigrationFunction> = {
     }
 
     return {
+      // 这些字段在 Schema Version 8 时被重命名，导致类型检查报错
       excludeUserKeywords: userKeywords,
       excludeUserRegexes: userRegexes,
-    };
+    } as Partial<SettingState>;
   },
   6: (state) => {
     interface OldSettingState extends Partial<SettingState> {
@@ -149,4 +150,21 @@ export const settingMigrations: Record<number, MigrationFunction> = {
 
     return {};
   },
+  8: (state) => {
+    interface OldSettingState extends Partial<SettingState> {
+      enableExcludeTTML?: boolean;
+      enableExcludeLocalLyrics?: boolean;
+      excludeUserKeywords?: string[];
+      excludeUserRegexes?: string[];
+    }
+
+    const oldState = state as OldSettingState;
+
+    return {
+      enableExcludeLyricsTTML: oldState.enableExcludeTTML,
+      enableExcludeLyricsLocal: oldState.enableExcludeLocalLyrics,
+      excludeLyricsUserKeywords: oldState.excludeUserKeywords,
+      excludeLyricsUserRegexes: oldState.excludeUserRegexes,
+    };
+  },
 };

src/stores/setting.ts

@@ -229,18 +229,18 @@ export interface SettingState {
   dynamicCover: boolean;
   /** 是否使用 keep-alive */
   useKeepAlive: boolean;
-  /** 是否启用评论排除 */
-  enableExcludeComments: boolean;
   /** 是否启用排除歌词 */
   enableExcludeLyrics: boolean;
   /** 「排除歌词」是否适用于 TTML */
-  enableExcludeTTML: boolean;
+  enableExcludeLyricsTTML: boolean;
   /** 「排除歌词」是否适用于本地歌词 */
-  enableExcludeLocalLyrics: boolean;
+  enableExcludeLyricsLocal: boolean;
   /** 用户自定义的排除歌词关键字 */
-  excludeUserKeywords: string[];
+  excludeLyricsUserKeywords: string[];
   /** 用户自定义的排除歌词正则表达式 */
-  excludeUserRegexes: string[];
+  excludeLyricsUserRegexes: string[];
+  /** 是否启用评论排除 */
+  enableExcludeComments: boolean;
   /** 排除评论关键词 */
   excludeCommentKeywords: string[];
   /** 排除评论正则表达式 */
@@ -431,12 +431,12 @@ export const useSettingStore = defineStore("setting", {
     lyricHorizontalOffset: 10,
     lyricAlignRight: false,
     hideLyricBrackets: false,
-    enableExcludeComments: false,
     enableExcludeLyrics: true,
-    enableExcludeTTML: false,
-    enableExcludeLocalLyrics: false,
-    excludeUserKeywords: [],
-    excludeUserRegexes: [],
+    enableExcludeLyricsTTML: false,
+    enableExcludeLyricsLocal: false,
+    excludeLyricsUserKeywords: [],
+    excludeLyricsUserRegexes: [],
+    enableExcludeComments: false,
     excludeCommentKeywords: [],
     excludeCommentRegexes: [],
     localFilesPath: [],