# @glasshouse/style-guide 中文文档

规范地址：https://npmcn.com/package/%40glasshouse/style-guide/

版本：1\.1\.2
npm 元数据更新时间：2026-03-18T07:33:20.779Z
中文译文更新时间：2026-11-16T15:33:22.641Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40glasshouse/style-guide
原文对照：https://npmcn.com/package/%40glasshouse/style-guide/?lang=original
项目主页：https://github.com/GlasshouseVentureStudio/glasshouse-stack/tree/main/packages/style-guide
源码仓库：https://github.com/GlasshouseVentureStudio/glasshouse-stack#main

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

- 包体积（解压后）：57 kB，35 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：37 个
- peer 依赖：typescript \>=5\.8\.2，eslint-config-turbo \>=2\.4\.4，eslint-config-prettier \>=10\.1\.1，@next/eslint-plugin-next \>=15\.2\.1，@typescript-eslint/parser \>=8\.26\.0，prettier-plugin-sort-json \>=4\.1\.1，stylelint-config-standard \>=37\.0\.0，prettier-plugin-packagejson \>=2\.5\.10，prettier-plugin-tailwindcss \>=0\.6\.11，eslint-plugin-react-compiler \>=19\.0\.0-beta-37ed2a7-20241206，stylelint-config-css-modules \>=4\.4\.0，@tanstack/eslint-plugin-query \>=5\.67\.2，stylelint-config-recess-order \>=6\.0\.0，stylelint-config-prettier-scss \>=1\.0\.0，stylelint-config-standard-scss \>=14\.0\.0，@typescript-eslint/eslint-plugin \>=8\.26\.0，eslint-plugin-simple-import-sort \>=12\.1\.1，stylelint-config-sass-guidelines \>=12\.1\.0
- 首次发布：2024-07-25T09:20:43.006Z
- 最新版本发布：2025-03-21T02:46:11.887Z
- 近 30 天下载量：4490（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 0 个）

## 中文简介

Glasshouse的工程风格指南

## 安装

```sh
npm install @glasshouse/style-guide
```

也可以使用：`pnpm add @glasshouse/style-guide`、`yarn add @glasshouse/style-guide`、`bun add @glasshouse/style-guide`

## README

# ![GVSStack](https://npmcn.com/package/%40glasshouse/style-guide/gvs-style-guide.svg)

