# @globisnv/cypress-core 中文文档

规范地址：https://npmcn.com/package/%40globisnv/cypress-core/

版本：2\.8\.0
npm 元数据更新时间：2026-11-16T12:56:44.897Z
中文译文更新时间：2026-11-16T16:16:07.565Z
软件包许可：UNLICENSED

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40globisnv/cypress-core
原文对照：https://npmcn.com/package/%40globisnv/cypress-core/?lang=original
项目主页：https://github.com/globisnv/globis-cypress-core#readme
源码仓库：https://github.com/globisnv/globis-cypress-core

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：720 kB，349 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.0\.0 \|\| ^24\.0\.0 \|\| \>=26\.0\.0
- 运行依赖：5 个
- peer 依赖：cypress ^16\.0\.0，cypress-real-events ^1\.15\.1
- 首次发布：2026-08-14T11:51:28.151Z
- 最新版本发布：2026-11-16T12:56:44.702Z
- 近 30 天下载量：5128（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 37 个）

## 中文简介

Globis Cypress E2E测试的核心构件

## 安装

```sh
npm install @globisnv/cypress-core
```

也可以使用：`pnpm add @globisnv/cypress-core`、`yarn add @globisnv/cypress-core`、`bun add @globisnv/cypress-core`

## README

# @globisnv/ cypress-core (英语)

Globis Cypress E2E测试的核心构件.

这包包里装着一切 _没有_ 客户特异性:共享 Cypress 配置工厂,基于Servoy的Globis解决方案的自定义命令库,WebSocket-aware加载检测器,可重复使用的数据输入蓝图,以及lint插件. 客户重新安装,呼叫 `defineGlobisConfig()` 中标 `cypress.config.ts`导入 `@globisnv/cypress-core/register` 在支持文件中,只保留自己的规格和客户特定命令.

* * *

## 安装

```bash
npm install @globisnv/cypress-core
```

