@canva/app-slint-plugin (英语)

与Canva合作的ESLint插件.

目录

• 导言
• 设置
  • 1. 安装
  • 2. 配置
• 可共享配置
• 更改日志
• 捐款
• 许可证

导言

这个 @canva/app-eslint-plugin 软件包是一个ESLint插件,用于提供配置默认和与Canva合作的规则.

设置

如果你正在使用这个 Canva Apps SDK 启动套件,或者你已经使用了 坎瓦语CLI 创建 Canva SDK 应用程序,即 @canva/app-eslint-plugin 软件包已经安装和配置.

1. 安装

您可以迁移已有的 Canva SDK 应用程序, 或者使用 @canva/app-eslint-plugin 软件包,不基于启动套件,也不来自Canva CLI。 首先将软件包安装为开发依赖:

npm install @canva/app-eslint-plugin --save-dev

2. 配置

您可以通过导入 ESLint 插件来使用 @canva/app-eslint-plugin 软件包,并应用所提供的共享配置。 将软件包导入到您的 Eslint 平面配置数字 :

// eslint.config.js
import canva from "@canva/app-eslint-plugin";

export default [
  ...canva.configs.apps,
  // your existing eslint config
];

要选择更严格的内衬,请使用严格的配置 :

// eslint.config.mjs
import canva from "@canva/app-eslint-plugin";

export default [...canva.configs.apps_strict];

严格的林入增加了导入验证,反应钩和无障碍规则, 测试库规则、 蛇案类型文件名和绝对导入 在目录之间。 它没有规定试跑者.

可共享配置

此软件包提供以下配置集:

• apps - 创造和维持高质量 Canva 应用程序 SDK 应用程序.
• apps_strict - 那个 apps 配置时附加了严格的规则.
• apps_no_i18n - 这是相同的 apps 配置但不需要翻译应用程序。 大多数应用应该支持国际化, 然而由于一些应用目前可能无法翻译的信息数量有限.
• apps_i18n - 这只是部分 apps 配置 没有 列入 apps_no_i18n 配置 。 一般来说,最好使用 apps 直接配置 .

这些组合包括由其他软件包提供的以下配置组合:

• 建议的ESLint。 。 。 .
• 建议的打字方式、风格和严格。 。 。 .
• 建议的埃斯林特-插剂反应。 。 。 .
• 建议的埃斯林特-插座-喷雾剂。 。 。 .

此外,还配置了下列规则:

• QQ 配置设置规则启用于 :
  • 📦 apps 财务报告和审定财务报表 apps_no_i18n
  • 🌐 apps 财务报告和审定财务报表 apps_i18n

更改日志

见 CHANGELOG.md 文档.

捐款

我们正在积极开发这个一揽子计划,但目前不接受第三方的捐款. 如果您想要求修改或添加软件包,请通过 Canva 开发者社区。 。 。 .

许可证

见 LICENSE.md 文档.