Eslint 不尊重 jsconfig 路径

Question

我在 monorepo 中有我的 express.js 项目。我想为其添加自定义路径别名。 目录结构为：

./
server/
----> jsconfig.json
----> .eslintrc.js
----> src/
--------> index.js
--------> modules/auth
-------------> auth.controller.js

jsconfig.json

{
  "compilerOptions": {
    "module": "ES6",
    "baseUrl": "./",
    "paths": {
      "@modules/*": [
        "src/modules/*"
      ]
    }
  },
  "exclude": ["node_modules"]
}

.eslintrc.js

module.exports = {
  env: {
    es2021: true,
    node: true,
  },
  extends: [
    'airbnb-base',
  ],
  parserOptions: {
    ecmaVersion: 12,
    sourceType: 'module',
  },
  rules: {
    'no-console': 'error',
    'no-debugger': 'error',
  },
  settings: {
    'import/resolver': {
      alias: {
        map: [
          ['@modules/*', 'src/modules/*'],
        ],
        extensions: ['.js', '.json'],
      },
    },
  },
};

简单地说，我只是尝试在我的 index.js 文件中导入身份验证控制器。

import authRoutes from '@modules/auth/auth.routes';

但我收到以下错误：Unable to resolve path to module '@modules/auth/auth.controller' .eslint import/no-unresolved

请不要建议关闭规则。 我已经尝试过eslint-import-resolver-jsconfig，但我得到了Cannot resolve jsConfig, SyntaxError } on 150。

Answer 1

因为我使用了monorepo，所以ESLint甚至lint-staged都有问题。 所以现在我每个存储库只有一个项目，并且：

1. 在jsconfig.json中添加了自定义路径：

"paths": {
      "@modules/*": [
        "./src/modules/*"
      ]
    }

1. 安装eslint-import-resolver-jsconfig并在eslint.json中添加如下配置：

"extends": [
    "airbnb-base",
    "eslint:recommended"
  ],
 "plugins": ["import"],
 "settings": {
    "import/resolver": {
      "jsconfig": {
        "config": "jsconfig.json"
      }
    }
  }

1. 安装了 Babel 插件babel-plugin-module-resolver 并在.babelrc 中添加了以下设置：

 "plugins": [
    [
      "module-resolver",
      {
        "alias": {
          "@modules": "./src/modules"
        }
      }
    ]
  ]

但是，同样：这仅适用于每个存储库有一个项目并且所有配置文件（.*rc、package.json 等）都位于根级别的情况。

Answer 2

为了实现上述目的，我使用了module-alias 包。

将其安装为普通依赖项npm i --save module-alias 后，将以下内容添加到您的package.json：

"_moduleAliases": {
  "@modules": "./src/modules"
}

这基本上将为您要定义的所有别名定义映射。

要使其工作，您现在需要在index.js 下的应用程序顶部导入以下内容：

require("module-alias/register"); // If using commonJS
// or
import "module-alias/register"; // If transpiling es6

您现在已准备就绪，应该可以使用如下所示的绝对路径导入文件：

const authRoutes = require("@modules/auth/auth.routes")
// or
import authRoutes from "@modules/auth/auth.routes";

如果eslint 仍然标记未解析的路径，您可能需要更新您的jsconfig.json 或tsconfig.json 以包含以下内容：

"paths": {
   "@modules/*": ["src/modules/*"]
}

您可以找到软件包文档并阅读有关其用法的更多信息here。