/
index.ts
127 lines (109 loc) · 3.41 KB
/
index.ts
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
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import {EOL} from 'os';
import detectNewline = require('detect-newline');
type Pragmas = Record<string, string | Array<string>>;
const commentEndRe = /\*\/$/;
const commentStartRe = /^\/\*\*/;
const docblockRe = /^\s*(\/\*\*?(.|\r?\n)*?\*\/)/;
const lineCommentRe = /(^|\s+)\/\/([^\r\n]*)/g;
const ltrimNewlineRe = /^(\r?\n)+/;
const multilineRe = /(?:^|\r?\n) *(@[^\r\n]*?) *\r?\n *(?![^@\r\n]*\/\/[^]*)([^@\r\n\s][^@\r\n]+?) *\r?\n/g;
const propertyRe = /(?:^|\r?\n) *@(\S+) *([^\r\n]*)/g;
const stringStartRe = /(\r?\n|^) *\* ?/g;
const STRING_ARRAY: ReadonlyArray<string> = [];
export function extract(contents: string): string {
const match = contents.match(docblockRe);
return match ? match[0].trimLeft() : '';
}
export function strip(contents: string): string {
const match = contents.match(docblockRe);
return match && match[0] ? contents.substring(match[0].length) : contents;
}
export function parse(docblock: string): Pragmas {
return parseWithComments(docblock).pragmas;
}
export function parseWithComments(
docblock: string,
): {comments: string; pragmas: Pragmas} {
const line = detectNewline(docblock) || EOL;
docblock = docblock
.replace(commentStartRe, '')
.replace(commentEndRe, '')
.replace(stringStartRe, '$1');
// Normalize multi-line directives
let prev = '';
while (prev !== docblock) {
prev = docblock;
docblock = docblock.replace(multilineRe, `${line}$1 $2${line}`);
}
docblock = docblock.replace(ltrimNewlineRe, '').trimRight();
const result = Object.create(null);
const comments = docblock
.replace(propertyRe, '')
.replace(ltrimNewlineRe, '')
.trimRight();
let match;
while ((match = propertyRe.exec(docblock))) {
// strip linecomments from pragmas
const nextPragma = match[2].replace(lineCommentRe, '');
if (
typeof result[match[1]] === 'string' ||
Array.isArray(result[match[1]])
) {
result[match[1]] = STRING_ARRAY.concat(result[match[1]], nextPragma);
} else {
result[match[1]] = nextPragma;
}
}
return {comments, pragmas: result};
}
export function print({
comments = '',
pragmas = {},
}: {
comments?: string;
pragmas?: Pragmas;
}): string {
const line = detectNewline(comments) || EOL;
const head = '/**';
const start = ' *';
const tail = ' */';
const keys = Object.keys(pragmas);
const printedObject = keys
.map(key => printKeyValues(key, pragmas[key]))
.reduce((arr, next) => arr.concat(next), [])
.map(keyValue => start + ' ' + keyValue + line)
.join('');
if (!comments) {
if (keys.length === 0) {
return '';
}
if (keys.length === 1 && !Array.isArray(pragmas[keys[0]])) {
const value = pragmas[keys[0]];
return `${head} ${printKeyValues(keys[0], value)[0]}${tail}`;
}
}
const printedComments =
comments
.split(line)
.map(textLine => `${start} ${textLine}`)
.join(line) + line;
return (
head +
line +
(comments ? printedComments : '') +
(comments && keys.length ? start + line : '') +
printedObject +
tail
);
}
function printKeyValues(key: string, valueOrArray: string | Array<string>) {
return STRING_ARRAY.concat(valueOrArray).map(value =>
`@${key} ${value}`.trim(),
);
}