ES 模块和 jsconfig.json：错误 [ERR_MODULE_NOT_FOUND]

Question

我有一个使用常规 JS 的节点 Web 应用程序项目。

我正在尝试使用jsconfig.json设置一些路径。 我尝试使用节点默认的Subpath imports ，即使它确实有效，vscode 智能感知也停止工作。

我发现你可以使用jsconfig.json所以我设置了这个文件

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "baseUrl": "./",
    "paths": {
      "@controllers/*": ["node/controllers/*"],
    },
  },
  "exclude": ["node_modules"]
}

在我的package.json我添加了

"type": "module",

我的文件夹结构是

├── node
│    └──controllers
│         └── foo.js
├── server.js
├── jsconfig.json
└── package.json

但是当我尝试从server.js导入时

import { foo } from '@controllers/foo.js'
// or import { foo } from '@controllers/foo'

foo.js

export const foo = 'Hello server'

我明白了

node:internal/process/esm_loader:74
     internalBinding('errors').triggerUncaughtException(

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@controllers/foo.js' imported from /Users/Alvaro/Sites/test/server.js

 at new NodeError (node:internal/errors:363:5)
 at packageResolve (node:internal/modules/esm/resolve:698:9)
 at moduleResolve (node:internal/modules/esm/resolve:739:18)
 at Loader.defaultResolve [as _resolve] (node:internal/modules/esm/resolve:853:11)
 at Loader.resolve (node:internal/modules/esm/loader:89:40)
 at Loader.getModuleJob (node:internal/modules/esm/loader:242:28)
 at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:73:40)
at link (node:internal/modules/esm/module_job:72:36) {
code: 'ERR_MODULE_NOT_FOUND'

Answer 1

经过数小时的研究，我发现在使用esm时很难拥有自定义别名路径，并且很容易为commonjs配置，

但它可以实现，当你使用esm时，方式略有不同，我将在方法 1中编写esm实现的解决方案，然后在方法 2中commonjs

方法一

步骤 0：

删除jsconfig.json

步骤1：

在你的package.json添加一个exports属性，

"name": "package-name"

"exports":{
   "./@controllers/" : "./node/controllers/"
}

注意：不要忘记@controllers和/node/controllers/后面的 '/'

第2步

你将不得不导入文件

  import {foo} from "package-name/controllers/index.js" 
/*
package-name is the same value as the 'name' property in
the package.json
*/

要了解有关package.json中的exports属性的更多信息，请参阅此处

------------------------------XXXXXXXX------ ---------------

方法二

您不能在此方法中使用es modules

步骤 0

安装module-alias包。

npm i module-alias

如果package.json中存在type:module ，则删除它或将值更改为commonjs ；

步骤1

在package.json中指定为entry point的文件的起始行添加以下代码

require(module-alias/register)

在作者的情况下检查package.json中的main属性，它应该是server.js 。

在package.json添加这个

"_moduleAliases": {
  "@root" : ".", // Don't forget to mnetion this
  "@controllers" : "node/controllers/*"
}

现在您可以从以下目录中要求模块

const {foo} = require("@controllers/foo.js") // if foo is named export 

//or

const foo = require("@controllers/foo.js");

您可以在此处参考有关module-alias更多信息

Answer 2

你所尝试的几乎是正确的。

你可以让别名工作，但它必须以#开头。

例如：在package.json

"imports": {
    "#app": "./app.js"
}

并在jsconfig.json

{
  "compilerOptions": {
    "paths": {
      "#app": ["./app.js"]
    }
  }
}