feat: add rule no-import-node-modules-by-path (#219)

This commit is contained in:
曾明健 2023-08-01 22:59:19 +08:00 committed by GitHub
parent 0ff5e45fdd
commit cf1240c847
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 76 additions and 0 deletions

View File

@ -396,6 +396,7 @@ module.exports = {
'yml/no-empty-document': 'off', 'yml/no-empty-document': 'off',
// antfu // antfu
'antfu/no-import-node-modules-by-path': 'error',
'antfu/if-newline': 'error', 'antfu/if-newline': 'error',
'antfu/import-dedupe': 'error', 'antfu/import-dedupe': 'error',
'antfu/top-level-function': 'error', 'antfu/top-level-function': 'error',

View File

@ -3,6 +3,7 @@ import ifNewline from './rules/if-newline'
import importDedupe from './rules/import-dedupe' import importDedupe from './rules/import-dedupe'
import preferInlineTypeImport from './rules/prefer-inline-type-import' import preferInlineTypeImport from './rules/prefer-inline-type-import'
import topLevelFunction from './rules/top-level-function' import topLevelFunction from './rules/top-level-function'
import noImportNodeModulesByPath from './rules/no-import-node-modules-by-path'
import noTsExportEqual from './rules/no-ts-export-equal' import noTsExportEqual from './rules/no-ts-export-equal'
import noCjsExports from './rules/no-cjs-exports' import noCjsExports from './rules/no-cjs-exports'
import noConstEnum from './rules/no-const-enum' import noConstEnum from './rules/no-const-enum'
@ -15,6 +16,7 @@ export default {
'prefer-inline-type-import': preferInlineTypeImport, 'prefer-inline-type-import': preferInlineTypeImport,
'generic-spacing': genericSpacing, 'generic-spacing': genericSpacing,
'top-level-function': topLevelFunction, 'top-level-function': topLevelFunction,
'no-import-node-modules-by-path': noImportNodeModulesByPath,
'no-cjs-exports': noCjsExports, 'no-cjs-exports': noCjsExports,
'no-ts-export-equal': noTsExportEqual, 'no-ts-export-equal': noTsExportEqual,
'no-const-enum': noConstEnum, 'no-const-enum': noConstEnum,

View File

@ -0,0 +1,31 @@
import { RuleTester } from '@typescript-eslint/utils/dist/ts-eslint'
import { it } from 'vitest'
import rule, { RULE_NAME } from './no-import-node-modules-by-path'
const valids = [
'import xxx from "a"',
'import "b"',
'const c = require("c")',
'require("d")',
]
const invalids = [
'import a from "../node_modules/a"',
'import "../node_modules/b"',
'const c = require("../node_modules/c")',
'require("../node_modules/d")',
]
it('runs', () => {
const ruleTester: RuleTester = new RuleTester({
parser: require.resolve('@typescript-eslint/parser'),
})
ruleTester.run(RULE_NAME, rule, {
valid: valids,
invalid: invalids.map(i => ({
code: i,
errors: [{ messageId: 'noImportNodeModulesByPath' }],
})),
})
})

View File

@ -0,0 +1,42 @@
import { createEslintRule } from '../utils'
export const RULE_NAME = 'no-import-node-modules-by-path'
export type MessageIds = 'noImportNodeModulesByPath'
export type Options = []
export default createEslintRule<Options, MessageIds>({
name: RULE_NAME,
meta: {
type: 'problem',
docs: {
description: 'Prevent importing modules in `node_modules` folder by relative or absolute path',
recommended: 'error',
},
schema: [],
messages: {
noImportNodeModulesByPath: 'Do not import modules in `node_modules` folder by path',
},
},
defaultOptions: [],
create: (context) => {
return {
'ImportDeclaration': (node) => {
if (node.source.value.includes('/node_modules/')) {
context.report({
node,
messageId: 'noImportNodeModulesByPath',
})
}
},
'CallExpression[callee.name="require"]': (node: any) => {
const value = node.arguments[0]?.value
if (typeof value === 'string' && value.includes('/node_modules/')) {
context.report({
node,
messageId: 'noImportNodeModulesByPath',
})
}
},
}
},
})