refactor: ♻️ 重构 core 模块

Author: hymbz

.oxlintrc.json

@@ -156,7 +156,7 @@
                   "../**/*",
                   "!.*/**/*"
                 ],
-                "message": "只能通过 main 导入"
+                "message": "只能通过 core 导入"
               }
             ]
           }

eslint.config.mjs

@@ -83,6 +83,8 @@ export default antfu(
       'prefer-promise-reject-errors': 'off',
 
       'no-debugger': 'warn',
+
+      'prefer-const': 'off',
     },
   },
   i18next.configs['flat/recommended'],
@@ -109,11 +111,6 @@ export default antfu(
   },
   prettierConflicts,
   ...oxlint.buildFromOxlintConfigFile('./.oxlintrc.json'),
-)
-  .disableRulesFix(['prefer-const'], {
-    builtinRules: () =>
-      import('eslint/use-at-your-own-risk').then((r) => r.builtinRules),
-  })
   // 一些规则即使在上面 false 了，实际也还是会启用，需要在这里禁用
   // oxc 有的全部禁用交给 oxc
-  .removePlugins('node', 'jsdoc', 'vue', 'test', 'import', 'ts', 'unicorn');
+).removePlugins('node', 'jsdoc', 'vue', 'test', 'import', 'ts', 'unicorn');

rollup.config.ts