此寄存器包括用于受欢迎的林入和造型工具的配置, 扩展自 `@vercel/style-guide`。见 [Vercel 风格指南](https://github.com/vercel/style-guide)。 。 。 .

现有配置如下:

-   [ESLint 语录](https://npmcn.com/package/%40glasshouse/style-guide/#readme-eslint)
-   [类型脚本](https://npmcn.com/package/%40glasshouse/style-guide/#readme-typescript)
-   [高级](https://npmcn.com/package/%40glasshouse/style-guide/#readme-prettier)
-   [样式林](https://npmcn.com/package/%40glasshouse/style-guide/#readme-stylelint)

## 安装

所有配置都包含在一个包中, `@glasshouse/style-guide`要安装 :

```sh
# If you use npm
npm i --save-dev @glasshouse/style-guide

# If you use pnpm
pnpm i --save-dev @glasshouse/style-guide

# If you use Yarn
yarn add --dev @glasshouse/style-guide
```

## 高级

> 注意: Pretier 是此软件包的对等依赖性, 应当安装在您的工程的根上 . 见: [安装 · prettier](https://prettier.io/docs/en/install)

要使用共享的 Pretier 配置, 请设置如下 `package.json`数字 :

```
{
  "prettier": "@glasshouse/style-guide/prettier"
}
```

## ESLint 语录

> :information source:ESLint是此软件包的对等依赖性,应该安装在您项目的根上.
> 
> 见: [以 ESLint - ESLint - 插件 JavaScript Linter 启动](https://eslint.org/docs/latest/use/getting-started)

### 配置( 新: eslint. config.js)

> : 警告: **破坏变化**数字 :
> 
> -   ESLint 最小版本现在 `9.0.0`。 。 。 .
> -   使用新的平面配置重构配置 [格式](https://eslint.org/blog/2022/08/new-config-system-part-2/#main)。 。 。 .
> -   将所有配置移至单个对象默认导出 。 您现在可以通过下面的例子导入新的平面配置 .
> 
> ```js
> import gvseslint from '@glasshouse/style-guide/eslint
> 
> export default [
>   ...gvseslint.configs.flat.node,
> ]
> ```

> :信息 来源:这些ESLint配置基于 `@vercel/style-guide/eslint`

现有配置如下:

-   `browser`
-   `node`
-   `next` (所需经费) `@next/eslint-plugin-next` 将安装在与 `next`(中文(简体) )
-   `react`
-   `typescript` (需要安装和 [额外配置](https://npmcn.com/package/%40glasshouse/style-guide/#readme-configuring-eslint-new-eslintconfigjs-for-typescript)(中文(简体) )

例如,在 Next.js 项目中使用共享的 ESLint 配置,设置如下 `eslint.config.js` (或任何其他ESLint系统) [配置文件格式](https://eslint.org/docs/latest/use/configure/configuration-files):

```js
import gvseslint from '@glasshouse/style-guide/eslint';

/** @type {import('eslint').Linter.Config[]} */
export default [
    ...gvseslint.configs.flat.browser,
    ...gvseslint.configs.flat.react,
    ...gvseslint.configs.flat.typescript,
    ...gvseslint.configs.flat.next,
    // ...
];
```

### 配置( legacy:.eslintrc \*)

> :警告:这只与0.3.1版本或更早的软件包兼容. 最新版本(1.0.0)引入了断开更改,这些更改不支持.

所有配置都需要 `typescript` 将安装和 [额外配置](https://npmcn.com/package/%40glasshouse/style-guide/#readme-configuring-eslint-legacy-eslintrc-for-typescript)。 。 。 .

现有配置如下:

-   `@glasshouse/style-guide/eslint/base`
-   `@glasshouse/style-guide/eslint/library`
-   `@glasshouse/style-guide/eslint/react`
-   `@glasshouse/style-guide/eslint/next` (所需经费) `@next/eslint-plugin-next` 将安装在与 `next`(中文(简体) )

> :信息 来源:您需要使用 `require.resolve` 向ESLint提供绝对路径,因为ESLint配置解析度存在问题(参见 [斯林特/斯林特#9188](https://github.com/eslint/eslint/issues/9188)) (中文(简体) ).

例如,使用 `@glasshouse/style-guide/eslint/next` 在下一个.js项目中,设置如下: `.eslintrc.js` (或任何其他 ESLint 配置文件格式):

```js
/** @type {import('eslint').Linter.Config} */
module.exports = {
    extends: [require.resolve('@glasshouse/style-guide/eslint/next')],
};
```

### 为 TypeScript 配置 ESLint( 新: eslint. config.js)

在 TypeScript 配置中启用的一些规则需要额外的类型信息, 您需要提供您的路径 `tsconfig.json`。 。 。 .

更多信息见: [https://typescript-eslint.io/getting-started/typed-linting 页面存档备份,存于互联网档案馆](https://typescript-eslint.io/getting-started/typed-linting)

```js
export default [
    //...,
    ...gvseslint.configs.flat.typescript,
    {
        languageOptions: {
            parserOptions: {
                projectService: true,
                tsconfigRootDir: import.meta.dirname,
            },
        },
    },
];
```

### 为 TypeScript 配置 ESLint( legacy:.eslintrc \*)

```js
const { resolve } = require('node:path');

const project = resolve(__dirname, 'tsconfig.json');

module.exports = {
    root: true,
    extends: [require.resolve('glasshouse/style-guide/eslint/next')],
    parserOptions: {
        project,
    },
    settings: {
        'import/resolver': {
            typescript: {
                project,
            },
        },
    },
};
```

## 类型脚本

此样式指南为不同的项目类型提供了多款TypeScript配置.

要使用共享类型脚本配置, 请设置如下 : `tsconfig.json`。 。 。 .

```json
{
    "extends": "@glasshouse/style-guide/typescript/react-library"
}
```

基础 TypeScript 配置也可以作为 `@glasshouse/style-guide/typescript` 它只规定了一套一般规则:

```json
{
    "extends": "@glasshouse/style-guide/typescript"
}
```

## 样式林

> :inform source:Stylelint是此软件包的对等依赖性,应该安装在您工程的根上.
> 
> 见: [样式林](https://stylelint.io/user-guide/get-started)

此样式指南提供了共享的Stylelint配置,并附有扩展的SCSS/SASS林克规则支持.

要使用此配置, 请在 `stylelint.config.mjs` (或任何其他斯德林特语) [配置文件格式](https://stylelint.io/user-guide/configure/):

```js
/** @type {import('stylelint').Config} */
export default {
    extends: ['@glasshouse/style-guide/stylelint'],
};
```

## 常见问题

### @glasshouse/style-guide 是什么？

Glasshouse的工程风格指南

### 如何安装 @glasshouse/style-guide？

在项目目录运行 npm install @glasshouse/style-guide，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（\>=5\.8\.2）、eslint-config-prettier（\>=10\.1\.1）、@typescript-eslint/parser（\>=8\.26\.0）、prettier-plugin-sort-json（\>=4\.1\.1）、stylelint-config-standard（\>=37\.0\.0）、prettier-plugin-packagejson（\>=2\.5\.10）、prettier-plugin-tailwindcss（\>=0\.6\.11）、eslint-plugin-react-compiler（\>=19\.0\.0-beta-37ed2a7-20241206）、stylelint-config-css-modules（\>=4\.4\.0）、stylelint-config-recess-order（\>=6\.0\.0）、@typescript-eslint/eslint-plugin（\>=8\.26\.0）、eslint-plugin-simple-import-sort（\>=12\.1\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @glasshouse/style-guide 支持 TypeScript 吗？

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

### @glasshouse/style-guide 支持 ESM 还是 CommonJS？

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

### @glasshouse/style-guide 可以商用吗？

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

### @glasshouse/style-guide 的下载量有多少？

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

### @glasshouse/style-guide 还在维护吗？

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

