import导入顺序杂乱的问题

我们经常会遇到项目中的import语句顺序混乱的问题。这不仅会影响代码的可读性,还可能使我们代码在提交的时候产生不必要的冲突。

解决方案

eslint-plugin-import

开始我调研了一下eslint-plugin-import插件。这款插件的排序逻辑是这样:

  1. builtin : 这代表Node.js内置的模块,例如fspath等。

    import fs from 'fs';

  2. external: 这代表外部库或框架,通常是你通过npm或yarn安装的模块。

    import axios from 'axios';

  3. internal: 这代表项目内部的模块,但它们通常在项目的不同目录或子目录中。这些模块不是直接的父级或同级模块。

    import { someFunction } from '@utils/my-helper';

  4. parent: 这代表从父目录导入的模块。

    import something from '../something';

  5. sibling: 这代表与当前文件在同一目录下的其他文件。

    import { siblingFunction } from './sibling-module';

  6. index : 这代表从目录的index文件导入的模块。

    import { indexFunction } from './';

  7. object: 这代表导入的对象属性,例如:

    import('some-module').then(({ someExport }) => ...);

  8. type: 这代表从模块导入的类型或接口(这在TypeScript中特别有用)。

    import type { MyType } from './types';

大致分为这些模块。我们可以在eslint的规则中根据这些模块进行排序。但是这并不是我想要的排序模式,我更希望根据功能进行排序。组件放在一起,hooks放在一起,工具函数放在一起,等等。

eslint-plugin-simple-import-sort

于是我找到了eslint-plugin-simple-import-sort这个插件。使用方式如下:

  1. 安装插件:

    npm install --save-dev eslint-plugin-simple-import-sort

  2. 配置 ESLint : 在 .eslintrc.js 或你的 ESLint 配置文件中,添加以下配置:

    module.exports = {
    // ... 其他配置
    plugins: ['simple-import-sort'],
    rules: {
    'simple-import-sort/imports': 'error',
    'simple-import-sort/exports': 'error',
    },
    };

  3. 自定义排序:

    复制代码
     'simple-import-sort/imports': [
      'error',
      {
        groups: [
          [`^vue$`, `^vue-router$`, `^ant-design-vue$`, `^echarts$`], // 你可以根据需要添加更多的内置模块
            [`.*\\.vue$`], // .vue 文件
            [`.*/assets/.*`, `^@/assets$`],
            [`.*/config/.*`, `^@/config$`],
            [`.*/hooks/.*`, `^@/hooks$`],
            [`.*/plugins/.*`, `^@/plugins$`],
            [`.*/router/.*`, `^@/router$`],
            [`^@/services$`, `^@/services/.*`],
            [`.*/store/.*`, `^@/store$`],
            [`.*/utils/.*`, `^@/utils$`],
            [`^`],
            [`^type `],
        ],
      },
    ],
相关推荐
江拥羡橙6 小时前
Vue和React怎么选?全面比对
前端·vue.js·react.js
暮之沧蓝7 小时前
Vue总结
前端·javascript·vue.js
excel8 小时前
深入解析 Vue 3 源码:computed 的底层实现原理
前端·javascript·vue.js
zero13_小葵司9 小时前
在Vue项目中构建后端配置的动态路由及权限控制体系
前端·javascript·vue.js
羊羊小栈11 小时前
基于「YOLO目标检测 + 多模态AI分析」的光伏板缺陷检测分析系统(vue+flask+模型训练+AI算法)
vue.js·人工智能·yolo·目标检测·flask·毕业设计·大作业
光影少年13 小时前
vue生态都有哪些?
前端·javascript·vue.js
一只大头猿13 小时前
基于SpringBoot和Vue的超市管理系统
前端·vue.js·spring boot
西洼工作室15 小时前
Vue CLI为何不显示webpack配置
前端·vue.js·webpack
程序员王天18 小时前
【开发AGIC】Vue3+NestJS+DeepSeek AI作业批改系统(已开源)
vue.js·ai编程·nestjs
昔冰_G19 小时前
Vue内置组件KeepAlive——缓存组件实例
vue.js·缓存·vue3·vue2·keep-alive·vue组件缓存·vue内置组件