eslint-config

eslint-config

Feature Sliced架构专用ESLint配置工具

@feature-sliced/eslint-config是专为Feature Sliced架构开发的ESLint配置包。该工具利用现有ESLint插件,实现对代码隔离性、模块分解、公共API、层级范围和命名规范的控制。配置支持别名、相对和绝对导入,且大小写不敏感。开发者可根据项目需求自定义配置,如选择性使用规则、采用实验性规则或调整警告级别。

Feature-SlicedESLint前端架构代码规范模块化Github开源项目

@feature-sliced/eslint-config

WIP: 目前处于beta测试阶段 - 请谨慎使用

npm npm npm bundle size GitHub Workflow Status

<img src="https://avatars.githubusercontent.com/u/60469024?s=120&v=4" align="right">

通过现有的eslint插件对FeatureSliced概念进行lint

规则

每个规则都有自己的测试用例和定制方面

开始使用

  1. 首先需要安装ESLint:

    $ npm install -D eslint # 或者使用yarn $ yarn add -D eslint
  2. 接下来,安装@feature-sliced/eslint-config和依赖项:

    $ npm install -D @feature-sliced/eslint-config eslint-plugin-import eslint-plugin-boundaries # 或者使用yarn $ yarn add -D @feature-sliced/eslint-config eslint-plugin-import eslint-plugin-boundaries
  3. .eslintrc配置文件的extends部分添加配置(用于推荐规则)。你可以省略eslint-config后缀:

    { "extends": ["@feature-sliced"] }
  4. 仅限TypeScript: 还需要设置TS解析器和TS插件(原因?)

    <details> <summary>详情</summary>

    安装依赖:

    $ npm i -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript # 或者使用yarn $ yarn add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-import-resolver-typescript

    .eslintrc配置文件中将@typescript-eslint/parser配置为解析器,并设置eslint-import-resolver-typescript解析器:

    { "parser": "@typescript-eslint/parser", "settings": { "import/resolver": { "typescript": { "alwaysTryTypes": true } } } }
    </details>

使用方法

  • 支持常见的别名

    import { Input } from "~/shared/ui/input"; import { Input } from "@/shared/ui/input"; import { Input } from "@shared/ui/input"; import { Input } from "$shared/ui/input"; // 但不支持 - import { Input } from "$UIKit/input";
  • 支持相对绝对导入(但请查看建议

    import { ... } from "entities/foo"; // 绝对导入 import { ... } from "@/entities/foo"; // 别名导入 import { ... } from "../entities/foo"; // 相对导入
  • 大小写不敏感

    import { ... } from "entities/user-post"; // 支持kebab-case(推荐) import { ... } from "entities/UserPost"; // 支持PascalCase import { ... } from "entities/userPost"; // 支持camelCase import { ... } from "entities/user_post"; // 支持snake_case
  • 对于特殊情况,支持⚠️危险模式⚠️(查看特定规则了解更多)

自定义

  1. 你可以部分使用规则

    警告: 在自定义时不要使用主配置("@feature-sliced")以避免规则冲突。

    "extends": [ "@feature-sliced/eslint-config/rules/import-order", "@feature-sliced/eslint-config/rules/public-api", "@feature-sliced/eslint-config/rules/layers-slices", ]
  2. 你可以使用替代性实验规则

    • 使用import-order/experimental来格式化组之间的空格和反转层级顺序(原因?)

      "extends": [ // ... 其他规则或配置 "@feature-sliced/eslint-config/rules/import-order/experimental", ]
    • 使用public-api/lite来减少PublicAPI边界的严格程度(原因?)

      "extends": [ // ... 其他规则或配置 "@feature-sliced/eslint-config/rules/public-api/lite", ]
  3. 你可以对特定规则使用警告而不是错误

    "rules": { // feature-sliced/import-order "import/order": "warn" // ~ 1, // feature-sliced/public-api "import/no-internal-modules": "warn" // ~ 1, // feature-sliced/layers-slices "boundaries/element-types": "warn" // ~ 1, }
  4. 你可以使用*高级FSD特定消息处理*

    # (feature-sliced/public-api) - '不允许访问 "features/search/ui"。' + '违反了模块公共API的使用规则 | https://git.io/Jymjf'

另请参阅

编辑推荐精选

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

热门AI工具AI办公办公工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

模型训练热门AI工具内容创作智能问答AI开发讯飞星火大模型多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

热门AI工具生产力协作转型TraeAI IDE
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

AI助手热门AI工具AI创作AI辅助写作讯飞绘文内容运营个性化文章多平台分发
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

下拉加载更多