此寄存器包括用于受欢迎的林入和造型工具的配置, 扩展自 @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. config.js)
: 警告: 破坏变化数字 :
- ESLint 最小版本现在
9.0.0。 。 。 .- 使用新的平面配置重构配置 格式。 。 。 .
- 将所有配置移至单个对象默认导出 。 您现在可以通过下面的例子导入新的平面配置 .
import gvseslint from '@glasshouse/style-guide/eslint export default [ ...gvseslint.configs.flat.node, ]
:信息 来源:这些ESLint配置基于
@vercel/style-guide/eslint
现有配置如下:
browsernodenext(所需经费)@next/eslint-plugin-next将安装在与next(中文(简体) )reacttypescript(需要安装和 额外配置(中文(简体) )
例如,在 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'],
};