GM_openInTab by cyfung1031 · Pull Request #788 · scriptscat/scriptcat

cyfung1031 · 2025-10-01T13:11:54Z

概述

关联的 issue： #685

https://www.tampermonkey.net/documentation.php?locale=en#api:GM_openInTab

An optional options object that can be used to customize the behavior of the new tab. The available options include:

active: A boolean value indicating whether the new tab should be active (selected) or not. The default is false.
insert: An integer indicating the position at which the new tab should be inserted in the tab strip. The default is false, which means the new tab will be added to the end of the tab strip.
setParent: A boolean value indicating whether the new tab should be considered a child of the current tab. The default is false.
incognito A boolean value that makes the tab being opened inside a incognito mode/private mode window.
loadInBackground A boolean value has the opposite meaning of active and was added to achieve Greasemonkey 3.x compatibility.

active

TM: 预设 false
SC: 预设 true
VM: 预设 true
暂不更改：维持旧 SC 行为

insert

原描述有误，TM 实际为 boolean，预设 true (与VM 一致）
应与 TM 一致，改成 default true（让 SC 与 TM、VM 保持一致）
若 insert 为数字，则为 SC 独有功能，相对于现有 tab：
- insert = -1 → 加在当前 tab 前两格
- insert = 0 → 加在当前 tab 前一格
- insert = 1 → 加在当前 tab 后一格 = insert = true
- insert = 2 → 加在当前 tab 后两格

setParent

TM: 预设 false
SC: 因发现 openerTabId 问题，不跟随 TM，改为 default true

incognito

由于 manifest 中设定 incognito: "split"，
- 在 normal window 执行时，tabId、windowId 皆无法取得
- 仅能执行「打开」动作

loadInBackground

行为与 active 相反
TM 有兼容
以 active 为优先

另外加入 FM&VM 的 pinned . 见 https://violentmonkey.github.io/api/gm/

变更内容

截图

CodFrm · 2025-10-01T13:49:12Z

src/types/scriptcat.d.ts

+    active?: boolean; // FM & TM & VM; TM default false
+    insert?: boolean; // FM & TM & VM; TM default true
+    setParent?: boolean; // FM & TM
+    incognito?: boolean; // FM & TM
+    loadInBackground?: boolean; // TM - A boolean value has the opposite meaning of active (just for TM. Not Recommended)
+    pinned?: boolean; // FM & VM


应该增加更详细的参数描述

Copilot

Pull Request Overview

这个PR实现了GM_openInTab API的完整功能，支持多种选项参数以提供更精细的标签页控制。

更新类型定义文件，为OpenTabOptions接口添加详细的中文文档和新的选项字段
重构服务工作者中的GM_openInTab实现，增加对insert、setParent、incognito、pinned等选项的支持
修改内容脚本中的参数处理逻辑，改进active和loadInBackground的兼容性

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.

File	Description
src/template/scriptcat.d.tpl	为OpenTabOptions接口添加完整的类型定义和中文文档，包括active、insert、setParent、incognito、loadInBackground、pinned、useOpen等选项
src/app/service/service_worker/gm_api.ts	重构GM_openInTab方法实现，添加对所有新选项的处理逻辑，包括隐私窗口创建、标签页位置插入、父子关系设置等
src/app/service/content/gm_api.ts	改进参数处理逻辑，修复active和loadInBackground的兼容性问题，并修正代码注释中的简繁体混用

Copilot · 2025-10-03T08:59:41Z

src/app/service/service_worker/gm_api.ts

-        // 似乎在Firefox中禁止在background页面使用window.open()，强制返回null
-        return false;
+        const { tabId, windowId } = sender.getExtMessageSender();
+        const active = options.active;


在处理active选项时缺少默认值处理。根据内容脚本中的逻辑，当active未定义时应该默认为true，但这里直接使用可能导致undefined值传递给Chrome API。

Suggested change

const active = options.active;

const active = options.active ?? true;

content 的 GM_openInTab API 有处理default值问题。TypeScript这里要加 !
默认值处理只在 content / service_worker 其中一边做，否则会很混乱

Copilot · 2025-10-03T08:59:41Z

src/app/service/service_worker/gm_api.ts

+        if ((typeof options.insert === "number" || options.insert === true) && currentTab && currentTab.index >= 0) {
+          // insert 为 boolean 时，插入至当前Tab下一格 (TM行为)
+          // insert 为 number 时，插入至相对位置 （SC独自）
+          const insert = +options.insert;


当options.insert为boolean类型时，使用+操作符转换会得到0或1，但对于true应该表示插入到当前标签后一格。应该使用条件判断：const insert = options.insert === true ? 1 : +options.insert;

Suggested change

const insert = +options.insert;

const insert = options.insert === true ? 1 : +options.insert;

JavaScript +options.insert 就是 1

src/app/service/content/gm_api.ts

Copilot · 2025-10-03T08:59:41Z

src/app/service/service_worker/gm_api.ts

+        if ((typeof options.insert === "number" || options.insert === true) && currentTab && currentTab.index >= 0) {
+          // insert 为 boolean 时，插入至当前Tab下一格 (TM行为)
+          // insert 为 number 时，插入至相对位置 （SC独自）
+          const insert = +options.insert;
+          newTabIndex = currentTab.index + insert;
+          if (newTabIndex < 0) newTabIndex = 0;


条件判断逻辑复杂且容易出错。建议重构为更清晰的结构，先检查options.insert的类型，然后分别处理boolean和number的情况。

Suggested change

if ((typeof options.insert === "number" || options.insert === true) && currentTab && currentTab.index >= 0) {

// insert 为 boolean 时，插入至当前Tab下一格 (TM行为)

// insert 为 number 时，插入至相对位置（SC独自）

const insert = +options.insert;

newTabIndex = currentTab.index + insert;

if (newTabIndex < 0) newTabIndex = 0;

if (currentTab && currentTab.index >= 0) {

let insert: number | undefined;

if (typeof options.insert === "number") {

// insert 为 number 时，插入至相对位置（SC独自）

insert = options.insert;

} else if (options.insert === true) {

// insert 为 boolean 时，插入至当前Tab下一格 (TM行为)

insert = 1;

}

if (typeof insert === "number") {

newTabIndex = currentTab.index + insert;

if (newTabIndex < 0) newTabIndex = 0;

}

不需要冗长代码。原代码足够清晰

Co-authored-by: Copilot <[email protected]>

scriptscat/scriptcat#788

src/app/service/service_worker/gm_api.ts

cyfung1031 · 2025-10-04T12:59:12Z

如沒問題，可合併PR

GM_openInTab

6b0c163

CodFrm reviewed Oct 1, 2025

View reviewed changes

增加更详细的参数描述

70e5bc4

CodFrm requested a review from Copilot October 3, 2025 08:58

Copilot AI reviewed Oct 3, 2025

View reviewed changes

cyfung1031 and others added 3 commits October 3, 2025 19:25

Copilot说得对

993efb5

Co-authored-by: Copilot <[email protected]>

TypeScript

0192500

调整d.ts

2b05fa3

CodFrm added a commit to scriptscat/scriptcat.org that referenced this pull request Oct 4, 2025

修改GM API定义

70c1031

scriptscat/scriptcat#788

CodFrm approved these changes Oct 4, 2025

View reviewed changes

src/app/service/service_worker/gm_api.ts Outdated Show resolved Hide resolved

service_worker 那边的 options.active 不会出现undefined

96d37d3

CodFrm merged commit eb33d61 into scriptscat:main Oct 4, 2025
2 of 3 checks passed

cyfung1031 mentioned this pull request Oct 6, 2025

[Feature] 建议GM_openInTab增加是否固定标签选项或Tab增加pin方法 #685

Closed

cyfung1031 deleted the open-tab-api-001 branch October 17, 2025 13:33

	const active = options.active;
	const active = options.active ?? true;

	const insert = +options.insert;
	const insert = options.insert === true ? 1 : +options.insert;

Comments

Conversation

cyfung1031 commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

概述

active

insert

setParent

incognito

loadInBackground

变更内容

截图

Uh oh!

CodFrm Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

cyfung1031 Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

cyfung1031 Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

cyfung1031 Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

cyfung1031 Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

cyfung1031 Oct 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cyfung1031 commented Oct 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cyfung1031 commented Oct 1, 2025 •

edited

Loading