# @edx/stylelint-config-edx 中文文档

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

版本：2\.3\.3
npm 元数据更新时间：2026-07-10T14:29:55.809Z
中文译文更新时间：2026-11-13T07:49:52.388Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：14.8 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2017-09-11T21:57:13.747Z
- 最新版本发布：2023-10-25T16:36:54.831Z
- 近 30 天下载量：13532（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

EdX Sass 文件的样式林特配置 .

## 安装

```sh
npm install @edx/stylelint-config-edx
```

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

## README

# 打开 edX 样式lint 配置

[![Build Status](https://github.com/openedx/stylelint-config-edx/workflows/Node%20CI/badge.svg?branch=master)](https://github.com/openedx/stylelint-config-edx/actions?query=workflow%3A%22Node+CI%22)

# 目的

用于 Open edX Sass 文件的样式林特配置 .

## 目录

-   [打开 edX 样式lint 配置](https://npmcn.com/package/%40edx/stylelint-config-edx/#readme-open-edx-stylelint-configs)
-   [目的](https://npmcn.com/package/%40edx/stylelint-config-edx/#readme-purpose)
    -   [目录](https://npmcn.com/package/%40edx/stylelint-config-edx/#readme-table-of-contents)
    -   [概览](https://npmcn.com/package/%40edx/stylelint-config-edx/#readme-overview)
    -   [许可证](https://npmcn.com/package/%40edx/stylelint-config-edx/#readme-license)
    -   [使用量](https://npmcn.com/package/%40edx/stylelint-config-edx/#readme-usage)
    -   [Sass 样式指南](https://npmcn.com/package/%40edx/stylelint-config-edx/#readme-sass-style-guide)

## 概览

为了将 Open edX 的 Sass 编码样式标准化并加以强制化 多个代码库,Open edX已经采用了Stylelint. 此软件包提供 由 Open edX 开发社区定义的规则.

## 许可证

此寄存器中的代码根据 Apache 2. 0 许可发布 除非另有说明。 请看 [自由主义 文件](https://github.com/openedx/stylelint-config-edx/blob/master/LICENSE) 详细情况.

## 使用量

要在代码库中开始使用 Open edX Stylelint 配置, 请安装此 npm 软件包 :

```
npm install --save-dev @edx/stylelint-config-edx
```

然后,配置您的工程的 Stylelint 配置以扩展 `stylelint-config-edx` (见ESLint文件) 打开 [使用可共享工具 配置](https://stylelint.io/user-guide/configuration/#extends)) (中文(简体) ).

最简单的选项是将以下内容添加到文件中 `stylelint.config.js` 位于您的仓库根部 :

```
module.exports = {
  extends: '@edx/stylelint-config-edx'
};
```

## Sass 样式指南

Open edX 大多遵循所推荐的SCSS规则定义 编辑 [样式lint- 配置- 建议- scs 软件包](https://www.npmjs.com/package/stylelint-config-recommended-scss)。 。 。 .

唯一的变化是下列规则被禁用:

-   [函数-comma-新行后](https://stylelint.io/user-guide/rules/function-comma-newline-after/)
-   [函数-亲和-新线-内置](https://stylelint.io/user-guide/rules/function-parentheses-newline-inside/)
-   [最大空行数](https://stylelint.io/user-guide/rules/max-empty-lines/)

## 常见问题

### @edx/stylelint-config-edx 是什么？

EdX Sass 文件的样式林特配置 \.

### 如何安装 @edx/stylelint-config-edx？

在项目目录运行 npm install @edx/stylelint-config-edx，或使用 pnpm add / yarn add / bun add。

### @edx/stylelint-config-edx 支持 TypeScript 吗？

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

### @edx/stylelint-config-edx 支持 ESM 还是 CommonJS？

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

### @edx/stylelint-config-edx 可以商用吗？

@edx/stylelint-config-edx 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @edx/stylelint-config-edx 的下载量有多少？

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

### @edx/stylelint-config-edx 还在维护吗？

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