@ cosyte/ slint- config
一家工厂的Cosyte林特酒吧呼叫:没有
any没有无证的公开出口,没有漂移.
共享 ESLint 平面配置( ESLint 10 + typescript- eslint) 为 @ cosyte/ * 包.
为什么会这样
医护人员的规则不是风格偏好. no-explicit-any 和铸造规则是
关于田地类型的说法不能是猜测 公共出口的JSDoc门
保存一个已公布的API的运输文件。 每个寄存器复制后 规则就会放松
在当地解禁释放 保持放松.
最近的选择是 eslint-config-airbnb 或手卷平面配置每回波。 也没有
编码 Cosyte 规则, 既不关闭漂移: 这是已公布的软件包, 所以添加了一条规则
每一个消费者都在这里,作为一个版本的起落.
状态
@cosyte/eslint-config 位于Cosyte 0.1.x线上:公共API被安顿下来,凸起类型跟随普通semver.
工厂的签名 cosyte(tsconfigRootDir, opts?) 正在定居,但背后的欧盟驻科法治团是
而不是: 规则是随着解析器发现漏洞而添加的, 因此一个版本的凸起可以将一个消费者红色
刚经过 如果您需要插图运行以保持绿色, 请按精确的版本 .
安装
pnpm add -D @cosyte/eslint-config eslint typescript
eslint (^9或^10)和 (中文(简体) ) typescript 是同伴的依赖关系。 节点 >=22.22.2,哪个
eslint-plugin-jsdoc 65个要求。 仅限无害环境管理.
使用量
eslint.config.js 导出工厂返回的阵列 :
import cosyte from "@cosyte/eslint-config";
const config = cosyte(import.meta.dirname);
Array.isArray(config); // => true
理由是 tsconfigRootDir: 持有 tsconfig.json 类型检查规则
反对,这就是为什么 import.meta.dirname 是正常值。 林特在
--max-warnings=0,这是每个 @cosyte/* 转帐 lint 脚本通过.
入境点
| 进入点 | 这是什么 |
|---|---|
@cosyte/eslint-config | 默认导出 cosyte(tsconfigRootDir, opts?),一个平面配置阵列工厂 |
一个入口,所以 @cosyte/eslint-config 是消费者唯一写过的文章.
覆盖
第二个论点是整个覆盖表面: opts.ignores 附录忽略了光彩, opts.files
替换用于打字规则的缩写,以及 opts.library 放弃JSDoc, @example
财务报告和审定财务报表 no-console 申请的大门。 这个 API 密码 下方写着每个人的默认值.
每类安全规则(无) any没有不合理的铸造、详尽无遗、严格的进口)
无论是哪种方式。 应用程序没有公布的 API 表面来记录和合法日志;没有
许可证,以降低类型安全性,因此不能通过 opts 一点也不 追加您的
工厂阵列之后的自己配置对象是ESLint自己的逃生舱门,这里什么也阻止不了
但是一条规则关闭了这条路 在一个回扣中关闭了 而每个兄弟仍然执行
这个 换个版本来换.
PHI 与安全
此软件包是 Lint 配置 。 它读取源文件 检查它们,并且永远不会执行它们 它看不到病人的数据: 这里没有记录、保留或传输任何东西.
规则确实有安全意图 值得命名. no-console 在图书馆代码中不是tidiness,它是
是什么使解析器无法打印它交给的字段, 和类型安全规则是保持一个
PHI 字段从被丢入到编译器停止检查的东西中。 门其实
病人数据的扫描是 @cosyte/script-utils/phi-scan而不是这个包裹.
API 密码
工厂是 cosyte(tsconfigRootDir, opts?)数字 :
opts.ignores: 额外忽略了光彩.opts.files: 覆盖所检查的字型规则适用于哪个(默认为src编号 :test编号 :scripts编号 :*.config.ts) (中文(简体) ).opts.library: 默认为true设置false用于 应用程序 (例如一项服务或 以删除 JSDoc 和@example门和no-console。每类安全规则(无)any, (中文(简体) ), 没有任何不合理的铸造、详尽无遗、严格的进口) 已发布 API 表面来记录和合法日志.
// An application: same type safety, no doc/console gate.
export default cosyte(import.meta.dirname, { library: false });
兼容性
ESLint 10 平面配置, 以统一配置为基础 typescript-eslint 软件包在
recommendedTypeChecked,所以类型意识 林丁需要一个真实的 tsconfig 编辑 tsconfigRootDir
工厂需要。 测试和构建脚本放松了JSDoc和控制台的规则.
eslint-config-prettier 所以格式化是Prettier的工作,这里没有规则
这个.
捐款
问题、错误报告和提议 问题跟踪器欢迎调用请求 cosyte/ 配置,这个包裹住的地方.
改变必须清除所需的 verify 任务,而新规则需要更改 说它是什么
拒绝:每个没经过的消费者加一分红.
许可证
麻省理工学院,版权:Cosyte LLC. 见 自由主义。 。 。 .