同伴依赖性(必须安装在消费者回购中)——见 `peerDependencies` 内 [软件包.json](https://npmcn.com/package/%40globisnv/cypress-core/package.json) 精确支持范围.

* * *

## 与 Globis 在线兼容

科雷自己的版本是纯正的,刻意的 **没有** 被绑在了globis-online的版本号上——两个在独立时间表上的发布,强迫他们分享数字将意味着每次globis-online上的船只都会撞出一个不触碰任何核心的发布依赖于的芯片.

相反,每个核心发布都宣布 **最低** 它需要的光子在线版本——一楼而不是一针. 蓝图和命令是针对给定发行的Servoy DOM/行为书写的;它们一直致力于以后每一次的Globis在线发行 _直至_ 其中之一实际上改变了一个蓝图所依赖的东西, 此时核心无论如何需要一个新的版本, 它的下限被撞到那个发行。 没有任何有意义的上层约束可以事先宣布——你只发现一个版本通过跑来冲破了某种东西.

版本起落的每个部分都意味着:

| 弹出 | 何时 |
| --- | --- |
| 主要 | Globis-在线发布打破了这个软件包的支撑底部——起伏 `globisOnline.minVersion` (还有这个表) |
| 小声 | 一个新的命令 / 蓝图 / API 表面, 向后兼容 |
| 补丁 | 只有错误修正 |

见 [切开释放](https://npmcn.com/package/%40globisnv/cypress-core/#readme-cutting-a-release) 如何一个凸出 真正得到发布.

| 核心版本 | 最小光子在线版本 |
| --- | --- |
| `2.0.0` | `11.0.3` |
| `0.0.1` | `11.0.2` |

楼下记录为: `package.json` 下级 `globisOnline.minVersion` (机器可读,如果工具 想要检查它以后) 和这里在本表(人可读,更新 每一个发行 与 `CHANGELOG.md`) (中文(简体) ). `globis-cypress` 一直被固定在最新的核心版本上——因为它是格洛比斯自己的套房,这是第一个在任何客户重播之前抓住被光子上线的放出破碎的东西.

## 切开释放

释放是两个阶段,因为 `develop` ruleset需要经过审查的PR——所以版本的凸起采用与其它每个变化相同的路由,而不是CI试图推过ruleset.

1.  **行动- [准备释放](https://npmcn.com/package/%40globisnv/cypress-core/.github/workflows/release-pr.yml) • 运行工作流程**选择 `patch` 编号 : `minor` 编号 : `major`它会撞倒 `package.json`,重命名为 `## Unreleased` 标题 `CHANGELOG.md` 改为 `## X.Y.Z` 打开新空 `## Unreleased` 上面,打开一个 `chore(release): vX.Y.Z` 公关。 还没有出版.
2.  **请检查url=值 (帮助)** (它成为了 GitHub 释放笔记)和 **自己来**。 。 。 . [发布](https://npmcn.com/package/%40globisnv/cypress-core/.github/workflows/publish.yml) 然后构建, lints, 发布到 npm, 并创建标签和 GitHub Release .

释放公关被故意从 每一个其他公关得到的自动化中排除出来. 由 `GITHUB_TOKEN` 创建没有工作流程运行,所以自动并发的发布PR会登陆到git的版本,并且永远不会发布. 如果真的发生,快跑 **行动 · 公布 · 运行工作流程** 并给它发布PR的号码 完成发布。 它公布PR的合并承诺——不是从什么开始的——所以恢复仍然在运送被审查的树,它拒绝不是合并的PR `release/*` 输入 `develop`。 。 。 .

在下方写入更改日志条目 `## Unreleased` 标题是合并工作,而不是在发布时——发布只是重新命名标题并打开了一个新的标题,所以顶部总是有一节要写入,文件从不需要手动重组. 如果没有 `## Unreleased` 区域,当您剪切一个发布时,工作流程会添加一个空 `## X.Y.Z` 扣子和警告, 你填写在公关.

出版用途 [npm 信任的出版](https://docs.npmjs.com/trusted-publishers/) 因此没有 `NPM_TOKEN` 而发布路径中任何地方都没有PAT——发布工作唯一的写入范围是它创建的标记并发布. npm 上信任的出版商必须命名 **`publish.yml`** 作为工作流程。 npm出处保持不动:它没有从私人仓库中支持.

因为撞地在地上 _在此之前_ 任何信息到达 npm 时, 失败的发布从不离开登记簿在寄存器之前 —— 在修复后重新运行工作流程, 在 npm 上已经存在的版本被跳过而不是重试 .

* * *

## 设立新的客户回购

开始全新的客户测试 从空白的板块重播 —— 不从现有的板块上手动复制 :

```bash
npx -p @globisnv/cypress-core create-globis-customer-repo
```

它提出了两个问题——目标文件夹(例如:. `acme-cypress`)和客户的3个字母缩写(如. `ACM`——然后:

-   将一个最小模板复制到文件夹中 : `package.json`, (中文(简体) ), `tsconfig.json`, (中文(简体) ), `biome.json`, (中文(简体) ), `cypress.config.ts`, (中文(简体) ), `cypress.env.json.example`, (中文(简体) ), `CODEOWNERS`, (中文(简体) ), `.gitignore`, (中文(简体) ), `cypress/support/{e2e.ts,record.ts}`启动器 `cypress/e2e/<abbrev>/template.cy.ts.example`。 。 。 .
-   运行 `git init` 财务报告和审定财务报表 `npm install`。 。 。 .

生成的 repo 有新鲜历史( 没有任何复制或过滤自其它 repo) , 并取决于 `@globisnv/cypress-core` 和任何其他消费者一样——没有本地客户的命令或蓝图是预先被流行的,因此它永远不能泄露另一个客户的代码. 从之:

```bash
cd acme-cypress
cp cypress.env.json.example cypress.env.json   # fill in your credentials
npx cypress open --e2e --browser chrome
```

* * *

## 使用量

### 1\. 联合国. `cypress.config.ts`

```ts
import { defineGlobisConfig } from '@globisnv/cypress-core/config';

export default defineGlobisConfig({
    // Scalar e2e overrides — merged over the core defaults
    e2e: {
        specPattern: 'cypress/e2e/**/*.cy.ts',
        defaultCommandTimeout: 20000,
        // Optional: runs *after* the core wiring, on the same `on`/`config`
        setupNodeEvents(on, config) {
            // customer-specific node events
        }
    },
    // Optional: extra cy.task() handlers alongside the core ones
    extraTasks: {
        myTask(arg) {
            return null;
        }
    }
});
```

`defineGlobisConfig()` (单位:千美元)[src/配置图](https://npmcn.com/package/%40globisnv/cypress-core/src/config.ts))设置共享默认——1920×1080取景口,视频不压缩开启,120s响应超时, `experimentalMemoryManagement`, (中文(简体) ), `scrollBehavior: 'center'` 电线:

-   **信封接触** ——每个 `config.env` 密钥被复制到 `config.expose` _除外_ 敏感者`password`, (中文(简体) ), `password2`, (中文(简体) ), `api_key`, (中文(简体) ), `QLIKURLS`, (中文(简体) ), `S3_KEY`, (中文(简体) ), `S3_SECRET`),保持节点侧.
-   **核心任务** —— 说 `log`, (中文(简体) ), `set`, (中文(简体) ), `get` (一个跨规格共享的加工范围密钥/价值库), `bufferWsMetrics` 财务报告和审定财务报表 `flushWsMetrics`。 。 。 .
-   **浏览器大小** a 包括: `before:browser:launch` 钩使1920×1080和 `--force-device-scale-factor=1` 用于无头Chrome,外加Firefox/Electron等效.

### 2\. 联合国. `cypress/support/e2e.ts`

```ts
import '@globisnv/cypress-core/register';

// Customer-specific commands stay local:
import './commands/ACME_commands';
```

[src/注册.ts](https://npmcn.com/package/%40globisnv/cypress-core/src/register.ts) 导入所有通用命令文件、 WebSocket 探测器,以及 `cypress-real-events`登记 `beforeEach` + 键 `Cypress.on('fail')` 标记失败的测试 `set`编号 :`get` 任务,所以清理命令像 `GLO_closeDashboard` 而不是用云层报告中的二次失败来掩盖真正的错误.

### 3\. 蓝图、命令和帮助者

蓝图和通用命令文件 **没有** 从软件包根再出口——通过子路径导入:

```ts
import { GLO_enterEquipment, type objEquipment } from '@globisnv/cypress-core/blueprints/GLO_equipment';
import { getUUID, getDate, open, close, check } from '@globisnv/cypress-core/tsHelper';
import { createRequestVariables } from '@globisnv/cypress-core/apiMethods/IGS_request';
```

可用的子路径 :

| 子路径 | 目录 |
| --- | --- |
| `.` | `defineGlobisConfig` 只——安全地从 `cypress.config.ts` |
| `./register` | 登记所有命令的副作用导入 |
| `./config` | 装配厂自己 |
| `./tsHelper` | 常数、品牌旗帜和助手功能 |
| `./types` | 环境/全球类型宣言 |
| `./blueprints/*` | 每个方案的数据输入蓝图 |
| `./commands/*` | 单个命令文件 |
| `./apiMethods/*` | REST 请求/答复助手 |

> 执行 **没有** 尝试通过自定义 tsconfig 路径异名指向 `node_modules`。 。 。 . `tsconfig-paths-webpack-plugin` (Cypress默认预处理器使用)默默地忽略了内部解决的映射 `node_modules` - 他们打字但是没有捆绑。 真实的软件包子路径导出均正确解析 `tsc` 和网络包装.

> `tsHelper` 是故意的,这是故意的 **没有** 从包根再出口。 它的顶层 `Cypress.expose(...)` 调用仅在浏览器文本( 光谱/ 支持) 进程中工作 —— `cypress.config.ts` 在节点中运行, 因此根导入( Q)`.`)必须保持安全才能在那里使用. 总是导入 `tsHelper` 通过 `@globisnv/cypress-core/tsHelper` 当然.

* * *

## 盒子里的东西

```
src/
├── config.ts             # defineGlobisConfig() — the shared cypress.config factory
├── register.ts           # side-effect entrypoint: loads all generic commands
├── index.ts              # public API (config factory + tsHelper re-export)
├── tsHelper.ts           # constants, branded boolean flags, date/UUID/number helpers, cleanup formulas
├── types.ts              # global ambient types (selectors, dialogs, WebSocket protocol, extended filters)
├── websocketDetector.ts  # WebSocket spy + WS_loadingCheck state machine
├── blueprints/           # 132 per-program data-entry blueprints
├── commands/             # 6 generic command files (~128 custom commands)
├── apiMethods/           # IGS REST request/response helpers
└── plugins/              # prometheusWriter — SigV4-signed remote write to AWS AMP
biome-plugins/            # GritQL lint rules (shipped to consumers)
```

### 指挥家庭

每个命令文件都针对一个Globis解决方案. 全部被装入 `register.ts`。 。 。 .

| 前缀 | 解决方案 | 图标 |
| --- | --- | --- |
| `GLO_` | Globis Online( Servoy 主客户端) | 页:1 |
| `FOB_` | 窗体构建器 | 页:1 |
| `GLT_` | Glob Take (英语:`/solution/globtake`(中文(简体) ) | 第11个 |
| `POR_` | 门户 | 10个 |
| `GLS_` | 光谱扫描( GlobScan) (`/solution/globscan`(中文(简体) ) | 第8条 |
| `GLJ_` | GlobJob (英语:`/solution/globjob`(中文(简体) ) | 3个 |
| `WS_` | WebSocket 帮助者(来自 `websocketDetector.ts`(中文(简体) ) | 3个 |

`GLO_commands.ts` 是主干:登录/日志和公司/用户切换,元素查询(`GLO_getElement`),输入/日期/检查框/收音机条目,网格互动(选择,排序,过滤,行搜索,自定义视图),对话框处理,数据控制按钮,扩展过滤,文件上传/读取,以及步骤之间的值存储. 每个命令都带有带有其参数的JSDoc块——即参考文件.

### 蓝图

一个蓝图是被打出的对象外加一个功能,它填写在一个程序的细节形式上. 举个例子 [GLO 设备.ts](https://npmcn.com/package/%40globisnv/cypress-core/src/blueprints/GLO_equipment.ts) 出口 `objEquipment` 财务报告和审定财务报表 `GLO_enterEquipment(obj, tabName?)`沿着田地走 `cy.GLO_addInput`, (中文(简体) ), `cy.GLO_checkbox`, (中文(简体) ), `cy.GLO_popupWindow`,而代表们则将区块嵌入到其他蓝图中`GLO_enterAddressPopup`) (中文(简体) ). 然后将光谱读作数据,而不是点击:

```ts
GLO_enterEquipment({
    equipmentCode: `CYP-${getUUID(4)}`,
    equipmentCategory: 'Trailer',
    flagIsActive: check
});
```

131份蓝图涵盖Globis在线程序(文章、合同、运输订单、发票、发货、仓库、海关.)和1份涵盖GlobTake.

### WebSocket 探测器

Servoy的前端在它的后端谈论 一个单一的持久 WebSocket,它 `cy.intercept()` 无法观察——历史上意味着 `cy.wait(N)`。 。 。 . [websocket 探测器](https://npmcn.com/package/%40globisnv/cypress-core/src/websocketDetector.ts) 替换为语义- 意识闲置检查 :

-   `WS_visitWithSpy(url)` 访问 URL `window.WebSocket` 已补齐, 所以每个相框都镜像到 `win.wsMessages`。 。 。 .
-   `WS_loadingCheck(options?)` ——只解决一次待决请求,即Sablo装载指标,待决 `svyPush` 数据同步,DOM加载指示器都闲置了一段时间. 处理对话框、弹出表单, `closeNode`编号 :`cellClick` 爆破 窗户被摧毁 导航.
-   `WS_toggleDialogHandler('enable' | 'disable')` - 控制是否平坦 `Info` 对话框是自动解禁或留待测试使用.

每次选入: `cypressWebsocketLoader` 编号 : `cypressWebsocketDebug` 读自 `extraParams` env 对象(见下文).

### 计量

`WS_loadingCheck` 能够释放每个动作计时量。 它们被缓冲入记忆 `bufferWsMetrics` 任务和推进 `flushWsMetrics`,SigV4-在容器IMDS证书上签下Snappy压缩的Prometheus远程写出有效载荷([src/plugins/prometheusWriter.ts (中文(简体) )](https://npmcn.com/package/%40globisnv/cypress-core/src/plugins/prometheusWriter.ts)) (中文(简体) ). 冲是 **没有 - 除非 `AMP_REMOTE_WRITE_URL` 设定**,所以消费者在没有AMP端点的情况下重置,就是永远不推.

* * *

## 环境变量

通过 Cypress env 设定(`config.env`, (中文(简体) ), `CYPRESS_*`,或 `--env`除非注明.

| 密钥 | 目的 |
| --- | --- |
| `globisUrl` | 基础解决方案 URL. `GLJ/GLS/GLT_login` 重写 `/solution/<name>` 离这一段. |
| `portalUrl`, (中文(简体) ), `formBuilderUrl`, (中文(简体) ), `ssoUrl` | 门户、窗体构建器和 Okta 登录流量的条目 URL(`ssoUrl` 曾经 `oktaUrl`) (中文(简体) ). 与 `loginType: sso` 提供商从中遵循: `okta`,否则 Keycloak(默认) `https://auth.globis.cloud`) (中文(简体) ). |
| `username`, (中文(简体) ), `username2` | 默认和替代登录用户 . |
| `password`, (中文(简体) ), `password2`, (中文(简体) ), `api_key`, (中文(简体) ), `otpSecret` | 秘密——保持节点侧面,从未被浏览器曝光. `otpSecret` 是 Keycloak 用户与 OTP 的 Base32 TOTP 秘密 . |
| `loginType` (单位:千美元)`default`编号 :`servoy`编号 :`sso`, (中文(简体) ), `ownerName`, (中文(简体) ), `formBuilderStandalone`, (中文(简体) ), `saveData` | 由命令读取的登录/流程开关 . |
| `BUILD_NUMBER` | 用于 `getOrCreateUuid()` 建立一个稳定的 `CYP<build>` 测试数据前缀. |
| `extraParams` | 詹金斯通过的额外物品; `cypressWebsocketLoader` 财务报告和审定财务报表 `cypressWebsocketDebug` (单位:千美元)`'true'`住在这里. |
| `AMP_REMOTE_WRITE_URL`, (中文(简体) ), `AMP_REGION` | 节点 `process.env` ——普罗米修斯远程写作目标和区域. |
| `numTestsKeptInMemory` | 节点 `process.env` ——超越 Cypress 的默认 `0`。 。 。 . |

* * *

## 发展

```bash
npm run build          # tsc -p tsconfig.build.json  → dist/
npm run build:watch    # incremental build for local linking
npm run typescript     # tsc --noEmit --skipLibCheck
npm run lint           # biome check .
npm run lint:fix       # biome check . --write
```

格式化为 Biome([biome.json (英语)](https://npmcn.com/package/%40globisnv/cypress-core/biome.json):4-空格缩进,单引号,分号,无后序逗号,180行,LF结尾. [src/biome.json (中文(简体) )](https://npmcn.com/package/%40globisnv/cypress-core/src/biome.json) 扩展为 `src/` 仅: 启用 `noUnnecessaryWaiting` 那里并禁用 `noUnusedVariables` 页:1 `types.ts`,这是只声明。 它住在这里 `src/` 因为消费者 `extends` 词根 `biome.json`,而其中的插件路径会解决他们的还本付息问题.

### 已装运的插件

`biome-plugins/` 用包出版,所以消费者重置 运行同样的规则 他们的规格与Biome [GritQL 插件](https://biomejs.dev/linter/plugins/)他们的诊断结果出现在 `biome check`编辑和CI Linter像任何内在规则.

| 插件 | 它会做什么 |
| --- | --- |
| [无需等待. grit](https://npmcn.com/package/%40globisnv/cypress-core/biome-plugins/noUnnecessaryWaiting.grit) | 失败 `cy.wait(<number>)`,包括在附件范围内声明的数字常数/默认参数。 免予打电话 `// biome-ignore lint/plugin/noUnnecessaryWaiting: <reason>` 上面的线. |

把它接入消费者的回波 `biome.json` (模板已经做了). Biome 解析来自消费者根而不是来自一个 `extends`\- 装配,所以路径不能活在这个包 `biome.json`数字 :

```json
{
    "extends": ["./node_modules/@globisnv/cypress-core/biome.json"],
    "plugins": ["./node_modules/@globisnv/cypress-core/biome-plugins/noUnnecessaryWaiting.grit"]
}
```

`check-deprecated-get-commands.mjs` (旧位置-API-to-tuple-form codemod)为: **没有** 运过来的.. `globis-cypress`属于自己的 `scripts/`。这只关系到repo的旧版本分支(`11.0.1`, (中文(简体) ), `11.0.0`, (中文(简体) ), `10.5.19`),它从未采用过tuple基的API,也永远不会;没有客户回波曾有过旧API,所以它在那里没有什么可做的.

### 公约

-   **仅限无害环境管理** (单位:千美元)`"type": "module"`—— 国内进口 `.js` 扩展名.
-   命令在 `Cypress.Chainable` 内置 a `declare global` 在文件执行它们,每个参数都有JSDoc.
-   布尔参数使用从 `tsHelper.ts` (单位:千美元)`open`编号 :`close`, (中文(简体) ), `check`编号 :`unCheck`, (中文(简体) ), `skipCheck`编号 :`noSkipCheck`,)所以一个呼叫网站读作意向而不是 `true`编号 :`false`。 。 。 .
-   新的通用指令,蓝图和帮助者都属于这里;任何针对客户的都保留在消费者回购中.

### 审查所有权

[消费者](https://npmcn.com/package/%40globisnv/cypress-core/CODEOWNERS) 保护共享地表—— `package.json`, (中文(简体) ), `tsconfig*.json`, (中文(简体) ), `biome.json`, (中文(简体) ), `src/config.ts`, (中文(简体) ), `src/register.ts`, (中文(简体) ), `src/commands/`, (中文(简体) ), `src/plugins/` 财务报告和审定财务报表 `.github/`。那里的变化需要由所列所有人进行审查.

## 常见问题

### @globisnv/cypress-core 是什么？

Globis Cypress E2E测试的核心构件

### 如何安装 @globisnv/cypress-core？

在项目目录运行 npm install @globisnv/cypress-core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：cypress（^16\.0\.0）、cypress-real-events（^1\.15\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 create-globis-customer-repo，可以用 npx create-globis-customer-repo 直接运行。

### @globisnv/cypress-core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @globisnv/cypress-core 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @globisnv/cypress-core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.0\.0 \|\| ^24\.0\.0 \|\| \>=26\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @globisnv/cypress-core 可以商用吗？

@globisnv/cypress-core 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @globisnv/cypress-core 的下载量有多少？

根据 npm 官方下载统计，@globisnv/cypress-core 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,128 次，日均约 171 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @globisnv/cypress-core 还在维护吗？

最新版本 2\.8\.0 发布于 2026/11/16（今天）；至今共发布 37 个版本，其中过去 12 个月发布了 37 个；首次发布于 2026/08/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

