# @charlie-labs/config 中文文档

规范地址：https://npmcn.com/package/%40charlie-labs/config/

版本：0\.0\.17
npm 元数据更新时间：2026-05-20T03:16:19.083Z
中文译文更新时间：2026-11-09T10:54:02.490Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：23.1 kB，9 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：11 个
- peer 依赖：eslint \>= 9，prettier \>= 3，typescript \>= 5
- 首次发布：2025-09-18T23:57:27.021Z
- 最新版本发布：2025-11-21T18:27:17.734Z
- 近 30 天下载量：3752（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 1 个）

## 中文简介

Charlie Lab 类型脚本项目的共享配置

## 安装

```sh
npm install @charlie-labs/config
```

也可以使用：`pnpm add @charlie-labs/config`、`yarn add @charlie-labs/config`、`bun add @charlie-labs/config`

## README

# @charlie-labs/ 配置

标准化的TypeScript,ESLint,以及Charlie Lab的TypeScript项目的Pretier配置.

这为什么存在?

1.  整个Charlie Labs项目的一致和熟悉的配置
2.  每个项目减少配置锅炉板
3.  缩短持续更新和同步配置的时间

## 使用量

### 1\. 附加依赖

安装 `@charlie-labs/config` 是一个非常依赖.

### 2\. 配置Pretier

将以下行添加到您的 `package.json`数字 :

```json
  "prettier": "@charlie-labs/config/prettier",
```

### 3\. 配置ESLint

创建一个 `eslint.config.js` 在工程根中的文件 :

```js
import { config } from '@charlie-labs/config/eslint';

/** @type {import("eslint").Linter.Config[]} */
export default [...config];
```

### 4\. 配置类型脚本

创建一个 `tsconfig.json` 扩展的根中的文件 `@charlie-labs/config/tsconfig-node` 或者说 `@charlie-labs/config/tsconfig-react`。您仍然需要指定 `includes` 和任何 `compilerOptions` 您想要添加或覆盖.

```jsonc
{
  "extends": "@charlie-labs/config/tsconfig-node",
  "include": ["src"],
  "exclude": ["**/node_modules", "**/.*/"],
  "compilerOptions": {
    // Add or override compiler options here
  },
}
```

### 5\. 添加类型脚本重置

这只是一个方便的导出 [`@total-typescript/ts-reset`](https://www.totaltypescript.com/ts-reset)。 。 。 .

## 发行和出版

此 repo 设置在合并到默认分支时自动 plash to npm (当前) `master`通过 GitHub 动作。 你只需要撞出版本 并合并一个公关.

1.  创建分支并按下版本 `package.json` 不创建 git 标签 :
    
    ```bash
    # pick one: patch | minor | major | or an explicit version
    npm version patch --no-git-tag-version
    # or: npm version 0.0.13 --no-git-tag-version
    ```
    
2.  提交更改并打开 PR 。 将PR限制在版本的凸起和描述中想要的任何发布注释.
    
3.  当 PR 合并到默认分支时,工作流程 : `.github/workflows/release.yml` 将:
    
    -   运行类型检查和 ESLint
    -   如果版本是新版本, 则发布到 npm( 需要) `NPM_TOKEN`(中文(简体) )
    -   创建带有生成注释的 GitHub 释放

注释:

-   不要手动推动 git 标记; 工作流程在 GitHub 发布步骤中创建标记 .
-   如果没有新的版本(即:, `package.json` 没有改变, 发布步骤被跳过, 没有创建发布 .
-   发布步骤跳过 npm 生命周期脚本; 输入检查和 lint 在工作流程中明确运行 .

### gitHub 工作流程 npm 认证

要从 GitHub 动作中发布到 npm, 请添加 npm 访问令牌, 作为一个命名为 的秘密 `NPM_TOKEN`数字 :

1.  在 npm 账户设置中创建 npm 访问令牌, 并至少有“ publish” 权限 .
2.  在此寄存器的设置中 ~ 秘密和变量 ~ 动作, 添加一个新的寄存器密钥, 命名为 `NPM_TOKEN` 与该标志值。 一个组织的秘密也起作用了.
3.  不需要其他的 - 我们的发布工作流程已经:
    -   请求 `id-token: write` npm出处支持,以及
    -   用途 `actions/setup-node@v4` 在发布时提供 npm 版本.

如果您在 npm 上强制使用“ 要求出处” , 则已存在的 `provenance: true` 在发布步骤上输入可以满足.

## 常见问题

### @charlie-labs/config 是什么？

Charlie Lab 类型脚本项目的共享配置

### 如何安装 @charlie-labs/config？

在项目目录运行 npm install @charlie-labs/config，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：eslint（\>= 9）、prettier（\>= 3）、typescript（\>= 5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @charlie-labs/config 支持 TypeScript 吗？

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

### @charlie-labs/config 支持 ESM 还是 CommonJS？

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

### @charlie-labs/config 可以商用吗？

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

### @charlie-labs/config 的下载量有多少？

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

### @charlie-labs/config 还在维护吗？

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