feat(eslint-plugin): Add BigInt object type to default ban-types list (…

…#4970) * Add BigInt object type to default ban-types list * Update documentation with bigint type added
typescript-eslint · May 14, 2022 · 1867728 · 1867728
1 parent 0377070
commit 1867728
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/packages/eslint-plugin/docs/rules/ban-types.md b/packages/eslint-plugin/docs/rules/ban-types.md
@@ -105,6 +105,10 @@ const defaultTypes = {
     message: 'Use symbol instead',
     fixWith: 'symbol',
   },
+  BigInt: {
+    message: 'Use bigint instead',
+    fixWith: 'bigint',
+  },
 
   Function: {
     message: [
@@ -149,6 +153,7 @@ const str: String = 'foo';
 const bool: Boolean = true;
 const num: Number = 1;
 const symb: Symbol = Symbol('foo');
+const bigInt: BigInt = 1n;
 
 // use a proper function type
 const func: Function = () => 1;
@@ -169,6 +174,7 @@ const str: string = 'foo';
 const bool: boolean = true;
 const num: number = 1;
 const symb: symbol = Symbol('foo');
+const bigInt: bigint = 1n;
 
 // use a proper function type
 const func: () => number = () => 1;

diff --git a/packages/eslint-plugin/src/rules/ban-types.ts b/packages/eslint-plugin/src/rules/ban-types.ts
@@ -66,6 +66,10 @@ const defaultTypes: Types = {
     message: 'Use symbol instead',
     fixWith: 'symbol',
   },
+  BigInt: {
+    message: 'Use bigint instead',
+    fixWith: 'bigint',
+  },
 
   Function: {
     message: [