网站LOGO
白雾茫茫丶
页面加载中
7月21日
网站LOGO 白雾茫茫丶
记录学习、生活和有趣的事
菜单
  • 白雾茫茫丶
    记录学习、生活和有趣的事
    用户的头像
    首次访问
    上次留言
    累计留言
    我的等级
    我的角色
    打赏二维码
    打赏博主
    使用 sort-imports 排序规则美化头部 import 代码
    点击复制本页信息
    微信扫一扫
    文章二维码
    文章图片 文章标题
    创建时间
  • 一 言
    确认删除此评论么? 确认
  • 本弹窗介绍内容来自,本网站不对其中内容负责。
    • 复制图片
    • 复制图片地址
    • 百度识图
    按住ctrl可打开默认菜单

    使用 sort-imports 排序规则美化头部 import 代码

    谢明伟 · 原创 ·
    技术分享 · ReactEslint
    共 2851 字 · 约 1 分钟 · 491
    本文最后更新于2023年12月28日,已经过了205天没有更新,若内容或图片失效,请留言反馈
    我们在开发一个页面的时候,文件头部总是会有一堆 import 代码,特别是使用 React 技术栈的同学感同身受,随着项目代码的增多,如果不对头部的代码进行分层,会导致代码看起来很冗余,我们需要它按照一定的规则进行排序。

    问题本质

    • 当头部 import 代码过多时,它往往是这样的:

      TypeScript 代码:
       import { useAntdTable, useBoolean, useRequest, useSetState } from 'ahooks'
       import type { ColumnsType, ColumnType } from 'antd/es/table';
       import ImportFileModal from './components/ImportFileModal'
       import ImportFundReceiptListTable from './components/ImportFundReceiptListTable'
       import { get, reduce, toNumber } from 'lodash'
       import moment, { Moment } from 'moment'
       import React, { FC, useState } from 'react'
       import { Link } from 'react-router-dom';
       import PageHeaderWrapper from '@/components/PageHeaderWrapper';
       import { transPostToGet } from '@/utils/utils';
       import ImportErrorModal from './components/ImportErrorModal'
       import ImportNumberModal from './components/ImportNumberModal'
       import TrendTotal from './components/TrendTotal'
       import { Button, Card, Col, DatePicker, Form, Row, Space, Table } from 'antd'
       import { FundReceiptTable, Json2DBParams, TableParams } from './utils/interface'
       import { generatePageJson, getReceiptList, saveJsonDB } from './utils/service'

    如果不进行处理,可读性极差,对于有强迫症的我实在忍不了。

    配置 Eslint

    1. Eslint官网 本身提供了一条名叫 sort-imports 的规则,首先我们需要安装一个插件 eslint-plugin-simple-import-sort

      POWERSHELL 代码:
      pnpm add -D eslint-plugin-simple-import-sort
    2. 配置 .eslintrc.cjs 文件,加入配置:

      JSON 代码:
      {
       "plugins": ["simple-import-sort"],
       "rules": {
      "simple-import-sort/imports": "error",
       }
      }

      这样我们就配置好了,以后当我们开发页面的时候,Eslint 会自动帮我们把头部的 import 代码进行排序。

      排序后是这样的:

      TypeScript 代码:
      import { useAntdTable, useBoolean, useRequest, useSetState } from 'ahooks'
      import { Button, Card, Col, DatePicker, Form, Row, Space, Table } from 'antd'
      import type { ColumnsType, ColumnType } from 'antd/es/table';
      import { get, reduce, toNumber } from 'lodash'
      import moment, { Moment } from 'moment'
      import React, { FC, useState } from 'react'
      import { Link } from 'react-router-dom';
      
      import PageHeaderWrapper from '@/components/PageHeaderWrapper';
      import { transPostToGet } from '@/utils/utils';
      
      import ImportErrorModal from './components/ImportErrorModal'
      import ImportFileModal from './components/ImportFileModal'
      import ImportFundReceiptListTable from './components/ImportFundReceiptListTable'
      import ImportNumberModal from './components/ImportNumberModal'
      import TrendTotal from './components/TrendTotal'
      import { FundReceiptTable, Json2DBParams, TableParams } from './utils/interface'
      import { generatePageJson, getReceiptList, saveJsonDB } from './utils/service'

    怎么样,是不是可读性变好很多!

    声明:本文由 谢明伟(博主)原创,依据 CC-BY-NC-SA 4.0 许可协议 授权,转载请注明出处。

    还没有人喜爱这篇文章呢

    我要发表评论 我要发表评论
    博客logo 白雾茫茫丶 记录学习、生活和有趣的事 51统计 百度统计
    MOEICP 萌ICP备20236860号 ICP 粤ICP备2023007649号 ICP 粤公网安备44030402006402号

    💻️ 谢明伟 一天前 在线

    🕛

    本站已运行 2 年 202 天 3 小时 44 分

    🌳

    自豪地使用 Typecho 建站,并搭配 MyLife 主题
    白雾茫茫丶. © 2022 ~ 2024.
    网站logo

    白雾茫茫丶 记录学习、生活和有趣的事