@griffel/jest-serializer

中文文档
1.1.43发布于 2026/09/23MITTypeScriptCommonJS近 30 天下载 8112

Jest serializer for Griffel

原始使用文档
文档目录5 节
  1. Install
  2. Setup
  3. Overview
  4. Asserting styles
  5. Documentation

@griffel/jest-serializer

A snapshot serializer that removes class names generated by Griffel from snapshots.

Despite its name, it works with both Jest and Vitest.

Install

yarn add --dev @griffel/jest-serializer
# or
npm install --save-dev @griffel/jest-serializer

Setup

Jest

// jest.config.js
module.exports = {
  snapshotSerializers: ['@griffel/jest-serializer'],
};

Vitest

// vitest.config.ts
import { defineConfig } from 'vitest/config';

export default defineConfig({
  test: {
    snapshotSerializers: ['@griffel/jest-serializer'],
  },
});

Alternatively, register it from a setup file:

// vitest.setup.ts
import { expect } from 'vitest';
import { print, test } from '@griffel/jest-serializer';

expect.addSnapshotSerializer({ print, test });

Overview

Griffel generates atomic class names by hashing style declarations, so a component renders as:

<div class="static-class ___1t65jhk_nkb4zh0 fe3e8s9 frdkuqy">Hello world</div>

These hashes are an implementation detail: changing an unrelated style or upgrading Griffel can change them and invalidate every snapshot that captured them. With this serializer they are removed, and only markup that you wrote is left:

<div class="static-class">Hello world</div>

Classes from both makeStyles() and makeResetStyles() are removed, any other class name is kept.

Asserting styles

As the serializer removes the class names, snapshots no longer describe which styles were applied. Assert them directly with toHaveStyle() from @testing-library/jest-dom:

render(<Component />);

expect(screen.getByTestId('element')).toHaveStyle({
  color: 'rgb(255, 0, 0)',
  paddingLeft: '10px',
});

It reads computed styles from the document, so it covers shorthands, RTL flipping and overrides from mergeClasses().

Documentation

See Snapshot testing for the full guide, including how to get slot names into snapshots.

版本与发布记录

@griffel/jest-serializer 共发布 58 个版本,首次发布于 2022/01/24;过去 12 个月发布了 9 个版本。

版本发布日期距今
1.1.43latest2026/09/231 个月前
1.1.422026/07/034 个月前
1.1.412026/05/215 个月前
1.1.402026/05/215 个月前
1.1.392026/05/046 个月前
1.1.382026/04/306 个月前

关于 @griffel/jest-serializer 的常见问题

@griffel/jest-serializer 是什么?

Jest serializer for Griffel

如何安装 @griffel/jest-serializer?

在项目目录运行 npm install @griffel/jest-serializer,或使用 pnpm add / yarn add / bun add。

@griffel/jest-serializer 支持 TypeScript 吗?

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

@griffel/jest-serializer 支持 ESM 还是 CommonJS?

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

@griffel/jest-serializer 可以商用吗?

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

@griffel/jest-serializer 的下载量有多少?

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

@griffel/jest-serializer 还在维护吗?

最新版本 1.1.43 发布于 2026/09/23(1 个月前);至今共发布 58 个版本,其中过去 12 个月发布了 9 个;首次发布于 2022/01/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。