首页
/ 推荐文章: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 有了全面的了解。立即尝试并体验它带来的便捷和高效吧!

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
261
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
511
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
258
298
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
22
5