使用 ESLint 禁止项目导入特定模块

栏目: JavaScript · 发布时间: 6年前

内容简介：项目团队成员希望能够禁用某些 JS 依赖。比如有团队成员希望使用 lodash 而将这个巨大的依赖引入项目，导致项目整体过分臃肿。团队成员应当使用 lodash-es 来避免这种情况。那么 ESLint 就提供了一个名为假设我们不希望在项目中引入 lodash，那么配置规则：

使用 ESLint 禁止项目导入特定模块

项目团队成员希望能够禁用某些 JS 依赖。比如有团队成员希望使用 lodash 而将这个巨大的依赖引入项目，导致项目整体过分臃肿。团队成员应当使用 lodash-es 来避免这种情况。那么 ESLint 就提供了一个名为 no-restricted-imports 规则，这个规则就是统一规范在项目中禁止使用的依赖。

使用 ESLint 禁止项目导入特定模块

使用方法

完整配置规则

假设我们不希望在项目中引入 lodash，那么配置规则：

rules: {
    'no-restricted-imports': [
        'error',
        {
            paths: [{
                name: 'lodash',
                message: '不要使用 lodash，请使用 lodash-es 作为替代'
            }]
        }
    ]
}

如果有团队成员试图引入 lodash 这个依赖

import _ from 'lodash'

那么就会报错，并提示 message 信息

使用 ESLint 禁止项目导入特定模块

不需要显示提示信息

如果不需要显示任何提示信息，那么 message 可以被省略，写法如下：

'no-restricted-imports': ['error', 'lodash', 'underscore']

使用 gitignore-style 写法

'no-restricted-imports': ['error', {
    patterns: ['lodash-es/*']
}]

如果违反规则会出现以下报错信息：

使用 ESLint 禁止项目导入特定模块

参考

https://eslint.org/docs/rules/no-restricted-imports

使用 ESLint 禁止项目导入特定模块

以上所述就是小编给大家介绍的《使用 ESLint 禁止项目导入特定模块》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对码农网的支持！

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

理解专业程序员

（美）杰拉尔德·温伯格（GeraldM.Weinberg） / 刘天北 / 清华大学出版社 / 2006-7 / 25.00元

《理解专业程序员》通过行内专家的独特视角，介绍了如何成为优秀程序员，如何提高工作绩效等问题。全书由多篇讨论程序员职业的短文组成，内容精彩绝伦，是一部任何在这个变化急剧的领域工作的人都不可错过的重要作品。本书论述生动翔实——你肯定能从中认出你自己和你的公司的故事——因此不仅极富教益，而且读来也引人入胜。各篇主题包括：对于专业程序员重要的若干问题，成为专业程序员的途径，在企业官僚体......一起来看看《理解专业程序员》这本书的介绍吧!

码农工具