Say Goodbye to '../' '../../' '../../../'

#1

开发 JavaScript 时，你有没有遇到过这样的情况。
页面复用大量共通组件，这些共通组件大体都在同一个文件夹下。但是由于组件分割和文件夹层级较深的缘故，你尝尝会写出:point_down:这样的代码。

// some.js
import VodMediaPlayer from '../../../components/VodVideo/VodMediaPlayer'
import VideoInfo from '../../../components/VodVideo/VideoInfo'
import RecommendList from '../../../components/RecommendList/RecommendList'
import Comment from '../../../components/Comment/Comment'
import { get, mediaPath } from '../../../util/fetch'
import { API_VIDEO, API_CHANNEL } from '../../../util/constants'

你知道自己在键盘上敲击 ../ ../../ ../../../ 时浪费了多少时间吗？

时间就是金钱。 ～名言

为了解决这种问题，主流的前端工具都给出了解决方案。
本文介绍如何使用 babel plugin 的解决方案。

正文

首先我们选择 babel-plugin-module-resolver。

1. 安装

$ npm install --save-dev babel-plugin-module-resolver

2. 配置 .babelrc

{
  "presets": ["env", "react"],
  "plugins": [
    ["module-resolver", {
      "root": ["./"],
      "alias": {
        "components": "./src/components",
        "util": "./src/util"
      }
    }]
}

这时你的代码可以修改为:point_down:

// some.js
import VodMediaPlayer from 'components/VodVideo/VodMediaPlayer'
import VideoInfo from 'components/VodVideo/VideoInfo'
import RecommendList from 'components/RecommendList/RecommendList'
import Comment from 'components/Comment/Comment'
import { get, mediaPath } from 'util/fetch'
import { API_VIDEO, API_CHANNEL } from 'util/constants'

:warning:注意： 如果你使用了 eslint，这时 eslint 会报错，因为它不能处理新的写法。

3. 添加对应的 eslint plugin

我们选择 eslint-import-resolver-babel-module

$ npm install --save-dev eslint-plugin-import eslint-import-resolver-babel-module

配置 .eslintrc

"settings": {
  "import/resolver": {
    "babel-module": {}
  }
}

:warning:注意： 这时 eslint 不会报错了， 但是你会发现你点击 import 后面的组件名， VSCode 不会自动跳转到组件定义。

4. 在项目根目录下添加 jsconfig.json 解决

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "components/*": ["src/components/*"],
      "util/*": ["src/util/*"],
      "locales/*": ["src/locales/*"]
    }
  }
}

到此为止，我们终于可以 Say Goodbye to '../' '../../' '../../../' 了。

参考



1 Like
#2

TypeScript baseUrl 发来贺电.

#3

其实如果使用 webpack 也很简单，都怪我手贱使用了 Parcel。
:joy::joy::joy:

#4

其实可以把所有组件都在common文件里面引入，然后export出来，需要用的的时候统一从common文件里面引用就可以了

1 Like
#5

因为组件不单单是 js 文件，还有 less, README 和 .test.js，你的方法会让 common 文件夹无比巨大，无比复杂。

展示一下，我的项目的“评论框”组件:point_down:，这样组件大约有 30多个。:joy:

还有一点, ES6 的解构赋值性能并没有特别棒。

// 如果没有 babel，👇会很慢
import {a, b, c, d} from './xxx'
#6

webpack的alias配上typescript的tsconfig.json配置文件了解下，那酸爽，隔壁小孩都忍不住要撸代码了

1 Like
#7

是啊，是啊，webpack 很简单，可是我用 parcel。:joy::joy::joy: