使用 ESLint 禁止項目導入特定模塊

使用 ESLint 禁止項目導入特定模塊

項目團隊成員但願可以禁用某些 JS 依賴。好比有團隊成員但願使用 lodash 而將這個巨大的依賴引入項目，致使項目總體過度臃腫。團隊成員應當使用 lodash-es 來避免這種狀況。那麼 ESLint 就提供了一個名爲 no-restricted-imports 規則，這個規則就是統一規範在項目中禁止使用的依賴。

使用方法

完整配置規則

假設咱們不但願在項目中引入 lodash，那麼配置規則：

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

若是有團隊成員試圖引入 lodash 這個依賴

import _ from 'lodash'

那麼就會報錯，並提示 message 信息

不須要顯示提示信息

若是不須要顯示任何提示信息，那麼 message 能夠被省略，寫法以下：

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

使用 gitignore-style 寫法

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

若是違反規則會出現如下報錯信息：

參考

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