docs: update docs

hans000 · hans000 · commit ef02c907ec97 · 2024-01-14T19:33:41.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## v1.16.0
+- vite更新到5.0，antd更新到5.0
+- 添加禁用类型，可设置禁用 xhr 或 fetch
+- 添加插件拦截时机，可设置start end delay trigger override
+
 ## v1.15.0
 - 添加run at功能
 
diff --git a/public/_locales/en/messages.json b/public/_locales/en/messages.json
@@ -26,6 +26,9 @@
     "action_refresh": {
         "message": "Refresh Data"
     },
+    "action_all_frames": {
+        "message": "All frames"
+    },
     "action_theme": {
         "message": "Switch Theme"
     },
diff --git a/public/_locales/zh_CN/messages.json b/public/_locales/zh_CN/messages.json
@@ -26,6 +26,9 @@
     "action_refresh": {
         "message": "刷新数据"
     },
+    "action_all_frames": {
+        "message": "所有frame生效"
+    },
     "action_theme": {
         "message": "切换主题"
     },
@@ -116,7 +119,7 @@
         "message": "延时"
     },
     "run_at_trigger": {
-        "message": "拦截"
+        "message": "触发"
     },
     "run_at_override": {
         "message": "重写"
diff --git a/readme-zh_CN.md b/readme-zh_CN.md
@@ -31,7 +31,7 @@
 >
 > 如果你是一个熟练度拉满，有着完善的代理环境大可不必使用，仅作为特定场合的补充
 > 
-> 如果使用cdn版本，请保证能访问https://unpkg.com，首次加载会比较慢。或者直接使用local版本
+> 如果使用cdn版本，请保证能访问https://unpkg.com，首次加载会比较慢。如果加载不出来也可直接使用local版本
 
 ## 🎉 特点
 
@@ -69,7 +69,9 @@
 ## 状态栏
 - 【设置】：设置选项
 - 【工作空间】：切换工作空间
-- 【运行时机】：插件生效的时机，start-js注入即生效，end-DOMContentLoaded，delay-延时一定时间，trigger-当拦截到特定接口后触发
+- 【运行时机】：插件生效的时机，start-js注入即生效，end-DOMContentLoaded，delay-延时一定时间，trigger-当拦截到特定接口后触发，override-当window上的xhr或者fetch被重写时
+- 【禁用类型】：禁用请求类型：xhr 或者 fetch
+- 【存储占用率】：展示数据占用率
 
 ### config面板
 
@@ -78,6 +80,7 @@
 |url|string|请求地址|
 |test|string|必选，匹配的请求地址，ant-path-matcher规则或字符串匹配，不允许写query参数|
 |type|xhr\|fetch|请求类型|
+|description|string|描述字段，做备注使用|
 |response|object\|array\|null\boolean\|number|响应数据|
 |responseText|string|响应数据|
 |delay|number|延迟的毫秒数|
diff --git a/readme.md b/readme.md
@@ -72,7 +72,9 @@ How to solve the above problems? If you can intercept and modify the data before
 ## Status Bar
 - \[Setting\]: Setting
 - [Work Space]: Switch work space
-- [Run At]：four options can be choose. start (js injected will be work)，end (DOMContentLoaded)，delay (delay some times)，trigger (match a url)
+- [Run At]: four options can be choose. start (js injected will be work)，end (DOMContentLoaded)，delay (delay some times)，trigger (match a url)，override (window.XMLHttpRequest or window.fetch was override)
+- \[Ban Type\]: Ban type, xhr or fetch
+- \[Quota\]: Percent of quota
 
 
 ### Config Panel
@@ -82,6 +84,7 @@ How to solve the above problems? If you can intercept and modify the data before
 |url|string|request url|
 |test|string|required, match request url, ant-path-matcher rule or string match, cannot set query|
 |type|xhr\|fetch|request type|
+|description|string|note|
 |response|object\|array\|null\boolean\|number||
 |responseText|string||
 |delay|number||
diff --git a/src/App.less b/src/App.less
@@ -98,11 +98,11 @@
         padding: 0 4px;
         background-color: #007acc;
         color: white;
-        cursor: pointer;
         &-item {
             padding: 0 4px;
             &:hover {
                 background-color: #1f89d1;
+                cursor: pointer;
             }
         }
     }
diff --git a/src/App.tsx b/src/App.tsx
@@ -20,7 +20,7 @@ import Quota, { getPercent } from './components/Quota'
 import { runCode } from './tools/runCode'
 import { loader } from "@monaco-editor/react";
 import { sendRequestLog } from './tools/sendRequest'
