@celljs/style-guide v3.6.4

The Cell Style Guide

介绍

本项目是 CellJS 风格指南的所在地，其中包括以下配置：

• Prettier
• ESLint
• TypeScript

安装

我们的所有配置都包含在一个包@celljs/style-guide中。安装命令如下：

# If you use npm
npm i --save-dev @celljs/style-guide

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

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

我们的一些 ESLint 配置需要 peer 依赖。具体内容可以查看 ESLint。

Prettier

注意：Prettier 是此软件包的对等依赖项，应安装 在项目的根目录下。

请参阅：https://prettier.io/docs/en/install.html

要使用共享 Prettier 配置，请在 package.json 中设置以下内容。

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

ESLint

注意：ESLint 是此软件包的 peer 依赖项，应安装 在项目的根目录下。

请参阅：https://eslint.org/docs/user-guide/getting-started#installation-and-usage

此 ESLint 配置被设计为可组合的。

以下基本配置可用。您可以使用其中之一或两者 配置，但它们应该始终位于 extends 中的第一个：

• @celljs/style-guide/eslint/base
• @celljs/style-guide/eslint/errors

请注意，您可以设置配置范围，以便配置仅针对特定文件。 有关更多信息，请参阅：使用覆盖的范围配置。

以下附加配置可用：

• @celljs/style-guide/eslint（所有配置）
• @celljs/style-guide/eslint/base （基础配置）
• @celljs/style-guide/eslint/errors（错误级别的配置）
• @celljs/style-guide/eslint/build（构建级别的配置，包括基础和错误级别的配置）
• @celljs/style-guide/eslint/warnings（警告级别的配置）
• @celljs/style-guide/eslint/xxs（跨站脚本攻击相关的配置）

您需要使用 require.resolve 为 ESLint 提供绝对路径， 由于围绕 ESLint 配置解析的问题（请参阅 eslint/eslint#9188。

例如，一个简单的项目复用 ESLint 配置，配置如下

module.exports = {
  extends: [
    require.resolve('@celljs/style-guide/eslint')
  ]
};

当然，也可以更具情况选择具体级别的一个或多个配置。

如果是一个纯 javascript 项目，配置如下：

module.exports = {
  extends: [
    require.resolve('@celljs/style-guide/eslint/javascript')
  ]
};

使用 overrides 进行范围配置

ESLint 配置的范围可以包括或者排除特定路径。这确保了 规则不会渗透到那些规则不适用的地方。

在此示例中，Jest 规则仅应用于与 Jest 匹配的文件 的默认测试匹配模式。

module.exports = {
  extends: [require.resolve('@celljs/style-guide/eslint')],
  overrides: [
    {
      files: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'],
      extends: [require.resolve('@celljs/style-guide/eslint/jest')],
    },
  ],
};

关于文件扩展名的说明

默认情况下，所有 TypeScript 规则的范围仅限于以 .ts 和 .tsx 结尾的文件。

但是，当使用覆盖功能时，必须包含文件扩展名，否则 ESLint 将 只包含 .js 文件。

module.exports = {
  overrides: [
    { files: [`directory/**/*.[jt]s?(x)`], rules: { 'my-rule': 'off' } },
  ],
};

TypeScript

要使用共享 TypeScript 配置，请在 tsconfig.json 中设置以下内容。

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