Create React app 引用中使用绝对路径

阅读本文只需6分钟

随着Create React App 3的发布,我们现在引入组件或对象时可以使用绝对路径(absolute import),而不需要eject项目。

哈利路亚,感谢上帝,圣母玛利亚,观世音,唐三藏,关二爷或者土地公公。

也许不用我解释你也知道这一利好,不过我还是总结一下好处。

  • 输入路径更加容易, 不再需要 ../../../../地狱模式
  • 你可以复制/粘贴代码包括导入到其他文件中,而不需要修改引用路径
  • 你可以移动文件而不需要更新引用路径(假如你的IDE没有帮你这么做)
  • 简洁
image.png

根据官方文档的解释,在你项目的根目录下创建jsconfig.json文件,并添加以下代码。

{
  "compilerOptions": {
    "baseUrl": "src"
  },
  "include": ["src"]
}

好极了,现在你可以像往常一样使用相对路径

import React from 'react';
import Button from '../../Button/Button';
import { LINKS, STRINGS } from '../../../utils/constants';
import styles from './App.module.css';

function App() {
  return (
    <div className={styles.App}>
      <Button>
        {STRINGS.HELLO}
      </Button>
      
      <a href={LINKS.HELP}>Learn more</a>
    </div>
  );
}

export default App;

或者,你可以使用绝对路径让一切变得简单,

import React from 'react';
import { LINKS, STRINGS } from 'utils/constants';
import Button from 'components/Button/Button';
import styles from './App.module.css';

function App() {
  return (
    <div className={styles.App}>
      <Button>
        {STRINGS.HELLO}
      </Button>
      
      <a href={LINKS.HELP}>Learn more</a>
    </div>
  );
}

export default App;

不幸的是,官方解释到此为止了,但是你可能还需要做一些额外的配置。

WebStorm config

如果你是个 WebStorm/IntelliJ 用户,你一定遇见过这些烦恼:

image.png

WebStrom 根据 Node.js 规则假设绝对路径都在 node_modules, 所以我们必须告诉它我们需要酷一点使用绝对路径。

首先,设置你的src目录为 Resources Root

image.png

然后选择 Settings > Editor > Code Style > JavaScript, 进入 Imports tab 下勾选 Use paths relative to the project, resource or sources roots.

image.png

现在 Webstorm 明白了绝对路径 该指向哪里。同时 jump-to-source/autocomplete 这些功能将会奏效,并且不再有警告,也意味着auto-import机制将使用绝对路径

假如我们有这样一份文件:

import React from 'react';
import styles from './App.module.css';

function App() {
  return (
    <div className={styles.App}>
    </div>
  );
}

export default App;

然后我们在该文件中复制如下代码:

<Button>{STRINGS.HELLO}</Button>
<a href={LINKS.HELP}>Learn more</a>

经过设置的 Webstorm 将会知道我们需要 <Button> , STRINGSLINKS, 并在合适的位置插入绝对路径引用。

import React from 'react';
import styles from './App.module.css';
import Button from 'components/Button/Button';
import { LINKS, STRINGS } from 'utils/constants';

function App() {
  return (
    <div className={styles.App}>
      <Button>{STRINGS.HELLO}</Button>
      <a href={LINKS.HELP}>Learn more</a>
    </div>
  );
}

export default App;

不过,它并没有按我需要的顺序插入引用,

npm package --> 相对路径引用

不过,哪怕我需要重新调整引用顺序,也好过使用相对路径。

VS Code  — 不需要任何配置

VS Code 无师自通的理解 jsconfig.json, 当使用绝对路径时,jump to sourceIntellisense 依然正常运行。

其实VS Code 并不关心你的绝对路径指向的文件或目录是否存在,所以也并不需要你的任何配置。

注解
依我看,截止到 2019 年 5月为止, 整体上来说, Webstorm 依然比 VS
Code 优秀一些,特别是 git tools 解决冲突, 代码重构方面,不过, VS Code 正在努力追赶,相比于Webstorm简直就是光速打开。

首字母大写惯例(Capital letters by convention)

在Webpack中使用绝对路径可能有很长一段时间了,并且使用驼峰法(PascalCase)为根引用路径起别名已经成为惯例(在 examples from the Webpack docs中就是这么做的)。

这很聪明,我也强烈推荐在你的codebase中的根目录(top-level directories)使用驼峰法`命名。

image.png

ComponentsUtils 使用首字母大写,便可以很简单的区分哪些引用是npm packages, 哪些是你自己的源码,你也绝对不会和npm package 发生冲突。

同样的,避免在src的根目录下定义文件,比如,如果你定义了src/constant.js, 在你引入的时候 import constants from 'constants', 看起来就太太太奇怪了。

ESLint

CRA在他们的ESLint设置中有一套非常精简的规则,并且对为什么会这样有一些强烈的意见。如果你愿意,你可以不理会Facebook的建议(他们哪懂什么是React ,况且他们还是404), 然后使用 AirbnbESLint 配置。

如果你真这么做了,你会发现Airbnb使用eslint-plugin-import,它会检查未定义的导入,并给你如下错误:

image.png

你可以通过ESLintsetting来修复这个问题,告诉它路径可能是相对于src的:

"eslintConfig": {
  "extends": ["react-app", "airbnb"],
  "settings": {
    "import/resolver": {
      "node": {
        "paths": ["src"]
      }
    }
  }
},

请注意,你不需要为此安装任何的npm包,setting就够了。

恢复清晰度(Restoring clarity)

对于没接触过绝对路径引入的开发者来说,暂时可能会有点迷惑,所以我建议加入一些关于这部分描述在你的Readme中, 包括怎样设置IDE。 你也可以把加上本文的链接,只要简书不倒闭,我保证我不会删除或者修改本文的内容,至多只是网络图片失效而已。

当然, 值得说明的是我们还是需要使用相对路径引入。 我认为在同一目录下的文件使用相对路径引入会更加方便, 使用绝对路径反而会使路径变得冗长。
同时,我建议你在一些相关的child components中使用相对路径引入。假如你有一个<Dropdown>组件并包含一个<DropdownItem>组件,这时还使用完整冗长的绝对路径引用就显得太过分了。

感谢阅读。
如果对你有所帮助,请留言或者点赞,感激不尽。

原文地址:https://hackernoon.com/absolute-imports-with-create-react-app-4c6cfb66c35d
感谢原文作者:David Gilbertson

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容