@harperfast/代码指南
这个寄存器包含了哈珀组织的代码指南工具和配置.
目前导出Pretier,ESLint和TS节点类型检查的共享配置. 不久将增加更多的工具.
快速启动
-
npm i --save-dev @harperfast/code-guidelines -
添加
"prettier": "@harperfast/code-guidelines/prettier"改为 软件包.json。 。 。 . -
运行
npx prettier .
格式化
我们用 高级 用于格式化。 默认配置导出于 /prettier 路径(即:. @harperfast/code-guidelines/prettier) (中文(简体) ).
评议 共享配置 文档,以了解如何使用或扩展基础配置.
线性
我们用 ESLint 语录 用于执行代码质量,并整合Pretier格式化。 默认配置导出于 /eslint 路径(即:. @harperfast/code-guidelines/eslint) (中文(简体) ).
使用 Harper ESLint 配置
您必须创建本地的 ESLint 配置, 导入 Harper 的 ESLint 配置, 然后您可以通过添加自己的规则来扩展或覆盖基础配置 .
关于扩展配置的更详细资料,请参见: ESLint 配置文件文档。 。 。 .
- 安装所需的依赖性 :
npm i --save-dev @harperfast/code-guidelines eslint prettier
- 创建一个
eslint.config.mjs在工程根中的文件 :
import harperConfig from '@harperfast/code-guidelines/eslint';
import { defineConfig } from 'eslint/config';
export default defineConfig([
...harperConfig,
// Your custom configuration here
{
rules: {
// Override or add custom rules
},
},
]);
- 运行 ESLint :
npx eslint .
类型检查
TypeScript 配置文件在 /tsconfig 导出路径并可用于此 extends 个人财产 tsconfig.json 文档.
例如,要使用基础节点.js配置(支持节点.js v20或后期):
- 从安装必要的依赖性开始 :
npm i --save-dev typescript @types/node@20 @harperfast/code-guidelines
- 然后创建一个
tsconfig.json文件中包含以下内容:
{
"extends": "@harperfast/code-guidelines/tsconfig.node.json",
"compilerOptions": {
// Your custom options here
}
}
- 最后,使用TypeScript或Node.js Type脱发!
npx tsc
# or
node src/index.ts
配置基于受欢迎 tsconfig 基础 项目.
以下列表概述了可用的配置:
tsconfig.node.json- 节点.js v20 或以后有节点.js 类型剥取支持- 马上就要来了!
添加新配置
要添加新的类型脚本配置 :
- 在此寄存器中创建新文件
tsconfig.结尾.json介于两者之间的名称应是对环境或相关版本的描述(例如:.tsconfig.react.json或者说tsconfig.node-24.json) (中文(简体) ). - 更新
exports输入package.json包含使用与文件相同名称的新配置文件. - 以简记入上表.
- 飞船