如何在 create-react-app 中创建导入快捷方式/别名？

Question

如何在 create-react-app 中设置导入快捷方式/别名？ 从此：

import { Layout } from '../../Components/Layout'

到这里：

import { Layout } from '@Components/Layout'

我有一个webpack 4.42.0 版本。 我的根目录中没有 webpack.config.js 文件。我尝试在里面创建一个自己的代码：

const path = require('path')

module.exports = {
  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src/'),
    }
  }
};

但它似乎不起作用。我在.env 文件中看到了NODE_PATH=. 变体。但我相信，它已被弃用 - 最好不要使用。而且，我有一个posstcss.config.js 文件。因为我已经安装了 TailwindCss 并在那里导入了 CSS 库。我尝试在那里粘贴相同的代码，但它也没有工作。

Answer 1

混淆术语的注意事项

// Absolute path: paths which are relative to a specific path
import Input from 'components' // src/components
import UsersUtils from 'page/users/utils' // src/page/users/utils

// Alias path: other naming to specific path
import Input from '@components' // src/components
import UsersUtils from '@userUtils' // src/page/users/utils

为了让 webpack 的 aliases 工作，你需要配置默认的 webpack.config.js 或 create-react-app。

官方方式是to use the eject script。

但推荐的方式是使用库而不弹出，比如craco。

在关注installation 之后，将craco.config.js 添加到具有所需配置的根文件夹中。

我的例子：

// craco.config.js
const path = require(`path`);
const alias = require(`./src/config/aliases`);

const SRC = `./src`;
const aliases = alias(SRC);

const resolvedAliases = Object.fromEntries(
  Object.entries(aliases).map(([key, value]) => [key, path.resolve(__dirname, value)]),
);

module.exports = {
  webpack: {
    alias: resolvedAliases,
  },
};

aliases.js (./src/config/aliases) 导出辅助函数的位置：

const aliases = (prefix = `src`) => ({
  '@atoms': `${prefix}/components/atoms`,
  '@molecules': `${prefix}/components/molecules`,
  '@organisms': `${prefix}/components/organisms`,
  '@templates': `${prefix}/components/templates`,
  '@components': `${prefix}/components`,
  '@config': `${prefix}/config`,
  '@enums': `${prefix}/enums`,
  '@hooks': `${prefix}/hooks`,
  '@icons': `${prefix}/components/atoms/Icons`,
  '@styles': `${prefix}/styles`,
  '@utils': `${prefix}/utils`,
  '@state': `${prefix}/state`,
  '@types': `${prefix}/types`,
  '@storybookHelpers': `../.storybook/helpers`,
});

module.exports = aliases;

VSCode 智能感知

另外，你应该在VSCode中为路径IntelliSense添加jsconfig.json文件（或tsconfig.json），see followup question。

现在这样的带有 IntelliSense 的代码可以工作了：

// NOTE THAT THOSE ARE ALIASES, NOT ABSOLUTE PATHS
// AutoComplete and redirection works
import {ColorBox} from '@atoms';
import {RECOIL_STATE} from '@state';

Answer 2

按照以下步骤进行归档的最简单方法。 （与@DennisVash 显示的方式相同，但形式简单）

1. 安装 - 安装和设置 CRACO。

yarn add @craco/craco

# OR

npm install @craco/craco --save

1. 在根目录下创建craco.config.js文件并配置CRACO：

/* craco.config.js */
const path = require(`path`);

module.exports = {
  webpack: {
    alias: {
      '@': path.resolve(__dirname, 'src/'),
      '@Components': path.resolve(__dirname, 'src/components'),
      '@So_on': path.resolve(__dirname, 'src/so_on'),
    }
  },
};

1. 在您的 package.json 文件的脚本部分更新对 react-scripts 的现有调用以使用 craco CLI：

/* package.json */

"scripts": {
   "start": "craco start",
   "build": "craco build",
   "test": "craco test"
}

完成！设置完成。

现在让我们测试一下。

// Before
import Button from "./form/Button" 
import { Layout } from '../../Components/Layout'

// After
import Button from "@/form/Button"
import { Layout } from '@Components/Layout'

文档Craco

谢谢。 :)

Answer 3

Create React App v.3 终于可以实现了

简单地说：

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

如果您使用 Typescript，请输入 jsconfig.json 或 tsconfig.json

article 非常棒。

Answer 4

如果你想使用：

// this:
import MyUtilFn from 'utils/MyUtilFn';
// Instead of this:
import MyUtilFn from '../../../../utils/MyUtilFn';

使用节点模块插件来解析网址https://www.npmjs.com/package/babel-plugin-module-resolver。通过安装它并将其添加到您的 webpack/babel.rc 文件中。