Skip to content

Commit 372da4d

Browse files
committed
Add augmentation of settings types to rehype
Related-to: #150.
1 parent eb283bd commit 372da4d

File tree

5 files changed

+16
-1
lines changed

5 files changed

+16
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,6 @@ node_modules/
44
*.log
55
.DS_Store
66
yarn.lock
7+
!packages/rehype/index.d.ts
78
!packages/rehype-parse/index.d.ts
89
!packages/rehype-stringify/index.d.ts

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@
7676
],
7777
"rules": {
7878
"@typescript-eslint/ban-types": "off",
79-
"@typescript-eslint/consistent-type-definitions": "off"
79+
"@typescript-eslint/consistent-type-definitions": "off",
80+
"@typescript-eslint/triple-slash-reference": "off"
8081
}
8182
}
8283
],

packages/rehype/index.d.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/// <reference types="rehype-parse" />
2+
/// <reference types="rehype-stringify" />
3+
4+
import type {Root} from 'hast'
5+
import type {Processor} from 'unified'
6+
7+
/**
8+
* Create a new unified processor that already uses `rehype-parse` and
9+
* `rehype-stringify`.
10+
*/
11+
export const rehype: Processor<Root, undefined, undefined, Root, string>

packages/rehype/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Note: types exposed from `index.d.ts`
12
import rehypeParse from 'rehype-parse'
23
import rehypeStringify from 'rehype-stringify'
34
import {unified} from 'unified'

tsconfig.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"exclude": ["**/coverage/", "**/node_modules/"],
1414
"include": [
1515
"**/*.js",
16+
"packages/rehype/index.d.ts",
1617
"packages/rehype-parse/index.d.ts",
1718
"packages/rehype-stringify/index.d.ts"
1819
]

0 commit comments

Comments
 (0)