UI Styling 标准 ESLint 插件
UI Styling标准是一套原则,用于指导图集前端的UI代码 代码库和生态系统.
这些是目前的ESLint规则,它们执行并帮助遵守今天的UI Styling标准, 但计划更多时间支持标准.
安装
您必须使用推荐的配置来遵循Atlassian的造型标准,这将确保 与设计系统的兼容性和性能.
module.exports = {
extends: [
+ 'plugin:@atlaskit/ui-styling-standard/recommended',
],
};
我们不建议维持你的配置 如果你不使用我们的配置,你将需要
指定单个规则和配置。 将插件添加到您的 eslint.config.cjs 文档和
允许个人规则,因为你准备采纳.
module.exports = {
plugins: [
+ '@atlaskit/ui-styling-standard',
],
rules: [
+ '@atlaskit/ui-styling-standard/convert-props-syntax': 'warn',
+ '@atlaskit/design-system/local-cx-xcss': 'error',
],
};
规则
| 规则 | 说明 | 建议 | 可修复 | 建议 |
|---|---|---|---|---|
| 阿特拉斯基特主题 | 禁止使用 @atlaskit/theme 那个 @compiled/react 无法理解 | |||
| 转换正则语法 | 将样式- 组件- QQ4 或 @ emotion/ styled 所支持的道具语法转换为道具语法 。 结合 no-styled-tagged-template-expression,因为后者的产出可能使用这些库不支持的道具语法. | 对 | 对 | |
| 执行风格道具 | 停止使用静态样式 style 组件中的属性 | 对 | ||
| 本地密码 | 确保作为 XCSS API 的一部分的 cx () 函数只在 xcs 道具内使用 。 这种辅助跟踪对jsx元素应用的样式. | 对 | ||
| 无阵列参数 | 防止使用数组参数来样式化声明函数 | 对 | 对 | |
| 无阿特拉斯基特主题 | 取消从 @atlaskit/theme | 对 | ||
| 无类名道具 | 放弃使用 className jSX中的道具 | 对 | ||
| 无容器 | 防止使用 Css 样式中的@ container 查询 | 对 | ||
| 无动力风格 | CSS- in- JS 调用中使用动态样式 | 对 | ||
| 无出口型 | 取消 Cs 、 密钥框、 样式和 xcs 的导出 | 对 | ||
| 无全球风格 | 通过 CSS- in- JS 或 CSS 模块导入来防止全局样式 | 对 | ||
| 无重要风格 | 否定重要的风格声明 | 对 | ||
| 无输入型值 | 取消样式值的导入 | 对 | ||
| 无记名选择者 | 防止在 Css 样式内使用嵌入式选择器 | 对 | ||
| 无类型 | 放弃使用 styled 进口 | 对 | ||
| 无安全选择者 | 拒绝使用嵌入式 css 函数. | 对 | 对 | 对 |
| 无安全值 | 对静态安非他明来说难以/不可能的去盐风格. | 对 | ||
| 无未用csmap-财产 | 检测不导出 cssMap 样式对象中未使用的属性。 通过识别定义但从未使用的样式变体,帮助维护清洁代码. | 对 | ||
| 使用编译 | 确保使用 @compiled/react 或者说 @atlaskit/css 而不是其他 CSS- in- JS 图书馆 | 对 | 对 | |
| @atlaskit/design-system/ consistent-cs-prop-usage (英语) | 确保与 css 财务报告和审定财务报表 xcss 道具用途 | 对 | 对 | |
| @atlaskit/design-system/ no-cs-tign-template-expression (英语) | 拒绝任何 css 源自情感、样式组件或编译的被标记的模板表达式 | 对 | 对 | |
| @atlaskit/design-system/ no-keyframes-tagn-template-expression (没有键框标记-模板-表达式) | 拒绝任何 keyframe 源自情感、样式组件或编译的被标记的模板表达式 | 对 | 对 | |
| @atlaskit/design-system/无标签-tigg-template-expression 页面存档备份,存于互联网档案馆 | 拒绝任何 styled 源自情感、样式组件或编译的被标记的模板表达式 | 对 | 对 | |
| @atlaskit/design-system/没有空格式的表达 | 禁止任何在将空参数传递到样式.div () (或其他JSX元素)时使用的样式表达式 . | 对 | ||
| @atlaskit/design-system/ no-invalid-cs-map (英语) | 检查通过 assMap 创建的 CSS 映射的有效性。 此功能意在与 TypeScript 的类型检查同时使用 . | 对 | ||
| @atlaskit/design-system/no-css-map-scoped (英语) | 实验用途的减少 cssMapScoped API 来自 @compiled/react。这个API是内部的,不是公共编译的CSS-in-JS接口的一部分. | 对 |