useBigintLiterals (JavaScript)

Language JavaScript (and super languages)

Summary

Diagnostic Category: lint/nursery/useBigintLiterals
This rule has a safe fix.
The default severity of this rule is warning.
Sources:
- Same as unicorn/prefer-bigint-literals

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "useBigintLiterals": "error"
6
      }
7
    }
8
  }
9
}

Description

Enforce the use of bigint literals over the BigInt() constructor.

A bigint literal with the n suffix is more concise than calling BigInt() with a number or string literal, and it is evaluated at parse time rather than converted at runtime.

The rule only reports calls whose argument is a number or string literal that can be expressed as a bigint literal. Calls with a computed argument are ignored.

Examples

Invalid

1
const bigint = BigInt(1);

code-block.js:1:16 lint/nursery/useBigintLiterals  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This BigInt() call can be replaced with a bigint literal.
  
  > 1 │ const bigint = BigInt(1);
      │                ^^^^^^^^^
    2 │ 
  
  ℹ A bigint literal with the n suffix is more concise, and it is evaluated at parse time instead of being converted at runtime.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Safe fix: Replace with a bigint literal.
  
    1   │ - const·bigint·=·BigInt(1);
      1 │ + const·bigint·=·1n;
    2 2 │

1
const large = BigInt("9007199254740993");

code-block.js:1:15 lint/nursery/useBigintLiterals  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This BigInt() call can be replaced with a bigint literal.
  
  > 1 │ const large = BigInt("9007199254740993");
      │               ^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ A bigint literal with the n suffix is more concise, and it is evaluated at parse time instead of being converted at runtime.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Safe fix: Replace with a bigint literal.
  
    1   │ - const·large·=·BigInt("9007199254740993");
      1 │ + const·large·=·9007199254740993n;
    2 2 │

1
const hex = BigInt("0xFF");

code-block.js:1:13 lint/nursery/useBigintLiterals  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This BigInt() call can be replaced with a bigint literal.
  
  > 1 │ const hex = BigInt("0xFF");
      │             ^^^^^^^^^^^^^^
    2 │ 
  
  ℹ A bigint literal with the n suffix is more concise, and it is evaluated at parse time instead of being converted at runtime.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Safe fix: Replace with a bigint literal.
  
    1   │ - const·hex·=·BigInt("0xFF");
      1 │ + const·hex·=·0xFFn;
    2 2 │

1
const negative = BigInt(-1);

code-block.js:1:18 lint/nursery/useBigintLiterals  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ This BigInt() call can be replaced with a bigint literal.
  
  > 1 │ const negative = BigInt(-1);
      │                  ^^^^^^^^^^
    2 │ 
  
  ℹ A bigint literal with the n suffix is more concise, and it is evaluated at parse time instead of being converted at runtime.
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  
  ℹ Safe fix: Replace with a bigint literal.
  
    1   │ - const·negative·=·BigInt(-1);
      1 │ + const·negative·=·-1n;
    2 2 │

Valid

1
const bigint = 1n;
2
const large = 9007199254740993n;
3
const hex = 0xFFn;
4
const computed = BigInt(getSomeNumber());
5
const fraction = BigInt(1.5);