# @cypress/env-or-json-file 中文文档

规范地址：https://npmcn.com/package/%40cypress/env-or-json-file/

版本：2\.0\.0
npm 元数据更新时间：2025-10-27T19:11:13.749Z
中文译文更新时间：2026-11-11T08:25:38.182Z
软件包许可：MIT

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

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

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=6
- 运行依赖：3 个
- 首次发布：2017-07-12T18:07:07.006Z
- 最新版本发布：2017-10-30T17:05:18.105Z
- 近 30 天下载量：2648（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

从环境字符串或本地文件装入 JSON 对象

## 安装

```sh
npm install @cypress/env-or-json-file
```

也可以使用：`pnpm add @cypress/env-or-json-file`、`yarn add @cypress/env-or-json-file`、`bun add @cypress/env-or-json-file`

## README

# @cypress/env-或-json-文件

> 从环境字符串或本地文件装入 JSON 对象

[![NPM](https://nodei.co/npm/@cypress/env-or-json-file.svg?downloads=true)](https://npmjs.org/package/@cypress/env-or-json-file)

 [![Build status](https://travis-ci.org/cypress-io/env-or-json-file.svg?branch=master)](https://travis-ci.org/cypress-io/env-or-json-file)[![Build status](https://ci.appveyor.com/api/projects/status/lwqty4s0g0l1x9x0?svg=true)](https://ci.appveyor.com/project/cypress-io/env-or-json-file) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg) ](https://github.com/semantic-release/semantic-release)[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

## 安装

要求数 [节点](https://nodejs.org/en/) 6或以上版本.

```sh
npm install --save @cypress/env-or-json-file
```

## 使用

如果您本地有配置文件 `foo.json` 与所有设置, 直接装入

```js
const {configFromEnvOrJsonFile} = require('@cypress/env-or-json-file')
const config = configFromEnvOrJsonFile('foo.json')
if (config) {
  // ok, loaded somehow
} else {
  console.error('Missing config...')
}
```

但是,当你移动到CI, 只是抓住文件的内容并把它作为 环境变量 `foo_json` (环境变量往往有限制) ,所以替换全部 `/.-` 路径中的字符 `_`(中文(简体) )

```sh
cat foo.json | pbcopy
```

粘贴到 CI 变量 `foo_json` 它应该装入配置 在CI上没有检查敏感文件.

## 调试

从此模块看到动词日志消息, 请运行 `DEBUG=env-or-json-file ...` 环境变量.

## 文件名

带有路径的文件名, 函数 `filenameToShellVariable` 转换为 环境密钥名称,使斜线和点正常化.

```js
const {filenameToShellVariable} = require('@cypress/env-or-json-file')
filenameToShellVariable('foo/bar/.me.json')
// foo_bar__me_json
```

## 提示

-   防止使用敏感文件 [禁止敏感文件](https://github.com/bahmutov/ban-sensitive-files)
-   确保 CI 不向叉子泄露环境变量, 如 [CircleCI确实如此](https://circleci.com/docs/1.0/fork-pr-builds/)

![Stop CircleCI default variable leak](https://npmcn.com/package/%40cypress/env-or-json-file/images/circleci-env-vars.png)

### 小印数

授权:麻省理工学院 - 做任何事情 代码,但不要责怪我们 如果它不工作.

支持: 如果您发现此模块有任何问题, 电子邮件 / 微博 / [未决问题](https://github.com/cypress-io/env-or-json-file/issues) 在基图布

## MIT 许可证

版权(c)2017 Cypress.io

特此免费准许任何人 获取该软件和相关文件的副本 文件(“软件”),在软件中处理,不包含 限制,包括不限制使用权, 复制、修改、合并、出版、发行、分版和/或销售 软件的复制本,并允许向 为此提供了软件,但须符合下列条件: 条件:

上述版权通知和本许可通知应为: 列入软件的所有副本或大部分.

软件是提供的"是", 没有任何种类的恐惧, 或监禁,包括但不限制于 特别目的和目的的证明 无所不入。 绝对不能让警察或警察 B. 任何索赔、救济或其他负债的持有者, 条约、条约或其他条约行动 来源、来源或与溶剂或使用有关的 其他交易 在软件.

## 常见问题

### @cypress/env-or-json-file 是什么？

从环境字符串或本地文件装入 JSON 对象注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @cypress/env-or-json-file？

在项目目录运行 npm install @cypress/env-or-json-file，或使用 pnpm add / yarn add / bun add。

### @cypress/env-or-json-file 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cypress\_\_env-or-json-file 是否存在。

### @cypress/env-or-json-file 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cypress/env-or-json-file 需要什么版本的 Node\.js？

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

### @cypress/env-or-json-file 可以商用吗？

@cypress/env-or-json-file 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cypress/env-or-json-file 的下载量有多少？

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

### @cypress/env-or-json-file 还在维护吗？

最新版本 2\.0\.0 发布于 2017/10/31（9 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2017/07/13。作者已将其标记为弃用，新项目建议寻找替代方案。