typescript-eslint · bradzacher · May 28, 2024 · Jan 30, 2024 · Feb 1, 2024 · Feb 1, 2024
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -162,6 +162,12 @@ export default tseslint.config(
           ignorePrimitives: true,
         },
       ],
+      '@typescript-eslint/no-require-imports': [
+        'error',
+        {
+          allow: ['/package\\.json$'],
+        },
+      ],
 
       //
       // Internal repo rules

diff --git a/packages/ast-spec/tests/fixtures.test.ts b/packages/ast-spec/tests/fixtures.test.ts
@@ -1,5 +1,5 @@
 import fs from 'fs';
-import glob = require('glob');
+import * as glob from 'glob';
 import makeDir from 'make-dir';
 import path from 'path';
 
@@ -66,6 +66,7 @@ const FIXTURES: readonly Fixture[] = [...VALID_FIXTURES, ...ERROR_FIXTURES].map(
       absolute,
       config: ((): ASTFixtureConfig => {
         try {
+          // eslint-disable-next-line @typescript-eslint/no-require-imports
           return require(configPath).default;
         } catch {
           return {};

diff --git a/packages/eslint-plugin/docs/rules/no-require-imports.mdx b/packages/eslint-plugin/docs/rules/no-require-imports.mdx
@@ -38,7 +38,7 @@ import * as lib3 from 'lib3';
 
 ### `allow`
 
-A array of strings. These strings will be compiled into regular expressions with the `u` flag and be used to test against the imported path. A common use case is to allow importing `package.json`. This is because `package.json` commonly lives outside of the TS root directory, so statically importing it would lead to root directory conflicts, especially with `resolveJsonModule` enabled. You can also use it to allow importing any JSON if your environment doesn't support JSON modules, or use it for other cases where `import` statements cannot work.
+An array of strings. These strings will be compiled into regular expressions with the `u` flag and be used to test against the imported path. A common use case is to allow importing `package.json`. This is because `package.json` commonly lives outside of the TS root directory, so statically importing it would lead to root directory conflicts, especially with `resolveJsonModule` enabled. You can also use it to allow importing any JSON if your environment doesn't support JSON modules, or use it for other cases where `import` statements cannot work.
 
 With `{allow: ['/package\\.json$']}`:
 
@@ -59,6 +59,33 @@ console.log(require('../package.json').version);
 </TabItem>
 </Tabs>
 
+### `allowAsImport`
+
+When set to `true`, the `import x = require(...)` declaration won't be reported.
+This is useful if you use certain module options that require strict CommonJS interop semantics.
+
+With `{allowAsImport: true}`:
+
+<Tabs>
+<TabItem value="❌ Incorrect">
+
+```ts option='{ "allowAsImport": true }'
+var foo = require('foo');
+const foo = require('foo');
+let foo = require('foo');
+```
+
+</TabItem>
+<TabItem value="✅ Correct">
+
+```ts option='{ "allowAsImport": true }'
+import foo = require('foo');
+import foo from 'foo';
+```
+
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project frequently uses older CommonJS `require`s, then this rule might not be applicable to you.

diff --git a/packages/eslint-plugin/docs/rules/no-var-requires.mdx b/packages/eslint-plugin/docs/rules/no-var-requires.mdx
@@ -9,6 +9,12 @@ import TabItem from '@theme/TabItem';
 >
 > See **https://typescript-eslint.io/rules/no-var-requires** for documentation.
 
+:::danger Deprecated
+
+This rule has been deprecated in favour of the [`@typescript-eslint/no-require-imports`](./no-require-imports.mdx) rule.
+
+:::
+
 In other words, the use of forms such as `var foo = require("foo")` are banned. Instead use ES6 style imports or `import foo = require("foo")` imports.
 
 ## Examples

diff --git a/packages/eslint-plugin/src/configs/all.ts b/packages/eslint-plugin/src/configs/all.ts
@@ -112,7 +112,6 @@ export = {
     '@typescript-eslint/no-useless-constructor': 'error',
     '@typescript-eslint/no-useless-empty-export': 'error',
     '@typescript-eslint/no-useless-template-literals': 'error',
-    '@typescript-eslint/no-var-requires': 'error',
     '@typescript-eslint/non-nullable-type-assertion-style': 'error',
     'no-throw-literal': 'off',
     '@typescript-eslint/only-throw-error': 'error',

diff --git a/packages/eslint-plugin/src/configs/recommended-type-checked.ts b/packages/eslint-plugin/src/configs/recommended-type-checked.ts
@@ -31,6 +31,7 @@ export = {
     '@typescript-eslint/no-namespace': 'error',
     '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
     '@typescript-eslint/no-redundant-type-constituents': 'error',
+    '@typescript-eslint/no-require-imports': 'error',
     '@typescript-eslint/no-this-alias': 'error',
     '@typescript-eslint/no-unnecessary-type-assertion': 'error',
     '@typescript-eslint/no-unnecessary-type-constraint': 'error',
@@ -47,7 +48,6 @@ export = {
     'no-unused-vars': 'off',
     '@typescript-eslint/no-unused-vars': 'error',
     '@typescript-eslint/no-useless-template-literals': 'error',
-    '@typescript-eslint/no-var-requires': 'error',
     'no-throw-literal': 'off',
     '@typescript-eslint/only-throw-error': 'error',
     '@typescript-eslint/prefer-as-const': 'error',

diff --git a/packages/eslint-plugin/src/configs/recommended.ts b/packages/eslint-plugin/src/configs/recommended.ts
@@ -21,14 +21,14 @@ export = {
     '@typescript-eslint/no-misused-new': 'error',
     '@typescript-eslint/no-namespace': 'error',
     '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
+    '@typescript-eslint/no-require-imports': 'error',
     '@typescript-eslint/no-this-alias': 'error',
     '@typescript-eslint/no-unnecessary-type-constraint': 'error',
     '@typescript-eslint/no-unsafe-declaration-merging': 'error',
     'no-unused-expressions': 'off',
     '@typescript-eslint/no-unused-expressions': 'error',
     'no-unused-vars': 'off',
     '@typescript-eslint/no-unused-vars': 'error',
-    '@typescript-eslint/no-var-requires': 'error',
     '@typescript-eslint/prefer-as-const': 'error',
     '@typescript-eslint/prefer-namespace-keyword': 'error',
     '@typescript-eslint/triple-slash-reference': 'error',

diff --git a/packages/eslint-plugin/src/configs/strict-type-checked.ts b/packages/eslint-plugin/src/configs/strict-type-checked.ts
@@ -42,6 +42,7 @@ export = {
     '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
     '@typescript-eslint/no-non-null-assertion': 'error',
     '@typescript-eslint/no-redundant-type-constituents': 'error',
+    '@typescript-eslint/no-require-imports': 'error',
     '@typescript-eslint/no-this-alias': 'error',
     '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
     '@typescript-eslint/no-unnecessary-condition': 'error',
@@ -63,7 +64,6 @@ export = {
     'no-useless-constructor': 'off',
     '@typescript-eslint/no-useless-constructor': 'error',
     '@typescript-eslint/no-useless-template-literals': 'error',
-    '@typescript-eslint/no-var-requires': 'error',
     'no-throw-literal': 'off',
     '@typescript-eslint/only-throw-error': 'error',
     '@typescript-eslint/prefer-as-const': 'error',

diff --git a/packages/eslint-plugin/src/configs/strict.ts b/packages/eslint-plugin/src/configs/strict.ts
@@ -29,6 +29,7 @@ export = {
     '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
     '@typescript-eslint/no-non-null-asserted-optional-chain': 'error',
     '@typescript-eslint/no-non-null-assertion': 'error',
+    '@typescript-eslint/no-require-imports': 'error',
     '@typescript-eslint/no-this-alias': 'error',
     '@typescript-eslint/no-unnecessary-type-constraint': 'error',
     '@typescript-eslint/no-unsafe-declaration-merging': 'error',
@@ -38,7 +39,6 @@ export = {
     '@typescript-eslint/no-unused-vars': 'error',
     'no-useless-constructor': 'off',
     '@typescript-eslint/no-useless-constructor': 'error',
-    '@typescript-eslint/no-var-requires': 'error',
     '@typescript-eslint/prefer-as-const': 'error',
     '@typescript-eslint/prefer-literal-enum-member': 'error',
     '@typescript-eslint/prefer-namespace-keyword': 'error',

diff --git a/packages/eslint-plugin/src/rules/no-require-imports.ts b/packages/eslint-plugin/src/rules/no-require-imports.ts
@@ -5,7 +5,8 @@ import * as util from '../util';
 
 type Options = [
   {
-    allow: string[];
+    allow?: string[];
+    allowAsImport?: boolean;
   },
 ];
 type MessageIds = 'noRequireImports';
@@ -16,6 +17,7 @@ export default util.createRule<Options, MessageIds>({
     type: 'problem',
     docs: {
       description: 'Disallow invocation of `require()`',
+      recommended: 'recommended',
     },
     schema: [
       {
@@ -26,6 +28,10 @@ export default util.createRule<Options, MessageIds>({
             items: { type: 'string' },
             description: 'Patterns of import paths to allow requiring from.',
           },
+          allowAsImport: {
+            type: 'boolean',
+            description: 'Allows `require` statements in import declarations.',
+          },
         },
         additionalProperties: false,
       },
@@ -34,13 +40,14 @@ export default util.createRule<Options, MessageIds>({
       noRequireImports: 'A `require()` style import is forbidden.',
     },
   },
-  defaultOptions: [{ allow: [] }],
+  defaultOptions: [{ allow: [], allowAsImport: false }],
   create(context, options) {
-    const allowPatterns = options[0].allow.map(
+    const allowAsImport = options[0].allowAsImport;
+    const allowPatterns = options[0].allow?.map(
       pattern => new RegExp(pattern, 'u'),
     );
-    function isImportPathAllowed(importPath: string): boolean {
-      return allowPatterns.some(pattern => importPath.match(pattern));
+    function isImportPathAllowed(importPath: string): boolean | undefined {
+      return allowPatterns?.some(pattern => importPath.match(pattern));
     }
     function isStringOrTemplateLiteral(node: TSESTree.Node): boolean {
       return (
@@ -64,7 +71,6 @@ export default util.createRule<Options, MessageIds>({
           context.sourceCode.getScope(node),
           'require',
         );
-
         // ignore non-global require usage as it's something user-land custom instead
         // of the commonjs standard
         if (!variable?.identifiers.length) {
@@ -81,6 +87,12 @@ export default util.createRule<Options, MessageIds>({
             return;
           }
         }
+        if (
+          allowAsImport &&
+          node.parent.type === AST_NODE_TYPES.TSImportEqualsDeclaration
+        ) {
+          return;
+        }
         context.report({
           node,
           messageId: 'noRequireImports',

diff --git a/packages/eslint-plugin/src/rules/no-var-requires.ts b/packages/eslint-plugin/src/rules/no-var-requires.ts
@@ -13,10 +13,11 @@ type MessageIds = 'noVarReqs';
 export default createRule<Options, MessageIds>({
   name: 'no-var-requires',
   meta: {
+    deprecated: true,
+    replacedBy: ['@typescript-eslint/no-require-imports'],
     type: 'problem',
     docs: {
       description: 'Disallow `require` statements except in import statements',
-      recommended: 'recommended',
     },
     messages: {
       noVarReqs: 'Require statement not part of import statement.',

diff --git a/packages/eslint-plugin/tests/docs-eslint-output-snapshots/no-require-imports.shot b/packages/eslint-plugin/tests/docs-eslint-output-snapshots/no-require-imports.shot