@typescript-eslint/eslint-plugin 7.3.2-alpha.1 → 7.3.2-alpha.11

package/docs/rules/no-throw-literal.mdx

@@ -12,104 +12,14 @@ import TabItem from '@theme/TabItem';
 It is considered good practice to only `throw` the `Error` object itself or an object using the `Error` object as base objects for user-defined exceptions.
 The fundamental benefit of `Error` objects is that they automatically keep track of where they were built and originated.
 
-This rule restricts what can be thrown as an exception. When it was first created, it only prevented literals from being thrown (hence the name), but it has now been expanded to only allow expressions which have a possibility of being an `Error` object. With the `allowThrowingAny` and `allowThrowingUnknown`, it can be configured to only allow throwing values which are guaranteed to be an instance of `Error`.
+This rule restricts what can be thrown as an exception.
 
-## Examples
+:::warning
+This rule is being renamed to [`only-throw-error`](./only-throw-error.mdx).
+When it was first created, it only prevented literals from being thrown (hence the name), but it has now been expanded to only allow expressions which have a possibility of being an `Error` object.
+With the `allowThrowingAny` and `allowThrowingUnknown` options, it can be configured to only allow throwing values which are guaranteed to be an instance of `Error`.
 
-This rule is aimed at maintaining consistency when throwing exception by disallowing to throw literals and other expressions which cannot possibly be an `Error` object.
-
-<Tabs>
-<TabItem value="❌ Incorrect">
-
-```ts
-throw 'error';
-
-throw 0;
-
-throw undefined;
-
-throw null;
-
-const err = new Error();
-throw 'an ' + err;
-
-const err = new Error();
-throw `${err}`;
-
-const err = '';
-throw err;
-
-function err() {
-  return '';
-}
-throw err();
-
-const foo = {
-  bar: '',
-};
-throw foo.bar;
-```
-
-</TabItem>
-<TabItem value="✅ Correct">
-
-```ts
-throw new Error();
-
-throw new Error('error');
-
-const e = new Error('error');
-throw e;
-
-try {
-  throw new Error('error');
-} catch (e) {
-  throw e;
-}
-
-const err = new Error();
-throw err;
-
-function err() {
-  return new Error();
-}
-throw err();
-
-const foo = {
-  bar: new Error(),
-};
-throw foo.bar;
-
-class CustomError extends Error {
-  // ...
-}
-throw new CustomError();
-```
-
-</TabItem>
-</Tabs>
-
-## Options
-
-This rule adds the following options:
-
-```ts
-interface Options {
-  /**
-   * Whether to always allow throwing values typed as `any`.
-   */
-  allowThrowingAny?: boolean;
-
-  /**
-   * Whether to always allow throwing values typed as `unknown`.
-   */
-  allowThrowingUnknown?: boolean;
-}
-
-const defaultOptions: Options = {
-  allowThrowingAny: false,
-  allowThrowingUnknown: false,
-};
-```
+The current name `no-throw-literal` will be removed in a future major version of typescript-eslint.
+:::
 
 {/* Intentionally Omitted: When Not To Use It */}

package/docs/rules/only-throw-error.mdx

@@ -0,0 +1,115 @@
+---
+description: 'Disallow throwing non-`Error` values as exceptions.'
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/only-throw-error** for documentation.
+
+It is considered good practice to only `throw` the `Error` object itself or an object using the `Error` object as base objects for user-defined exceptions.
+The fundamental benefit of `Error` objects is that they automatically keep track of where they were built and originated.
+
+This rule restricts what can be thrown as an exception.
+
+## Examples
+
+This rule is aimed at maintaining consistency when throwing exception by disallowing to throw literals and other expressions which cannot possibly be an `Error` object.
+
+<Tabs>
+<TabItem value="❌ Incorrect">
+
+```ts
+throw 'error';
+
+throw 0;
+
+throw undefined;
+
+throw null;
+
+const err = new Error();
+throw 'an ' + err;
+
+const err = new Error();
+throw `${err}`;
+
+const err = '';
+throw err;
+
+function err() {
+  return '';
+}
+throw err();
+
+const foo = {
+  bar: '',
+};
+throw foo.bar;
+```
+
+</TabItem>
+<TabItem value="✅ Correct">
+
+```ts
+throw new Error();
+
+throw new Error('error');
+
+const e = new Error('error');
+throw e;
+
+try {
+  throw new Error('error');
+} catch (e) {
+  throw e;
+}
+
+const err = new Error();
+throw err;
+
+function err() {
+  return new Error();
+}
+throw err();
+
+const foo = {
+  bar: new Error(),
+};
+throw foo.bar;
+
+class CustomError extends Error {
+  // ...
+}
+throw new CustomError();
+```
+
+</TabItem>
+</Tabs>
+
+## Options
+
+This rule adds the following options:
+
+```ts
+interface Options {
+  /**
+   * Whether to always allow throwing values typed as `any`.
+   */
+  allowThrowingAny?: boolean;
+
+  /**
+   * Whether to always allow throwing values typed as `unknown`.
+   */
+  allowThrowingUnknown?: boolean;
+}
+
+const defaultOptions: Options = {
+  allowThrowingAny: false,
+  allowThrowingUnknown: false,
+};
+```
+
+{/* Intentionally Omitted: When Not To Use It */}

