Skip to content

feat(typescript-estree): require import = require() argument to be a string literal #9226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import F = require(1 + 1);

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
import F = require(`1`);

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import type { AST_NODE_TYPES } from '../../ast-node-types';
import type { BaseNode } from '../../base/BaseNode';
import type { Expression } from '../../unions/Expression';
import type { StringLiteral } from '../../expression/literal/StringLiteral/spec';

export interface TSExternalModuleReference extends BaseNode {
type: AST_NODE_TYPES.TSExternalModuleReference;
// TODO(#1852) - this must be a string
expression: Expression;
expression: StringLiteral;
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import type { TSESTree } from '@typescript-eslint/utils';
import { AST_NODE_TYPES } from '@typescript-eslint/utils';

import { createRule } from '../util';

Expand Down Expand Up @@ -62,10 +61,7 @@ export default createRule({
node: TSESTree.TSExternalModuleReference,
): void {
const parent = node.parent as TSESTree.TSImportEqualsDeclaration;
if (
node.expression.type === AST_NODE_TYPES.Literal &&
node.expression.value === 'typescript'
) {
if (node.expression.value === 'typescript') {
context.report({
node,
messageId: 'noTSDefaultImport',
Expand Down
5 changes: 1 addition & 4 deletions packages/eslint-plugin/src/rules/no-restricted-imports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,7 @@ export default createRule<Options, MessageIds>({
node: TSESTree.TSImportEqualsDeclaration,
): void {
if (
node.moduleReference.type ===
AST_NODE_TYPES.TSExternalModuleReference &&
node.moduleReference.expression.type === AST_NODE_TYPES.Literal &&
typeof node.moduleReference.expression.value === 'string'
node.moduleReference.type === AST_NODE_TYPES.TSExternalModuleReference
) {
const synthesizedImport = {
...node,
Expand Down
15 changes: 0 additions & 15 deletions packages/eslint-plugin/tests/rules/no-require-imports.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ require('remark-preset-prettier');
code: "import pkg = require('some-package');",
options: [{ allow: ['^some-package$'] }],
},
{
code: 'import pkg = require(`some-package`);',
options: [{ allow: ['^some-package$'] }],
},
],
invalid: [
{
Expand Down Expand Up @@ -207,16 +203,5 @@ var lib5 = require?.('lib5'),
},
],
},
{
code: 'import pkg = require(`./package.json`);',
options: [{ allow: ['^some-package$'] }],
errors: [
{
line: 1,
column: 14,
messageId: 'noRequireImports',
},
],
},
],
});
3 changes: 3 additions & 0 deletions packages/typescript-estree/src/convert.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3107,6 +3107,9 @@ export class Converter {
);
}
case SyntaxKind.ExternalModuleReference: {
if (node.expression.kind !== SyntaxKind.StringLiteral) {
this.#throwError(node.expression, 'String literal expected.');
}
return this.createNode<TSESTree.TSExternalModuleReference>(node, {
type: AST_NODE_TYPES.TSExternalModuleReference,
expression: this.convertChild(node.expression),
Expand Down