-import { ActiveGroupId, BootLogKey, DarkFieldKey, HiddenFieldsFieldKey, ActiveIdFieldKey, RulesFieldKey, SelectedRowFieldKeys, UpdateMsgKey, WatchFilterKey, ConfigInfoFieldKey, PopupMsgKey } from './tools/constants'
+import { ActiveGroupId, HiddenFieldsFieldKey, ActiveIdFieldKey, RulesFieldKey, SelectedRowFieldKeys, UpdateMsgKey, WatchFilterKey, ConfigInfoFieldKey, PopupMsgKey } from './tools/constants'
 import useTranslate from './hooks/useTranslate'
 import getStorage from './tools/getStorage'
 import { ConfigProvider, theme } from 'antd'
@@ -74,6 +74,8 @@ export interface ConfigInfoType {
     action: string
     banType: BanType
     bootLog: boolean
+    allFrames: boolean
+    dark: boolean
 }
 
 const defaultConfigInfo: ConfigInfoType = {
@@ -84,22 +86,22 @@ const defaultConfigInfo: ConfigInfoType = {
     runAtTrigger: '**',
     action: 'close',
     banType: 'none',
-    bootLog: false,
+    bootLog: true,
+    allFrames: false,
+    dark: isDarkTheme,
 }
 
 export default function App() {
-    const [dark, setDark] = useStorage(DarkFieldKey, isDarkTheme)
+    const [configInfo, setConfigInfo] = useStorage<ConfigInfoType>(ConfigInfoFieldKey, defaultConfigInfo)
     const [activeGroupId, setActiveGroupId] = useStorage(ActiveGroupId, 'default')
     const [watchFilter, setWatchFilter] = useStorage(WatchFilterKey, '')
-    const [configInfo, setConfigInfo] = useStorage<ConfigInfoType>(ConfigInfoFieldKey, defaultConfigInfo)
     const [rules, setRules] = useStorage<MatchRule[]>(RulesFieldKey, [])
     const [selectedRowKeys, setSelectedRowKeys] = useStorage(SelectedRowFieldKeys, [])
     const [loading, setLoading] = useState(false)
     const [activeId, setActiveId] = useStorage<string>(ActiveIdFieldKey, null)
     const [invalid, setInvalid] = useState(false)
     const [visible, setVisible] = useState(false)
     const [hiddenFields, setHiddenFields] = useStorage<string[]>(HiddenFieldsFieldKey, [])
-    const [bootLog, setBootLog] = useStorage(BootLogKey, true)
     const [percent, setPercent] = useState(0)
     const originRef = useRef('')
     const editorRef = useRef()
@@ -120,11 +122,9 @@ export default function App() {
             [ConfigInfoFieldKey]: setConfigInfo,
             [RulesFieldKey]: setRules,
             [SelectedRowFieldKeys]: setSelectedRowKeys,
-            [DarkFieldKey]: setDark,
             [ActiveIdFieldKey]: setActiveId,
             [HiddenFieldsFieldKey]: setHiddenFields,
             [WatchFilterKey]: setWatchFilter,
-            [BootLogKey]: setBootLog,
             [ActiveGroupId]: setActiveGroupId,
         }
 
@@ -427,8 +427,6 @@ export default function App() {
         []
     )
 
-    // 数据改变后通知background，并保存chrome.storage
-
     useEffect(
         () => {
             if (!__DEV__) {
@@ -438,6 +436,15 @@ export default function App() {
                     payload: configInfo,
                 })
             }
+
+            const html = document.querySelector('html')
+            const cls = 'theme--dark'
+            if (configInfo.dark && !html.classList.contains(cls)) {
+                html.classList.add(cls)
+            } else {
+                html.classList.remove(cls)
+                document.head.querySelector('link[dark]')?.remove()
+            }
         },
         [configInfo]
     )
@@ -453,20 +460,6 @@ export default function App() {
         },
         [workspaceRules]
     )
