# @artsy/cohesion 中文文档

规范地址：https://npmcn.com/package/%40artsy/cohesion/

版本：4\.420\.0
npm 元数据更新时间：2026-11-04T11:34:39.350Z
中文译文更新时间：2026-11-06T21:21:45.058Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：920 kB，283 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2020-04-14T18:14:27.232Z
- 最新版本发布：2026-11-04T11:34:39.140Z
- 近 30 天下载量：39747（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：710（近 12 个月 130 个）

## 中文简介

分析计划

## 安装

```sh
npm install @artsy/cohesion
```

也可以使用：`pnpm add @artsy/cohesion`、`yarn add @artsy/cohesion`、`bun add @artsy/cohesion`

## README

## 团结 [![CircleCI](https://circleci.com/gh/artsy/cohesion.svg?style=svg)](https://circleci.com/gh/artsy/cohesion) [![npm version](https://badge.fury.io/js/%40artsy%2Fcohesion.svg)](https://www.npmjs.com/package/@artsy/2Fcohesion)

### Artsy的分析计划

-   **状态 :** 发展中
-   **GitHub : (中文(简体) )** [https://github.com/artsy/cohesion (英语)](https://github.com/artsy/cohesion)
-   **文档 :** [https://cohesion.artsy.net (中文(简体) )](https://cohesion.artsy.net/)
-   **锡族**数字 : [https://circleci.com/gh/artsy/cohesion (英语)](https://circleci.com/gh/artsy/cohesion)
-   **[国家预防机制](https://www.npmjs.com/package/@artsy/cohesion)数字 :** 软件包的更新在成功与主机合并时自动发布. 加那利在PR上可以从特色分支获得.
-   **点数人**数字 : [韩德](https://github.com/xander-pero), (中文(简体) ), [穆尼尔](https://github.com/MounirDhahri)

## 捐款

所需经费: [雅伦](https://classic.yarnpkg.com/en/docs/install/#mac-stable)

#### 设置 :

```
yarn install
```

#### 运行测试 :

```
yarn test
```

#### 生成文件 :

```
yarn docs
```

要在本地查看文件, 请访问全部文件路径 `docs/index.html` 在浏览器中,即, `file:///Users/<MY_USER>/<MY_LOCAL_DIRECTORY>/cohesion/doc/index.html`

## 司马

这个 `/Schema` 目录代表了Arthy的分析方案,并描述了对Redshift和September所消耗数据的期望.

这个计划由Artsy的数据团队维护,工程师不应该期望会更改这些文件.

有效分析事件描述于 `/Schema/Events/index.ts`和单个事件计划 `Schema/Events` 目录, 由关切分隔 .

全部允许的值的打字, 如 `ContextModule`,出口给工程师用于消耗项目.

### 添加新事件到计划( 用于数据分析)

1.  单位 `Schema/Events`,添加新事件的名称。 这个名称定义了Redshift中相应的下游表的名称,并且应该使用 [`lowerCamelCase`](https://wiki.c2.com/?LowerCamelCase) 命名大会.

```typescript
// Schema/Events/index.ts

export enum ActionType {
  ...
  myNewEvent = "myNewEvent",
  ...
}

```

2.  单位 `Schema/Events` 目录,创建新的界面,描述新事件的形状,因为它是在部分/红移中接收的.

-   界面名称应当匹配 `ActionType` 在步骤1中创建,但使用 [`UpperCamelCase`](https://wiki.c2.com/?UpperCamelCase) 命名大会.
-   这个 `action` 键需要,并且应当匹配 `ActionType` 在步骤1中创建.
-   如果您的事件使用了尚未在计划中使用的值, 如新 `ContextModule`,将新值添加到Schema目录中的现有打字.

```typescript
// Schema/Events/MyNewEvent.ts

export interface MyNewEvent {
  action: ActionType.myNewEvent
  context_module: ContextModule
  optional_property?: string
  required_property: number
}
```

3.  单位 `Schema/Events/index.ts`,在有效事件主列表中添加新界面, `Event`
    
4.  添加带有示例的描述性注释来解释您新事件的用途 。 我们的文档是从编码注释中自动生成的,请在 [`typedoc` 文档](https://typedoc.org/guides/doccomments)。 。 。 .
    
5.  如果您创建了任何新文件,请向 `Schema/index.ts` 像这样:
    

```typescript
// Schema/index.ts

export * from "./Events/MyNewEvent"
```

6.  公关你的变化。 合并后, 将更新计划, 您的新事件和值将提供给此套件的消费者 .

## 常见问题

### @artsy/cohesion 是什么？

分析计划

### 如何安装 @artsy/cohesion？

在项目目录运行 npm install @artsy/cohesion，或使用 pnpm add / yarn add / bun add。

### @artsy/cohesion 支持 TypeScript 吗？

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

### @artsy/cohesion 支持 ESM 还是 CommonJS？

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

### @artsy/cohesion 可以商用吗？

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

### @artsy/cohesion 的下载量有多少？

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

### @artsy/cohesion 还在维护吗？

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