Skip to content

fix (prefer-bigint-literals): fix add support for numbers/strings with operators #2784

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+356 −12
Open

fix (prefer-bigint-literals): fix add support for numbers/strings with operators #2784

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4ff14c5
fix (prefer-bigint-literals): fix add support for numbers/strings wit…
baevm Oct 20, 2025
a21bf17
fix (prefer-bigint-literals): fix unaryexpression case
baevm Oct 27, 2025
561af07
test (prefer-bigint-literals): add extra tests
baevm Oct 27, 2025
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
51 changes: 40 additions & 11 deletions rules/prefer-bigint-literals.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,13 @@ const messages = {
[MESSAGE_ID_SUGGESTION]: 'Replace with {{replacement}}.',
};

const canUseNumericLiteralRaw = numericLiteral => {
const raw = numericLiteral.raw.replaceAll('_', '').toLowerCase();
const canUseNumericLiteralRaw = (value, nodeRaw) => {
const raw = nodeRaw.replaceAll('_', '').toLowerCase();

if (raw.includes('.')) {
return false;
}

const {value} = numericLiteral;

for (const {prefix, base} of [
{prefix: '0b', base: 2},
{prefix: '0o', base: 8},
Expand All @@ -36,19 +34,37 @@ const canUseNumericLiteralRaw = numericLiteral => {
return raw === String(value);
};

function getValueOfNode(valueNode) {
if (valueNode.type === 'UnaryExpression' && (valueNode.operator === '+' || valueNode.operator === '-')) {
return valueNode.operator === '+'
? {value: valueNode.argument.value, raw: valueNode.argument.raw, isPlusSignUnary: true}
: {value: -valueNode.argument.value, raw: `-${valueNode.argument.raw}`, isPlusSignUnary: false};
}

return {value: valueNode.value, raw: valueNode.raw, isPlusSignUnary: false};
}

function getReplacement(valueNode) {
if (isStringLiteral(valueNode)) {
const raw = valueNode.raw.slice(1, -1);
let raw = valueNode.raw.slice(1, -1);
try {
BigInt(raw);
} catch {
return;
}

// BigInt("+1") -> 1n
const plusSignIndex = raw.indexOf('+');

if (plusSignIndex !== -1) {
raw = raw.slice(0, plusSignIndex) + raw.slice(plusSignIndex + 1);
return {shouldUseSuggestion: true, text: `${raw.trimEnd()}n`};
}

return {shouldUseSuggestion: false, text: `${raw.trimEnd()}n`};
}

const {value, raw} = valueNode;
const {value, raw, isPlusSignUnary} = getValueOfNode(valueNode);

if (!Number.isInteger(value)) {
return;
Expand All @@ -61,7 +77,7 @@ function getReplacement(valueNode) {
return;
}

const shouldUseSuggestion = !canUseNumericLiteralRaw(valueNode);
const shouldUseSuggestion = isPlusSignUnary ? true : !canUseNumericLiteralRaw(value, raw);
const text = shouldUseSuggestion ? `${bigint}n` : `${raw}n`;
return {shouldUseSuggestion, text};
}
Expand All @@ -83,15 +99,28 @@ const create = context => ({
return;
}

let {shouldUseSuggestion, text} = replacement;
let nodeToReplace = callExpression;

const {parent} = callExpression;

// -BigInt(-1) -> 1n
if (
parent.type === 'UnaryExpression'
&& parent.operator === '-'
&& text.startsWith('-')
) {
nodeToReplace = parent;
text = text.slice(1);
}

const problem = {
node: callExpression,
node: nodeToReplace,
messageId: MESSAGE_ID_ERROR,
};

const {shouldUseSuggestion, text} = replacement;

/** @param {import('eslint').Rule.RuleFixer} fixer */
const fix = fixer => fixer.replaceText(callExpression, text);
const fix = fixer => fixer.replaceText(nodeToReplace, text);

if (shouldUseSuggestion || context.sourceCode.getCommentsInside(callExpression).length > 0) {
problem.suggest = [
Expand Down
14 changes: 14 additions & 0 deletions test/prefer-bigint-literals.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ test.snapshot({
'BigInt("1_2")',
'BigInt("1\\\n2")',
String.raw`BigInt("\u{31}")`,
'BigInt(!1)',
'BigInt(~1)',
'BigInt("++1")',
'BigInt("+ 1")',
],
invalid: [
'BigInt("0")',
Expand Down Expand Up @@ -52,5 +56,15 @@ test.snapshot({
'BigInt(1e2)',
'BigInt(/* comment */1)',
`BigInt(${'9'.repeat(100)})`,
'BigInt("-1")',
'BigInt("+1")',
'BigInt(-1)',
'BigInt(+1)',
'-BigInt(-1)',
'-BigInt("-1")',
'-BigInt(1)',
'-BigInt("1")',
'BigInt(" +1 ")',
'BigInt(" -1 ")',
],
});
204 changes: 204 additions & 0 deletions test/snapshots/prefer-bigint-literals.js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,3 +424,207 @@ Generated by [AVA](https://avajs.dev).
Suggestion 1/1: Replace with a bigint literal.␊
1 | 10000000000000000159028911097599180468360808563945281389781327557747838772170381060813469985856815104n␊
`

## invalid(22): BigInt("-1")

> Input

`␊
1 | BigInt("-1")␊
`

> Output

`␊
1 | -1n␊
`

> Error 1/1

`␊
> 1 | BigInt("-1")␊
| ^^^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
`

## invalid(23): BigInt("+1")

> Input

`␊
1 | BigInt("+1")␊
`

> Error 1/1

`␊
> 1 | BigInt("+1")␊
| ^^^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
␊
--------------------------------------------------------------------------------␊
Suggestion 1/1: Replace with \`1n\`.␊
1 | 1n␊
`

## invalid(24): BigInt(-1)

> Input

`␊
1 | BigInt(-1)␊
`

> Output

`␊
1 | -1n␊
`

> Error 1/1

`␊
> 1 | BigInt(-1)␊
| ^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
`

## invalid(25): BigInt(+1)

> Input

`␊
1 | BigInt(+1)␊
`

> Error 1/1

`␊
> 1 | BigInt(+1)␊
| ^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
␊
--------------------------------------------------------------------------------␊
Suggestion 1/1: Replace with \`1n\`.␊
1 | 1n␊
`

## invalid(26): -BigInt(-1)

> Input

`␊
1 | -BigInt(-1)␊
`

> Output

`␊
1 | 1n␊
`

> Error 1/1

`␊
> 1 | -BigInt(-1)␊
| ^^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
`

## invalid(27): -BigInt("-1")

> Input

`␊
1 | -BigInt("-1")␊
`

> Output

`␊
1 | 1n␊
Copy link
Collaborator

@fisker fisker Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of 1n, better fix to -(-1n)

`

> Error 1/1

`␊
> 1 | -BigInt("-1")␊
| ^^^^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
`

## invalid(28): -BigInt(1)

> Input

`␊
1 | -BigInt(1)␊
`

> Output

`␊
1 | -1n␊
`

> Error 1/1

`␊
> 1 | -BigInt(1)␊
| ^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
`

## invalid(29): -BigInt("1")

> Input

`␊
1 | -BigInt("1")␊
`

> Output

`␊
1 | -1n␊
`

> Error 1/1

`␊
> 1 | -BigInt("1")␊
| ^^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
`

## invalid(30): BigInt(" +1 ")

> Input

`␊
1 | BigInt(" +1 ")␊
`

> Error 1/1

`␊
> 1 | BigInt(" +1 ")␊
| ^^^^^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
␊
--------------------------------------------------------------------------------␊
Suggestion 1/1: Replace with \` 1n\`.␊
1 | 1n␊
`

## invalid(31): BigInt(" -1 ")

> Input

`␊
1 | BigInt(" -1 ")␊
`

> Output

`␊
1 | -1n␊
`

> Error 1/1

`␊
> 1 | BigInt(" -1 ")␊
| ^^^^^^^^^^^^^^ Prefer using bigint literal over \`BigInt(…)\`.␊
`
Binary file modified test/snapshots/prefer-bigint-literals.js.snap
View file
Open in desktop
Binary file not shown.