首页
/ 推荐文章:Prettier插件——导入排序神器

推荐文章:Prettier插件——导入排序神器

2024-08-10 00:11:48作者:韦蓉瑛

项目介绍

Prettier plugin sort imports 是一款基于 @trivago/prettier-plugin-sort-imports 开发的 Prettier 插件,旨在通过提供的正则表达式顺序对导入声明进行排序,同时保留副作用导入的顺序。该插件不仅继承了原项目的优秀特性,还增加了多项新功能,如不跨副作用导入重新排序、合并来自同一源的导入、支持自定义导入顺序分隔等。

项目技术分析

该插件的核心技术在于利用正则表达式对导入声明进行智能排序,确保代码的整洁和可读性。它通过识别和分类不同类型的导入(如副作用导入、本地导入、第三方导入等),并根据用户配置的规则进行排序。此外,插件还支持 TypeScript 和 JSX 等解析插件,确保在多种开发环境下都能高效工作。

项目及技术应用场景

Prettier plugin sort imports 适用于所有使用 Prettier 进行代码格式化的项目,特别是大型前端项目和团队协作开发环境。它能够帮助开发者自动整理和优化导入声明,减少手动调整的时间,提高代码的一致性和可维护性。无论是个人开发者还是企业级项目,都能从中受益。

项目特点

  1. 智能排序:根据正则表达式自动排序导入声明,保留副作用导入的顺序。
  2. 合并导入:合并来自同一源的导入,减少冗余代码。
  3. 类型导入支持:支持 TypeScript 4.5.0 及以上版本,能够区分和分组类型导入。
  4. 内置模块排序:自动将 Node.js 内置模块排序至顶部,提升代码结构清晰度。
  5. 自定义分组:支持自定义导入顺序分隔,满足不同项目的个性化需求。
  6. 兼容性强:支持多种解析插件,如 TypeScript、JSX 等,确保广泛的应用场景。

通过使用 Prettier plugin sort imports,开发者可以轻松实现导入声明的自动排序和优化,提升代码质量和开发效率。欢迎广大开发者尝试并贡献代码,共同推动项目的持续发展。


安装指南

  • 使用 npm 安装:
    npm install --save-dev @ianvs/prettier-plugin-sort-imports
    
  • 使用 yarn 安装:
    yarn add --dev @ianvs/prettier-plugin-sort-imports
    
  • 使用 pnpm 安装:
    pnpm add --save-dev @ianvs/prettier-plugin-sort-imports
    

配置示例

module.exports = {
    singleQuote: true,
    semi: true,
    plugins: ['@ianvs/prettier-plugin-sort-imports'],
    importOrder: ['^@core/(.*)$', '', '^@server/(.*)$', '', '^@ui/(.*)$', '', '^[./]'],
    importOrderParserPlugins: ['typescript', 'jsx', 'decorators-legacy'],
    importOrderTypeScriptVersion: '5.0.0',
};

贡献指南

我们欢迎并感谢所有形式的贡献!请参阅 CONTRIBUTING.md 了解更多详情。


通过以上介绍,相信您已经对 Prettier plugin sort imports 有了全面的了解。立即尝试并体验它带来的便捷和高效吧!

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8