package/docs/rules/restrict-template-expressions.mdx

@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
 
 JavaScript automatically [converts an object to a string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String#string_coercion) in a string context, such as when concatenating it with a string using `+` or embedding it in a template literal using `${}`.
 The default `toString()` method of objects returns `"[object Object]"`, which is often not what was intended.
-This rule reports on values used in a template literal string that aren't strings, numbers, or BigInts, optionally allowing other data types that provide useful stringification results.
+This rule reports on values used in a template literal string that aren't strings, optionally allowing other data types that provide useful stringification results.
 
 :::note
 

package/docs/rules/switch-exhaustiveness-check.mdx

@@ -34,7 +34,7 @@ If your project has many intentionally redundant `default` cases, you may want t
 
 ### `requireDefaultForNonUnion`
 
-Defaults to false. It set to true, this rule will also report when a `switch` statement switches over a non-union type (like a `number` or `string`, for example) and that `switch` statement does not have a `default` case. Thus, by setting this option to true, the rule becomes stricter.
+Defaults to false. If set to true, this rule will also report when a `switch` statement switches over a non-union type (like a `number` or `string`, for example) and that `switch` statement does not have a `default` case. Thus, by setting this option to true, the rule becomes stricter.
 
 This is generally desirable so that `number` and `string` switches will be subject to the same exhaustive checks that your other switches are.
 

package/docs/rules/unbound-method.mdx

@@ -68,8 +68,8 @@ const { logBound } = instance;
 logBound();
 
 // .bind and lambdas will also add a correct scope
-const dotBindLog = instance.logBound.bind(instance);
-const innerLog = () => instance.logBound();
+const dotBindLog = instance.logUnbound.bind(instance);
+const innerLog = () => instance.logUnbound();
 
 // arith.double explicitly declares that it does not refer to `this` internally
 const arith = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-eslint/eslint-plugin",
-  "version": "7.3.2-alpha.1",
+  "version": "7.3.2-alpha.11",
   "description": "TypeScript plugin for ESLint",
   "files": [
     "dist",
@@ -61,10 +61,10 @@
   },
   "dependencies": {
     "@eslint-community/regexpp": "^4.5.1",
-    "@typescript-eslint/scope-manager": "7.3.2-alpha.1",
-    "@typescript-eslint/type-utils": "7.3.2-alpha.1",
-    "@typescript-eslint/utils": "7.3.2-alpha.1",
-    "@typescript-eslint/visitor-keys": "7.3.2-alpha.1",
+    "@typescript-eslint/scope-manager": "7.3.2-alpha.11",
+    "@typescript-eslint/type-utils": "7.3.2-alpha.11",
+    "@typescript-eslint/utils": "7.3.2-alpha.11",
+    "@typescript-eslint/visitor-keys": "7.3.2-alpha.11",
     "debug": "^4.3.4",
     "graphemer": "^1.4.0",
     "ignore": "^5.2.4",
@@ -77,7 +77,7 @@
     "@types/marked": "*",
     "@types/natural-compare": "*",
     "@typescript-eslint/rule-schema-to-typescript-types": "7.3.1",
-    "@typescript-eslint/rule-tester": "7.3.2-alpha.1",
+    "@typescript-eslint/rule-tester": "7.3.2-alpha.11",
     "ajv": "^6.12.6",
     "chalk": "^5.3.0",
     "cross-env": "^7.0.3",