From 744a2d570b7841e571f79727a8c8ba245a0555ee Mon Sep 17 00:00:00 2001
From: Josh Goldberg <git@joshuakgoldberg.com>
Date: Thu, 6 Jun 2024 11:13:24 -0400
Subject: [PATCH 1/3] docs: add minimal docs page for type-utils package

---
 docs/packages/Type_Utils.mdx                  | 17 ++++++++++
 packages/type-utils/src/builtinSymbolLikes.ts | 33 ++++++++++++++-----
 packages/website/sidebars/sidebar.base.js     |  1 +
 3 files changed, 42 insertions(+), 9 deletions(-)
 create mode 100644 docs/packages/Type_Utils.mdx

diff --git a/docs/packages/Type_Utils.mdx b/docs/packages/Type_Utils.mdx
new file mode 100644
index 000000000000..24ea50f004e6
--- /dev/null
+++ b/docs/packages/Type_Utils.mdx
@@ -0,0 +1,17 @@
+---
+id: type-utils
+sidebar_label: type-utils
+---
+
+# `@typescript-eslint/type-utils`
+
+<PackageLink packageName="type-utils" scope="@typescript-eslint" />
+
+> Type utilities for working with TypeScript types ✨
+
+This package contains public utilities for working with TypeScript types.
+Rules declared in [`@typescript-eslint/eslint-plugin`](./ESLint_Plugin.mdx) use these utility functions.
+
+The utilities in this package are separated from [`@typescript-eslint/utils`](./Utils.mdx) so that that package does not require a dependency on `typescript`.
+
+> See [Custom Rules](../developers/Custom_Rules.mdx) for documentation on creating your own custom ESLint rules for TypeScript code.
diff --git a/packages/type-utils/src/builtinSymbolLikes.ts b/packages/type-utils/src/builtinSymbolLikes.ts
index 3443a0d0382e..a2a03a692a26 100644
--- a/packages/type-utils/src/builtinSymbolLikes.ts
+++ b/packages/type-utils/src/builtinSymbolLikes.ts
@@ -3,18 +3,24 @@ import * as ts from 'typescript';
 import { isSymbolFromDefaultLibrary } from './isSymbolFromDefaultLibrary';
 
 /**
- * class Foo extends Promise<number> {}
- * Foo.reject
- *  ^ PromiseLike
+ * @example
+ * ```ts
+ * class DerivedClass extends Promise<number> {}
+ * DerivedClass.reject
+ * // ^ PromiseLike
+ * ```
  */
 export function isPromiseLike(program: ts.Program, type: ts.Type): boolean {
   return isBuiltinSymbolLike(program, type, 'Promise');
 }
 
 /**
- * const foo = Promise
- * foo.reject
- *  ^ PromiseConstructorLike
+ * @example
+ * ```ts
+ * const value = Promise
+ * value.reject
+ * // ^ PromiseConstructorLike
+ * ```
  */
 export function isPromiseConstructorLike(
   program: ts.Program,
@@ -24,17 +30,23 @@ export function isPromiseConstructorLike(
 }
 
 /**
+ * @example
+ * ```ts
  * class Foo extends Error {}
  * new Foo()
- *      ^ ErrorLike
+ * //   ^ ErrorLike
+ * ```
  */
 export function isErrorLike(program: ts.Program, type: ts.Type): boolean {
   return isBuiltinSymbolLike(program, type, 'Error');
 }
 
 /**
+ * @example
+ * ```ts
  * type T = Readonly<Error>
- *      ^ ReadonlyErrorLike
+ * //   ^ ReadonlyErrorLike
+ * ```
  */
 export function isReadonlyErrorLike(
   program: ts.Program,
@@ -50,8 +62,11 @@ export function isReadonlyErrorLike(
 }
 
 /**
+ * @example
+ * ```ts
  * type T = Readonly<{ foo: 'bar' }>
- *      ^ ReadonlyTypeLike
+ * //   ^ ReadonlyTypeLike
+ * ```
  */
 export function isReadonlyTypeLike(
   program: ts.Program,
diff --git a/packages/website/sidebars/sidebar.base.js b/packages/website/sidebars/sidebar.base.js
index 4676e1e43612..02cbad567249 100644
--- a/packages/website/sidebars/sidebar.base.js
+++ b/packages/website/sidebars/sidebar.base.js
@@ -84,6 +84,7 @@ module.exports = {
         'packages/parser',
         'packages/rule-tester',
         'packages/scope-manager',
+        'packages/type-utils',
         'packages/typescript-estree',
         'packages/typescript-eslint',
         'packages/utils',

From 54bc492c1c979213bbd73b779fef8960297be221 Mon Sep 17 00:00:00 2001
From: Josh Goldberg <git@joshuakgoldberg.com>
Date: Fri, 7 Jun 2024 09:37:51 -0400
Subject: [PATCH 2/3] Updated mentions of ts-api-utils and utils

---
 docs/packages/Type_Utils.mdx | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/docs/packages/Type_Utils.mdx b/docs/packages/Type_Utils.mdx
index 24ea50f004e6..3b43c3514be8 100644
--- a/docs/packages/Type_Utils.mdx
+++ b/docs/packages/Type_Utils.mdx
@@ -7,11 +7,14 @@ sidebar_label: type-utils
 
 <PackageLink packageName="type-utils" scope="@typescript-eslint" />
 
-> Type utilities for working with TypeScript types ✨
+> Type utilities for working with TypeScript within ESLint rules. ✨
 
-This package contains public utilities for working with TypeScript types.
+This package contains public utilities for working with TypeScript types that ESLint rules often use.
 Rules declared in [`@typescript-eslint/eslint-plugin`](./ESLint_Plugin.mdx) use these utility functions.
 
-The utilities in this package are separated from [`@typescript-eslint/utils`](./Utils.mdx) so that that package does not require a dependency on `typescript`.
+The utilities in this package are both:
+
+- Generally ESLint-focused than the broad TypeScript utilities in [`ts-api-utils`](https://npmjs.com/package/ts-api-utils)
+- Separated from [`@typescript-eslint/utils`](./Utils.mdx) so that that package does not require a dependency on `typescript`
 
 > See [Custom Rules](../developers/Custom_Rules.mdx) for documentation on creating your own custom ESLint rules for TypeScript code.

From eadcd77540eb136c0baf98852cc47c51cdb50c6a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Josh=20Goldberg=20=E2=9C=A8?= <me@joshuakgoldberg.com>
Date: Mon, 17 Jun 2024 15:18:51 -0400
Subject: [PATCH 3/3] Update docs/packages/Type_Utils.mdx

Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>
---
 docs/packages/Type_Utils.mdx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/packages/Type_Utils.mdx b/docs/packages/Type_Utils.mdx
index 3b43c3514be8..fe5f382255ab 100644
--- a/docs/packages/Type_Utils.mdx
+++ b/docs/packages/Type_Utils.mdx
@@ -14,7 +14,7 @@ Rules declared in [`@typescript-eslint/eslint-plugin`](./ESLint_Plugin.mdx) use
 
 The utilities in this package are both:
 
-- Generally ESLint-focused than the broad TypeScript utilities in [`ts-api-utils`](https://npmjs.com/package/ts-api-utils)
+- More generally ESLint-focused than the broad TypeScript utilities in [`ts-api-utils`](https://npmjs.com/package/ts-api-utils)
 - Separated from [`@typescript-eslint/utils`](./Utils.mdx) so that that package does not require a dependency on `typescript`
 
 > See [Custom Rules](../developers/Custom_Rules.mdx) for documentation on creating your own custom ESLint rules for TypeScript code.

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/9294.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/9294.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/9294.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/9294.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>