-    useEffect(
-        () => {
-            const html = document.querySelector('html')
-            const cls = 'theme--dark'
-            if (dark && !html.classList.contains(cls)) {
-                html.classList.add(cls)
-            } else {
-                html.classList.remove(cls)
-                document.head.querySelector('link[dark]')?.remove()
-            }
-        },
-        [dark]
-    )
-
     useEffect(
         () => {
             getPercent(sizeof(rules)).then(setPercent)
@@ -476,7 +469,7 @@ export default function App() {
 
     return (
         <ConfigProvider theme={{
-            algorithm: dark ? theme.darkAlgorithm : undefined,
+            algorithm: configInfo.dark ? theme.darkAlgorithm : undefined,
             components: {
                 Table: {
                     headerBorderRadius: 0,
@@ -676,19 +669,21 @@ export default function App() {
                                 <>
                                     <Divider orientation='left' plain>
                                         <Button size='small' type='primary' onClick={() => {
-                                            setDark(false)
-                                            setBootLog(true)
-                                            setConfigInfo(info => ({ ...info, fakedLog: true }))
+                                            setConfigInfo(info => ({ ...info, fakedLog: true, bootLog: true, dark: false, allFrames: false }))
                                         }}>{t('action_reset')}</Button>
                                     </Divider>
                                     <Space size={'large'}>
+                                        <div style={{ display: 'flex' }}>
+                                            <span style={{ marginRight: 8 }}>{t('action_all_frames')}</span>
+                                            <Switch checked={configInfo.allFrames} onClick={() => setConfigInfo(info => ({ ...info, allFrames: !info.allFrames }))}></Switch>
+                                        </div>
                                         <div style={{ display: 'flex' }}>
                                             <span style={{ marginRight: 8 }}>{t('action_theme')}</span>
-                                            <Switch checked={dark} onClick={() => setDark(dark => !dark)}></Switch>
+                                            <Switch checked={configInfo.dark} onClick={() => setConfigInfo(info => ({ ...info, dark: !info.dark }))}></Switch>
                                         </div>
                                         <div style={{ display: 'flex' }}>
                                             <span style={{ marginRight: 8 }}>{t('action_boot_log')}</span>
-                                            <Switch checked={bootLog} onClick={() => setBootLog(bootLog => !bootLog)}></Switch>
+                                            <Switch checked={configInfo.bootLog} onClick={() => setConfigInfo(info => ({ ...info, bootLog: !info.bootLog }))}></Switch>
                                         </div>
                                         <div style={{ display: 'flex' }}>
                                             <span style={{ marginRight: 8 }}>{t('action_faked_log')}</span>
@@ -729,7 +724,11 @@ export default function App() {
                             <Popover trigger={['click']} placement='top' showArrow={false} content={(
                                 <>
                                     <Segmented value={configInfo.runAt} onChange={(runAt: string) => {
-                                        setConfigInfo(info => ({ ...info, runAt }))
+                                        setConfigInfo(info => ({ 
+                                            ...info, 
+                                            runAt,
+                                            action: (runAt === 'override' && info.action === 'close') ? 'intercept' : info.action,
+                                        }))
                                     }} options={[
                                         {
                                             label: t('run_at_start'),
@@ -806,7 +805,7 @@ export default function App() {
                         editable && (
                             <div className='app__editor'>
                                 <MainEditor
-                                    isDark={dark}
+                                    isDark={configInfo.dark}
                                     ref={editorRef}
                                     index={activeIndex}
                                     rule={rules[activeIndex]}
diff --git a/src/background/index.ts b/src/background/index.ts
@@ -29,7 +29,9 @@ chrome.tabs.onUpdated.addListener(update)
 // 接收popup传来的信息，并转发给content.js
 chrome.runtime.onMessage.addListener((msg: CustomEventProps) => {
     // 过滤非本插件的消息
-    if (msg.from !== PopupMsgKey) return;
+    if (msg.from !== PopupMsgKey) {
+        return
+    }
 
     if (msg.type === 'rules') {
         __rules = msg.payload || []
@@ -180,6 +182,11 @@ function responseStartedWatch(details: chrome.webRequest.WebResponseCacheDetails
 
         const urlObj = new URL(details.url)
 
+        if (details.method.toLowerCase() === 'options') {
+            __result.delete(details.requestId)
+            return
+        }
+
         chrome.storage.local.get([RulesFieldKey, ActiveGroupId], (result) => {
             chrome.storage.local.set({
                 [RulesFieldKey]: [
@@ -222,6 +229,12 @@ function beforeRequestIntercept(details: chrome.webRequest.WebRequestBodyDetails
 }
 
 function beforeRequestWatch(details: chrome.webRequest.WebRequestBodyDetails, url: string) {
+
+    // 过滤请求
+    if (['OPTIONS', 'CONNEST', 'TRACE', 'HEAD'].includes(details.method)) {
+        return
+    }
+
     if (! details.requestBody) {
         details.requestBody = { formData: {} }
     }
diff --git a/src/content/index.ts b/src/content/index.ts
diff --git a/src/content/tools.ts b/src/content/tools.ts
diff --git a/src/injected/tool.ts b/src/injected/tool.ts

Original file line number	Diff line number	Diff line change
`@@ -98,11 +98,11 @@`
`98`	`98`	`padding: 0 4px;`
`99`	`99`	`background-color: #007acc;`
`100`	`100`	`color: white;`
`101`		`- cursor: pointer;`
`102`	`101`	`&-item {`
`103`	`102`	`padding: 0 4px;`
`104`	`103`	`&:hover {`
`105`	`104`	`background-color: #1f89d1;`
	`105`	`+ cursor: pointer;`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`	`}`