From 372da4d3807b127bc9963629e5ddb158a2c13e4f Mon Sep 17 00:00:00 2001
From: Titus Wormer <tituswormer@gmail.com>
Date: Wed, 30 Aug 2023 09:24:09 +0200
Subject: [PATCH] Add augmentation of settings types to `rehype`

Related-to: rehypejs/rehype#150.
---
 .gitignore                 |  1 +
 package.json               |  3 ++-
 packages/rehype/index.d.ts | 11 +++++++++++
 packages/rehype/index.js   |  1 +
 tsconfig.json              |  1 +
 5 files changed, 16 insertions(+), 1 deletion(-)
 create mode 100644 packages/rehype/index.d.ts

diff --git a/.gitignore b/.gitignore
index 55c6ce81..588aec5c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,5 +4,6 @@ node_modules/
 *.log
 .DS_Store
 yarn.lock
+!packages/rehype/index.d.ts
 !packages/rehype-parse/index.d.ts
 !packages/rehype-stringify/index.d.ts
diff --git a/package.json b/package.json
index f646b451..da63cc86 100644
--- a/package.json
+++ b/package.json
@@ -76,7 +76,8 @@
         ],
         "rules": {
           "@typescript-eslint/ban-types": "off",
-          "@typescript-eslint/consistent-type-definitions": "off"
+          "@typescript-eslint/consistent-type-definitions": "off",
+          "@typescript-eslint/triple-slash-reference": "off"
         }
       }
     ],
diff --git a/packages/rehype/index.d.ts b/packages/rehype/index.d.ts
new file mode 100644
index 00000000..a39a5aff
--- /dev/null
+++ b/packages/rehype/index.d.ts
@@ -0,0 +1,11 @@
+/// <reference types="rehype-parse" />
+/// <reference types="rehype-stringify" />
+
+import type {Root} from 'hast'
+import type {Processor} from 'unified'
+
+/**
+ * Create a new unified processor that already uses `rehype-parse` and
+ * `rehype-stringify`.
+ */
+export const rehype: Processor<Root, undefined, undefined, Root, string>
diff --git a/packages/rehype/index.js b/packages/rehype/index.js
index 567c588e..31802f03 100644
--- a/packages/rehype/index.js
+++ b/packages/rehype/index.js
@@ -1,3 +1,4 @@
+// Note: types exposed from `index.d.ts`
 import rehypeParse from 'rehype-parse'
 import rehypeStringify from 'rehype-stringify'
 import {unified} from 'unified'
diff --git a/tsconfig.json b/tsconfig.json
index 14390ad6..66c9d881 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -13,6 +13,7 @@
   "exclude": ["**/coverage/", "**/node_modules/"],
   "include": [
     "**/*.js",
+    "packages/rehype/index.d.ts",
     "packages/rehype-parse/index.d.ts",
     "packages/rehype-stringify/index.d.ts"
   ]