使用 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 禁止项目导入特定模块》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对码农网的支持！

查看所有标签

猜你喜欢:

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

码农书籍

软件研发之道

Jim McCarthy、Michele McCarthy / 赵　俐、石华耀 / 人民邮电出版社 / 2011-8 / 45.00元

Jim McCarlthy等的《软件研发之道微软开发团队的经验法则》叙述了微软Visual C++开发团队的故事，通过作者的总结和归纳告诉读者如何构建一个优秀的软件开发团队，如何在一段时间内成功地交付一个软件。作为升级版，作者将言简意赅的法则扩展到57条，包括了软件研发及营销的全部内容，相信每一位项目经理都会对此书爱不释手。《软件研发之道微软开......一起来看看《软件研发之道》这本书的介绍吧!

码农工具