@@ -79,7 +79,7 @@ const packlist = [
   'components/Toast',
   'userscript/copyApi',
   'userscript/detectAd',
-  'userscript/main',
+  'userscript/core',
   'worker/detectAd',
   'worker/ImageRecognition',
   'worker/ImageUpscale',
@@ -102,7 +102,7 @@ const baseOptions = {
   external: [
     ...Object.keys(meta.resource ?? {}),
     ...packlist,
-    'main',
+    'core',
     /^solid/,
   ],
   input: '',
@@ -248,8 +248,8 @@ const optionList: RollupOptions[] = [
             /\s+\/\/ import list/,
             packlist
               .map((path) => {
-                if (path === 'userscript/main')
-                  return `\ncase 'main':\ncode = \`inject('${path}')\`;\nbreak;`;
+                if (path === 'userscript/core')
+                  return `\ncase 'core':\ncode = \`inject('${path}')\`;\nbreak;`;
                 return `\ncase '${path}':\ncode = \`inject('${path}')\`;\nbreak;`;
               })
               .join(''),

src/components/Manga/store/prop.ts

@@ -1,3 +1,5 @@
+import type { Promisable } from 'type-fest';
+
 import type { ToolbarButtonList } from '../defaultButtonList';
 import type { SettingList } from '../defaultSettingList';
 import type { ComicImg } from './image';
@@ -13,25 +15,25 @@ type PropState = {
     /** 点击结束页按钮时触发的回调 */
     onExit?: (isEnd?: boolean) => void;
     /** 点击上一话按钮时触发的回调 */
-    onPrev?: () => void | Promise<void>;
+    onPrev?: () => Promisable<void>;
     /** 点击下一话按钮时触发的回调 */
-    onNext?: () => void | Promise<void>;
+    onNext?: () => Promisable<void>;
 
     /** 图片加载状态发生变化时触发的回调 */
-    onLoading?: (imgList: ComicImg[], img?: ComicImg) => void | Promise<void>;
+    onLoading?: (imgList: ComicImg[], img?: ComicImg) => Promisable<void>;
     /** 图片加载失败时触发的回调 */
-    onImgError?: (url: string) => void | Promise<void>;
+    onImgError?: (url: string) => Promisable<void>;
     /** 配置发生变化时触发的回调 */
-    onOptionChange?: (option: Partial<Option>) => void | Promise<void>;
+    onOptionChange?: (option: Partial<Option>) => Promisable<void>;
     /** 快捷键配置发生变化时触发的回调 */
     onHotkeysChange?: (
       hotkeys: Record<string, string[]>,
-    ) => void | Promise<void>;
+    ) => Promisable<void>;
     /** 显示图片发生变化时触发的回调 */
     onShowImgsChange?: (
       showImgs: Set<number>,
       imgList: ComicImg[],
-    ) => void | Promise<void>;
+    ) => Promisable<void>;
     /** 每次加载范围改变后触发的回调，返回加载范围中等待 url 的图片的 index */
     onWaitUrlImgs?: (indexs: Set<number>, imgList: ComicImg[]) => void;
 

src/helper/other.ts

@@ -1,4 +1,5 @@
 import type { ScheduleCallback } from '@solid-primitives/scheduled';
+import type { Promisable } from 'type-fest';
 
 import {
   debounce as _debounce,
@@ -189,7 +190,7 @@ export const singleThreaded = <T extends any[]>(
   callback: (
     state: SingleThreadedState<T>,
     ...args: T
-  ) => void | undefined | Promise<void | undefined>,
+  ) => Promisable<void | undefined>,
   initState?: Partial<SingleThreadedState<T>>,
 ) => {
   const state: SingleThreadedState<T> = {
@@ -231,7 +232,7 @@ export const singleThreaded = <T extends any[]>(
  * @returns 所有 Promise 的返回值
  */
 export const plimit = async <T>(
-  fnList: (() => Promise<T> | T)[],
+  fnList: (() => Promisable<T>)[],
   callBack = undefined as
     | ((doneNum: number, totalNum: number, resList: T[], i: number) => void)
     | undefined,
@@ -337,16 +338,16 @@ export const needDarkMode = (hexColor: string) => {
  * @param waitTime - 轮询间隔时间（毫秒），默认为 100
  */
 export async function wait<T>(
-  fn: () => T | undefined | Promise<T | undefined>,
+  fn: () => Promisable<T | undefined>,
 ): Promise<TrueValue<T>>;
 export async function wait<T>(
-  fn: () => T | undefined | Promise<T | undefined>,
+  fn: () => Promisable<T>,
   timeout?: number,
   waitTime?: number,
 ): Promise<T>;
 // oxlint-disable-next-line func-style
 export async function wait<T>(
-  fn: () => T | undefined | Promise<T | undefined>,
+  fn: () => Promisable<T>,
   timeout = Number.POSITIVE_INFINITY,
   waitTime = 100,
 ) {
@@ -583,7 +584,7 @@ export const hijackFn = <T extends unknown[] = unknown[], R = unknown>(
 
 export const getGmValue = async <T extends string | number | object = string>(
   name: string,
-  setValueFn: () => unknown | Promise<unknown>,
+  setValueFn: () => Promisable<unknown>,
 ) => {
   const value = await GM.getValue<T>(name);
   if (value !== undefined) return value;

src/helper/solidJs.ts

@@ -14,8 +14,8 @@ import {
 
 import { createScheduled, isEqual, throttle } from './other';
 
-export { ReactiveSet } from '@solid-primitives/set';
 export { ReactiveMap } from '@solid-primitives/map';
+export { ReactiveSet } from '@solid-primitives/set';
 
 let publicOwner: Owner;
 createRoot(() => {

src/helper/useCache.ts

@@ -1,3 +1,5 @@
+import type { Promisable } from 'type-fest';
+
 export type UseStore = <T>(
   txMode: IDBTransactionMode,
   callback: (store: IDBObjectStore) => T | PromiseLike<T>,
@@ -75,7 +77,7 @@ export const useCache = async <Schema extends Record<string, unknown>>(
       callback: (
         value: Schema[K],
         cursor: IDBCursorWithValue,
-      ) => void | Promise<void>,
+      ) => Promisable<void>,
     ) {
       const request = db
         .transaction(storeName, 'readwrite')

src/index.ts

@@ -1,9 +1,9 @@
 import { listenHotkey, type MangaProps } from 'components/Manga';
+import { request, setup, type SetupOptions, toast } from 'core';
 import {
   fileType,
   isUrl,
   log,
-  plimit,
   querySelector,
   querySelectorAll,
   querySelectorClick,
@@ -14,10 +14,8 @@ import {
   t,
   useStyle,
   wait,
-  waitDom,
 } from 'helper';
 import { getInitLang } from 'helper/languages';
-import { request, toast, setup, type SetupOptions } from 'main';
 import { getImglistByHtml } from 'userscript/copyApi';
 import { otherSite } from 'userscript/otherSite';
 
@@ -173,7 +171,7 @@ try {
               : comicData.chapters.find((chapter) =>
                   chapter.data.find((data) => data.chapter_id === chapterId),
                 )!
-          ).data.sort((a, b) => a.chapter_order - b.chapter_order);
+          ).data.toSorted((a, b) => a.chapter_order - b.chapter_order);
           const chapterIndex = chapter.findIndex(
             ({ chapter_id }) => chapter_id === chapterId,
           );
@@ -465,7 +463,8 @@ try {
 
       // by: https://sleazyfork.org/zh-CN/scripts/374903-comicread/discussions/241035
       const getImgList = () =>
-        [...(unsafeWindow.xx as string).matchAll(/(?<= s=").+?(?=")/g)].map(
+        Array.from(
+          (unsafeWindow.xx as string).matchAll(/(?<= s=").+?(?=")/g),
           ([text]) => decodeURIComponent(text),
         );
 
@@ -845,7 +844,7 @@ try {
       setup({
         name: 'mangadex',
         isMangaPage: () => {
-          const match = /^\/chapter\/([^\/]+)/.exec(location.pathname);
+          const match = /^\/chapter\/([^/]+)/.exec(location.pathname);
           if (match) return { id: match[1] };
         },
         async getImgList() {

src/pwa/src/DownloadButton.tsx

@@ -5,7 +5,7 @@ import { createSignal } from 'solid-js';
 
 import { toast } from 'components/Toast';
 import { boolDataVal, isUrl, t, wait } from 'helper';
-import { request } from 'userscript/main';
+import { request } from 'userscript/core';
 
 import { loadNewImglist } from './store';
 

src/pwa/src/fileParser/index.ts

@@ -1,3 +1,5 @@
+import type { Promisable } from 'type-fest';
+
 import type { ImgFile } from '../store';
 
 import { isSupportFile } from './helper';
@@ -6,7 +8,7 @@ import { unzip } from './unzip';
 
 export * from './helper';
 
-export const getImgData = (file: File): Promise<ImgFile[]> | ImgFile[] => {
+export const getImgData = (file: File): Promisable<ImgFile[]> => {
   const fileType = isSupportFile(file.name);
   switch (fileType) {
     case null: