@glasshouse/style-guide

中文文档
1.1.2发布于 2025/03/21MITTypeScriptCommonJS近 30 天下载 4490

Glasshouse的工程风格指南

中文使用文档
文档目录9 节
  1. 安装
  2. 高级
  3. ESLint 语录
  4. 配置( 新: eslint. config.js)
  5. 配置( legacy:.eslintrc *)
  6. 为 TypeScript 配置 ESLint( 新: eslint. config.js)
  7. 为 TypeScript 配置 ESLint( legacy:.eslintrc *)
  8. 类型脚本
  9. 样式林

GVSStack

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

现有配置如下:

安装

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

# 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

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

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

ESLint 语录

:information source:ESLint是此软件包的对等依赖性,应该安装在您项目的根上.

见: 以 ESLint - ESLint - 插件 JavaScript Linter 启动

配置( 新: eslint. config.js)

: 警告: 破坏变化数字 :

  • ESLint 最小版本现在 9.0.0。 。 。 .
  • 使用新的平面配置重构配置 格式。 。 。 .
  • 将所有配置移至单个对象默认导出 。 您现在可以通过下面的例子导入新的平面配置 .
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 (需要安装和 额外配置(中文(简体) )

例如,在 Next.js 项目中使用共享的 ESLint 配置,设置如下 eslint.config.js (或任何其他ESLint系统) 配置文件格式:

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 将安装和 额外配置。 。 。 .

现有配置如下:

  • @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) (中文(简体) ).

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

/** @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 页面存档备份,存于互联网档案馆

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

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

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。 。 。 .

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

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

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

样式林

:inform source:Stylelint是此软件包的对等依赖性,应该安装在您工程的根上.

见: 样式林

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

要使用此配置, 请在 stylelint.config.mjs (或任何其他斯德林特语) 配置文件格式:

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

版本与发布记录

@glasshouse/style-guide 共发布 21 个版本,首次发布于 2024/07/25;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.2latest2025/03/211.7 年前
1.1.12025/03/091.7 年前
1.1.02025/03/091.7 年前
1.0.82025/03/091.7 年前
1.0.52025/03/061.7 年前
1.0.42024/12/201.9 年前

关于 @glasshouse/style-guide 的常见问题

@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 和提交记录判断。