forked from OKEAMAH/prettier
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbuilders.js
More file actions
260 lines (227 loc) · 5.24 KB
/
builders.js
File metadata and controls
260 lines (227 loc) · 5.24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
import {
DOC_TYPE_ALIGN,
DOC_TYPE_BREAK_PARENT,
DOC_TYPE_CURSOR,
DOC_TYPE_FILL,
DOC_TYPE_GROUP,
DOC_TYPE_IF_BREAK,
DOC_TYPE_INDENT,
DOC_TYPE_INDENT_IF_BREAK,
DOC_TYPE_LABEL,
DOC_TYPE_LINE,
DOC_TYPE_LINE_SUFFIX,
DOC_TYPE_LINE_SUFFIX_BOUNDARY,
DOC_TYPE_TRIM,
} from "./constants.js";
import { assertDoc, assertDocArray } from "./utils/assert-doc.js";
/**
* TBD properly tagged union for Doc object type is needed here.
*
* @typedef {object} DocObject
* @property {string} type
* @property {boolean} [hard]
* @property {boolean} [literal]
*
* @typedef {Doc[]} DocArray
*
* @typedef {string | DocObject | DocArray} Doc
*/
/**
* @param {Doc} contents
* @returns Doc
*/
function indent(contents) {
assertDoc(contents);
return { type: DOC_TYPE_INDENT, contents };
}
/**
* @param {number | string} widthOrString
* @param {Doc} contents
* @returns Doc
*/
function align(widthOrString, contents) {
assertDoc(contents);
return { type: DOC_TYPE_ALIGN, contents, n: widthOrString };
}
/**
* @param {Doc} contents
* @param {object} [opts] - TBD ???
* @returns Doc
*/
function group(contents, opts = {}) {
assertDoc(contents);
assertDocArray(opts.expandedStates, /* optional */ true);
return {
type: DOC_TYPE_GROUP,
id: opts.id,
contents,
break: Boolean(opts.shouldBreak),
expandedStates: opts.expandedStates,
};
}
/**
* @param {Doc} contents
* @returns Doc
*/
function dedentToRoot(contents) {
return align(Number.NEGATIVE_INFINITY, contents);
}
/**
* @param {Doc} contents
* @returns Doc
*/
function markAsRoot(contents) {
// @ts-expect-error - TBD ???:
return align({ type: "root" }, contents);
}
/**
* @param {Doc} contents
* @returns Doc
*/
function dedent(contents) {
return align(-1, contents);
}
/**
* @param {Doc[]} states
* @param {object} [opts] - TBD ???
* @returns Doc
*/
function conditionalGroup(states, opts) {
return group(states[0], { ...opts, expandedStates: states });
}
/**
* @param {Doc[]} parts
* @returns Doc
*/
function fill(parts) {
assertDocArray(parts);
return { type: DOC_TYPE_FILL, parts };
}
/**
* @param {Doc} breakContents
* @param {Doc} [flatContents]
* @param {object} [opts] - TBD ???
* @returns Doc
*/
function ifBreak(breakContents, flatContents = "", opts = {}) {
assertDoc(breakContents);
if (flatContents !== "") {
assertDoc(flatContents);
}
return {
type: DOC_TYPE_IF_BREAK,
breakContents,
flatContents,
groupId: opts.groupId,
};
}
/**
* Optimized version of `ifBreak(indent(doc), doc, { groupId: ... })`
* @param {Doc} contents
* @param {{ groupId: symbol, negate?: boolean }} opts
* @returns Doc
*/
function indentIfBreak(contents, opts) {
assertDoc(contents);
return {
type: DOC_TYPE_INDENT_IF_BREAK,
contents,
groupId: opts.groupId,
negate: opts.negate,
};
}
/**
* @param {Doc} contents
* @returns Doc
*/
function lineSuffix(contents) {
assertDoc(contents);
return { type: DOC_TYPE_LINE_SUFFIX, contents };
}
const lineSuffixBoundary = { type: DOC_TYPE_LINE_SUFFIX_BOUNDARY };
const breakParent = { type: DOC_TYPE_BREAK_PARENT };
const trim = { type: DOC_TYPE_TRIM };
const hardlineWithoutBreakParent = { type: DOC_TYPE_LINE, hard: true };
const literallineWithoutBreakParent = {
type: DOC_TYPE_LINE,
hard: true,
literal: true,
};
const line = { type: DOC_TYPE_LINE };
const softline = { type: DOC_TYPE_LINE, soft: true };
const hardline = [hardlineWithoutBreakParent, breakParent];
const literalline = [literallineWithoutBreakParent, breakParent];
const cursor = { type: DOC_TYPE_CURSOR };
/**
* @param {Doc} separator
* @param {Doc[]} docs
* @returns Doc
*/
function join(separator, docs) {
assertDoc(separator);
assertDocArray(docs);
const parts = [];
for (let i = 0; i < docs.length; i++) {
if (i !== 0) {
parts.push(separator);
}
parts.push(docs[i]);
}
return parts;
}
/**
* @param {Doc} doc
* @param {number} size
* @param {number} tabWidth
*/
function addAlignmentToDoc(doc, size, tabWidth) {
assertDoc(doc);
let aligned = doc;
if (size > 0) {
// Use indent to add tabs for all the levels of tabs we need
for (let i = 0; i < Math.floor(size / tabWidth); ++i) {
aligned = indent(aligned);
}
// Use align for all the spaces that are needed
aligned = align(size % tabWidth, aligned);
// size is absolute from 0 and not relative to the current
// indentation, so we use -Infinity to reset the indentation to 0
aligned = align(Number.NEGATIVE_INFINITY, aligned);
}
return aligned;
}
/**
* Mark a doc with an arbitrary truthy value. This doesn't affect how the doc is printed, but can be useful for heuristics based on doc introspection.
* @param {any} label If falsy, the `contents` doc is returned as is.
* @param {Doc} contents
*/
function label(label, contents) {
assertDoc(contents);
return label ? { type: DOC_TYPE_LABEL, label, contents } : contents;
}
export {
addAlignmentToDoc,
align,
breakParent,
conditionalGroup,
cursor,
dedent,
dedentToRoot,
fill,
group,
hardline,
hardlineWithoutBreakParent,
ifBreak,
indent,
indentIfBreak,
join,
label,
line,
lineSuffix,
lineSuffixBoundary,
literalline,
literallineWithoutBreakParent,
markAsRoot,
softline,
trim,
};