Skip to content

Commit 23429f1

Browse files
wooormwooorm
committed
Refactor code-style
1 parent 7718ceb commit 23429f1

File tree

4 files changed

+92
-51
lines changed

4 files changed

+92
-51
lines changed

‎index.d.ts

+65-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
export type {Options} from './lib/index.js'
1+
import type {Properties} from 'hastscript'
22

33
export {default} from './lib/index.js'
44

5+
/**
6+
* Fields supported by `rehype-document`.
7+
*/
58
interface DocumentFields {
69
/**
710
* Title of the document (optional, example: `'The New York City Subway Map
@@ -14,6 +17,67 @@ interface DocumentFields {
1417
title?: string | null | undefined
1518
}
1619

20+
/**
21+
* Configuration.
22+
*/
23+
export interface Options {
24+
/**
25+
* URLs to stylesheets to use in `<link>`s (optional).
26+
*/
27+
css?: ReadonlyArray<string> | string | null | undefined
28+
/**
29+
* Direction of the document (optional).
30+
*/
31+
dir?: 'auto' | 'ltr' | 'rtl' | null | undefined
32+
/**
33+
* URLs to scripts to use as `src` on `<script>`s (optional).
34+
*/
35+
js?: ReadonlyArray<string> | string | null | undefined
36+
/**
37+
* Language of document (default: `'en'`); should be a
38+
* [BCP 47](https://tools.ietf.org/html/bcp47) language tag.
39+
*/
40+
language?: string | null | undefined
41+
/**
42+
* Generate extra `<link>`s with these properties (optional); passed as
43+
* `properties` to [`hastscript`](https://github.com/syntax-tree/hastscript)
44+
* with `'link'`.
45+
*/
46+
link?:
47+
| ReadonlyArray<Readonly<Properties>>
48+
| Readonly<Properties>
49+
| null
50+
| undefined
51+
/**
52+
* Generate extra `<meta>`s with these properties (optional); passed as
53+
* `properties` to [`hastscript`](https://github.com/syntax-tree/hastscript)
54+
* with `'meta'`.
55+
*/
56+
meta?:
57+
| ReadonlyArray<Readonly<Properties>>
58+
| Readonly<Properties>
59+
| null
60+
| undefined
61+
/**
62+
* Generate a `meta[viewport]` (default: `true`).
63+
*/
64+
responsive?: boolean | null | undefined
65+
/**
66+
* JavaScript source code of `<script>`s to add at end of `body` (optional).
67+
*/
68+
script?: ReadonlyArray<string> | string | null | undefined
69+
/**
70+
* CSS source code of `<style>`s to add (optional).
71+
*/
72+
style?: ReadonlyArray<string> | string | null | undefined
73+
/**
74+
* Text to use as title (optional); defaults to the file name (if any); can
75+
* bet set with `file.data.matter.title` (`vfile-matter`) and
76+
* `file.data.meta.title` (`rehype-infer-title-meta`), which are preferred.
77+
*/
78+
title?: string | null | undefined
79+
}
80+
1781
// Add custom data supported when `rehype-document` is added.
1882
declare module 'vfile' {
1983
interface DataMapMatter extends DocumentFields {}

‎lib/index.js

+6-42
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,12 @@
11
/**
2-
* @typedef {import('hast').ElementContent} ElementContent
3-
* @typedef {import('hast').Nodes} Nodes
4-
* @typedef {import('hast').Root} Root
5-
*
6-
* @typedef {import('hastscript').Properties} Properties
7-
*
8-
* @typedef {import('vfile').VFile} VFile
9-
*/
10-
11-
/**
12-
* @typedef Options
13-
* Configuration.
14-
* @property {Array<string> | string | null | undefined} [css]
15-
* URLs to stylesheets to use in `<link>`s (optional).
16-
* @property {'auto' | 'ltr' | 'rtl' | null | undefined} [dir]
17-
* Direction of the document (optional).
18-
* @property {Array<string> | string | null | undefined} [js]
19-
* URLs to scripts to use as `src` on `<script>`s (optional).
20-
* @property {string | null | undefined} [language='en']
21-
* Language of document (default: `'en'`); should be a
22-
* [BCP 47](https://tools.ietf.org/html/bcp47) language tag.
23-
* @property {Array<Properties> | Properties | null | undefined} [link]
24-
* Generate extra `<link>`s with these properties (optional); passed as
25-
* `properties` to [`hastscript`](https://github.com/syntax-tree/hastscript)
26-
* with `'link'`.
27-
* @property {Array<Properties> | Properties | null | undefined} [meta]
28-
* Generate extra `<meta>`s with these properties (optional); passed as
29-
* `properties` to [`hastscript`](https://github.com/syntax-tree/hastscript)
30-
* with `'meta'`.
31-
* @property {boolean | null | undefined} [responsive=true]
32-
* Generate a `meta[viewport]` (default: `true`).
33-
* @property {Array<string> | string | null | undefined} [script]
34-
* JavaScript source code of `<script>`s to add at end of `body` (optional).
35-
* @property {Array<string> | string | null | undefined} [style]
36-
* CSS source code of `<style>`s to add (optional).
37-
* @property {string | null | undefined} [title]
38-
* Text to use as title (optional); defaults to the file name (if any); can
39-
* bet set with `file.data.matter.title` (`vfile-matter`) and
40-
* `file.data.meta.title` (`rehype-infer-title-meta`), which are preferred.
2+
* @import {ElementContent, Nodes, Root} from 'hast'
3+
* @import {Options} from 'rehype-document'
4+
* @import {VFile} from 'vfile'
415
*/
426

437
import {h} from 'hastscript'
448

45-
/** @type {Options} */
9+
/** @type {Readonly<Options>} */
4610
const emptyOptions = {}
4711

4812
/**
@@ -165,7 +129,7 @@ export default function rehypeDocument(options) {
165129
*
166130
* @template Thing
167131
* Value kind.
168-
* @param {Array<Thing> | Thing | null | undefined} value
132+
* @param {ReadonlyArray<Thing> | Thing | null | undefined} value
169133
* Value to cast.
170134
* @returns {Array<Thing>}
171135
* List.
@@ -174,6 +138,6 @@ function toList(value) {
174138
return value === null || value === undefined
175139
? []
176140
: Array.isArray(value)
177-
? value
141+
? [...value]
178142
: [value]
179143
}

‎package.json

+17-3
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,25 @@
8181
"overrides": [
8282
{
8383
"files": [
84-
"*.ts"
84+
"**/*.d.ts"
8585
],
8686
"rules": {
87-
"@typescript-eslint/ban-types": "off",
88-
"@typescript-eslint/consistent-type-definitions": "off"
87+
"@typescript-eslint/array-type": [
88+
"error",
89+
{
90+
"default": "generic"
91+
}
92+
],
93+
"@typescript-eslint/ban-types": [
94+
"error",
95+
{
96+
"extendDefaults": true
97+
}
98+
],
99+
"@typescript-eslint/consistent-type-definitions": [
100+
"error",
101+
"interface"
102+
]
89103
}
90104
}
91105
],

‎test.js

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/**
2-
* @typedef {import('hast').Element} Element
2+
* @import {Element} from 'hast'
3+
* @import {Parser, Processor} from 'unified'
34
*/
45

56
import assert from 'node:assert/strict'
@@ -556,11 +557,9 @@ test('rehypeDocument()', async function (t) {
556557
.use(function () {
557558
// @ts-expect-error: TypeScript is bad at `this`.
558559
// eslint-disable-next-line unicorn/no-this-assignment
559-
const self = /** @type {import('unified').Processor<Element>} */ (
560-
this
561-
)
560+
const self = /** @type {Processor<Element>} */ (this)
562561

563-
/** @type {import('unified').Parser<Element>} */
562+
/** @type {Parser<Element>} */
564563
self.parser = function () {
565564
/** @type {Element} */
566565
const node = {

0 commit comments

Comments
 (0)