Climatiq 氧化物配置预设

这个软件包提供了 Climatiq 的 oxlint 打开 oxfmt 配置为 Climatiq 中任意工程的基础配置 . 它包括React,Next.js,TypeScript等的配置.

安装

npm install --save-dev @climatiq/oxc-presets

或带线:

yarn add --dev @climatiq/oxc-presets

或带pnm:

pnpm add -D @climatiq/oxc-presets

使用量

氧化剂

安装 氧化剂 与此软件包并列( 它在 相互依存关系)以及 oxlint-tsgolint 页:1 类型 - 意识会擦去.

这个 clsx编号 :cn 规则用这个包作为 Oxlint JS 插件,所以没有别的了 用于安装它们——见 lint-rules/。 。 。 .

创建一个 .oxlintrc.json 在工程根中包含以下内容的文件 :

{
    "$schema": "./node_modules/oxlint/configuration_schema.json",
    "extends": ["./node_modules/@climatiq/oxc-presets/oxlint-config.json"],
}

如果你想选择退出型号的起伏,请不要安装 oxlint-tsgolint 并在您牛林配置中添加以下内容:

{
    "$schema": "./node_modules/oxlint/configuration_schema.json",
    "extends": ["./node_modules/@climatiq/oxc-presets/oxlint-config.json"],
    "options": {
        "typeAware": false,
    },
}

氧化剂

安装 氧化剂 与此软件包并列( 它列在对等依赖中) .

@climatiq/oxc- presets/oxfmt条目解决为平原.js预设(本套件使用"类型":"模块"),因此节点在扩展时不需要从节点 模块下的文件中剥取类型脚本.

创建一个 oxfmt.config.ts 在工程根中的文件 :

import { defineConfig } from 'oxfmt';
import climatiqOxfmt from '@climatiq/oxc-presets/oxfmt';

export default defineConfig({
    ...climatiqOxfmt,
    printWidth: 100,
    // or any other overrides
});

奥克塞夫姆特没有 extends 字段; 扩展预设和设置任何顶级选项, 之后是您如何覆盖它( 相同的想法) ignorePatterns: 传播 climatiqOxfmt.ignorePatterns 和附件路径).

包含什么

氧化剂

Oxlint配置包括:

• 下一个.js 规则
• 反应 规则
• 类型脚本 规则
• clsx/ cn 数据 规则,作为Oxlint JS插件捆绑——见 lint-rules/
• 未用进口 探测和自动搬运
• TypeScript 项目的智能默认值

clsx/cn 规则

这个 clsx/* 规则从 eslint-plugin-clsx (MIT)并改划为 Oxlint的JS插件 API,所以消费者不需要 eslint-plugin-clsx 已安装。 哪个模块 计数为 clsx 通过 settings.clsxOptions; 预设的船舶有:

{
    "settings": {
        "clsxOptions": {
            "clsx": ["default", "clsx"],
            "classnames": ["default"],
            "@/src/lib/utils": ["cn"],
        },
    },
}

奥克林特目前没有继承 settings 结束 extends,所以同样的地图也是 插件内置默认值 : clsx, (中文(简体) ), classnames 财务报告和审定财务报表 cn 包含在盒子外,没有 配置在你的一边。 添加自己的内容 settings.clsxOptions 区域 cn 帮助者 在别的地方生活——注意: 替换 而不是延长,所以 重新列出 clsx 财务报告和审定财务报表 classnames 如果你仍然想要他们覆盖.

完整规则文档在 lint-rules/index.md。 。 。 .

氧化剂

Oxfmt 配置包括:

• 1 缩进=4个空格
• 单引号
• 半边
• 后面的逗号
• 已启用 Tailwind 类排序

许可证

麻省理工学院

释放过程

要发布新版本,只需在GitHub Repo Releases页面上用新版本创建新版本.

GitHub 动作工作流程 release.yaml 将标记新版本并将其发布到 npm .

因此,包中的版本. json并不一定反映当前版本的包.