-
Notifications
You must be signed in to change notification settings - Fork 37
/
embedme.lib.ts
476 lines (410 loc) · 13.9 KB
/
embedme.lib.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
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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
import chalk, { Chalk } from 'chalk';
import { existsSync, readFileSync } from 'fs';
import { relative, resolve } from 'path';
/**
* This simple script looks for code fences in source file for a syntax that looks like a file reference, optionally
* with a line number reference. If a file exists at this location it is inserted into the code fence.
*
* Example:
*
* ```ts
* // path/to/some/file.ts
* ```
*
* will look for path/to/some/file.ts and if present, read it and insert
*
* ```ts
* // path/to/some/file.ts
* file content will appear hear
* ```
*
* ```ts
* // path/to/some/file.ts#L10-50
* ```
*
* ```ts
* // path/to/some/file.ts#L10-50
* file content (only lines 10 - 50) will appear hear
* ```
*
*/
type FilenameFromCommentReader = (line: string) => string | null;
export interface EmbedmeOptions {
sourceRoot: string;
dryRun: boolean;
verify: boolean;
silent: boolean;
stdout: boolean;
stripEmbedComment: boolean;
}
enum SupportedFileType {
PLAIN_TEXT = 'txt',
TYPESCRIPT = 'ts',
JAVASCRIPT = 'js',
REASON = 're',
SCSS = 'scss',
RUST = 'rust',
JAVA = 'java',
CPP = 'cpp',
C = 'c',
HTML = 'html',
XML = 'xml',
MARKDOWN = 'md',
YAML = 'yaml',
JSON = 'json',
JSON_5 = 'json5',
PYTHON = 'py',
BASH = 'bash',
SHELL = 'sh',
POWERSHELL = 'ps1',
GOLANG = 'go',
OBJECTIVE_C = 'objectivec',
PHP = 'php',
C_SHARP = 'cs',
SWIFT = 'swift',
RUBY = 'rb',
KOTLIN = 'kotlin',
SCALA = 'scala',
CRYSTAL = 'cr',
PLANT_UML = 'puml',
MERMAID = 'mermaid',
CMAKE = 'cmake',
PROTOBUF = 'proto',
SQL = 'sql',
HASKELL = 'hs',
ARDUINO = 'ino',
JSX = 'jsx',
TSX = 'tsx',
}
enum CommentFamily {
NONE, // some languages do not support comments, e.g. JSON
C,
XML,
HASH,
SINGLE_QUOTE,
DOUBLE_PERCENT,
DOUBLE_HYPHENS,
}
type Replacement = {
text: string;
error: boolean;
};
const languageMap: Record<CommentFamily, SupportedFileType[]> = {
[CommentFamily.NONE]: [SupportedFileType.JSON],
[CommentFamily.C]: [
SupportedFileType.PLAIN_TEXT, // this is a lie, but we gotta pick something
SupportedFileType.C,
SupportedFileType.TYPESCRIPT,
SupportedFileType.REASON,
SupportedFileType.JAVASCRIPT,
SupportedFileType.RUST,
SupportedFileType.CPP,
SupportedFileType.JAVA,
SupportedFileType.GOLANG,
SupportedFileType.OBJECTIVE_C,
SupportedFileType.SCSS,
SupportedFileType.PHP,
SupportedFileType.C_SHARP,
SupportedFileType.SWIFT,
SupportedFileType.KOTLIN,
SupportedFileType.SCALA,
SupportedFileType.JSON_5,
SupportedFileType.PROTOBUF,
SupportedFileType.ARDUINO,
SupportedFileType.JSX,
SupportedFileType.TSX,
],
[CommentFamily.XML]: [SupportedFileType.HTML, SupportedFileType.MARKDOWN, SupportedFileType.XML],
[CommentFamily.HASH]: [
SupportedFileType.PYTHON,
SupportedFileType.BASH,
SupportedFileType.SHELL,
SupportedFileType.POWERSHELL,
SupportedFileType.YAML,
SupportedFileType.RUBY,
SupportedFileType.CRYSTAL,
SupportedFileType.CMAKE,
],
[CommentFamily.SINGLE_QUOTE]: [SupportedFileType.PLANT_UML],
[CommentFamily.DOUBLE_PERCENT]: [SupportedFileType.MERMAID],
[CommentFamily.DOUBLE_HYPHENS]: [SupportedFileType.SQL, SupportedFileType.HASKELL],
};
const leadingSymbol = (symbol: string): FilenameFromCommentReader => line => {
const regex = new RegExp(`${symbol}\\s?(\\S*?$)`);
const match = line.match(regex);
if (!match) {
return null;
}
return match[1];
};
const filetypeCommentReaders: Record<CommentFamily, FilenameFromCommentReader> = {
[CommentFamily.NONE]: _ => null,
[CommentFamily.C]: leadingSymbol('//'),
[CommentFamily.XML]: line => {
const match = line.match(/<!--\s*?(\S*?)\s*?-->/);
if (!match) {
return null;
}
return match[1];
},
[CommentFamily.HASH]: leadingSymbol('#'),
[CommentFamily.SINGLE_QUOTE]: leadingSymbol(`'`),
[CommentFamily.DOUBLE_PERCENT]: leadingSymbol('%%'),
[CommentFamily.DOUBLE_HYPHENS]: leadingSymbol('--'),
};
function lookupLanguageCommentFamily(fileType: SupportedFileType): CommentFamily | null {
return Object.values(CommentFamily)
.filter(x => typeof x === 'number')
.find((commentFamily: CommentFamily) => languageMap[commentFamily].includes(fileType));
}
// this somewhat convoluted type to generate logs is due to the requirement to be able to log colours to both stdout,
// and stderr, so the appropriate chalk instance has to be injected.
type LogConstructor = (chalk: Chalk) => string;
export const logBuilder = (options: EmbedmeOptions, errorLog = false) => (logConstructor: LogConstructor) => {
if (!options.silent) {
if (errorLog || options.stdout) {
// as we're putting the resulting file out of stdout, we redirect the logs to stderr so they can still be seen,
// but won't be piped
console.error(logConstructor(chalk.stderr));
} else {
console.log(logConstructor(chalk));
}
}
};
/* @internal */
function getReplacement(
inputFilePath: string,
options: EmbedmeOptions,
logMethod: ReturnType<typeof logBuilder>,
substr: string,
leadingSpaces: string,
lineEnding: string,
infoString: string,
codeExtension: SupportedFileType,
firstLine: string,
startLineNumber: number,
ignoreNext: boolean,
commentEmbedOverrideFilepath?: string,
): Replacement {
/**
* Re-declare the log class, prefixing each snippet with the file and line number
* Note that we couldn't have derived the line count in the parent regex matcher, as we don't yet know how long the
* embed is going to be.
*/
const log = ({ returnSnippet }: { returnSnippet: string }, logConstructor: LogConstructor) => {
const endLineNumber = returnSnippet.split(lineEnding).length + startLineNumber - 1;
logMethod(chalk => {
const logPrefix = chalk.gray(
` ${relative(process.cwd(), inputFilePath)}#L${startLineNumber}-L${endLineNumber}`,
);
return logPrefix + ' ' + logConstructor(chalk);
});
};
if (ignoreNext) {
log({ returnSnippet: substr }, chalk => chalk.blue(`"Ignore next" comment detected, skipping code block...`));
return { text: substr, error: false };
}
let commentedFilename: string | null;
if (commentEmbedOverrideFilepath) {
commentedFilename = commentEmbedOverrideFilepath;
} else {
if (!codeExtension) {
log({ returnSnippet: substr }, chalk => chalk.blue(`No code extension detected, skipping code block...`));
return { text: substr, error: false };
}
if (!firstLine) {
log({ returnSnippet: substr }, chalk =>
chalk.blue(`Code block is empty & no preceding embedme comment, skipping...`),
);
return { text: substr, error: false };
}
const supportedFileTypes: SupportedFileType[] = Object.values(SupportedFileType).filter(x => typeof x === 'string');
if (supportedFileTypes.indexOf(codeExtension) < 0) {
log({ returnSnippet: substr }, chalk =>
chalk.yellow(
`Unsupported file extension [${codeExtension}], supported extensions are ${supportedFileTypes.join(
', ',
)}, skipping code block`,
),
);
return { text: substr, error: false };
}
const languageFamily: CommentFamily | null = lookupLanguageCommentFamily(codeExtension);
if (languageFamily == null) {
log({ returnSnippet: substr }, chalk =>
chalk.red(
`File extension ${chalk.underline(
codeExtension,
)} marked as supported, but comment family could not be determined. Please report this issue.`,
),
);
return { text: substr, error: false };
}
commentedFilename = filetypeCommentReaders[languageFamily](firstLine);
}
if (!commentedFilename) {
log({ returnSnippet: substr }, chalk =>
chalk.gray(`No comment detected in first line for block with extension ${codeExtension}`),
);
return { text: substr, error: false };
}
const matches = commentedFilename.match(/\s?(\S+?)((#L(\d+)-L(\d+))|$)/m);
if (!matches) {
log({ returnSnippet: substr }, chalk => chalk.gray(`No file found in embed line`));
return { text: substr, error: false };
}
const [, filename, , lineNumbering, startLine, endLine] = matches;
if (filename.includes('#')) {
log({ returnSnippet: substr }, chalk =>
chalk.red(
`Incorrectly formatted line numbering string ${chalk.underline(
filename,
)}, Expecting Github formatting e.g. #L10-L20`,
),
);
return { text: substr, error: false };
}
const relativePath = options.sourceRoot
? resolve(process.cwd(), options.sourceRoot, filename)
: resolve(inputFilePath, '..', filename);
if (!existsSync(relativePath)) {
log({ returnSnippet: substr }, chalk =>
chalk.red(
`Found filename ${chalk.underline(
filename,
)} in comment in first line, but file does not exist at ${chalk.underline(relativePath)}!`,
),
);
return { text: substr, error: true };
}
const file = readFileSync(relativePath, 'utf8');
let lines = file.split(lineEnding);
if (lineNumbering) {
lines = lines.slice(+startLine - 1, +endLine);
}
const minimumLeadingSpaces = lines.reduce((minSpaces: number, line: string) => {
if (minSpaces === 0) {
return 0;
}
if (line.length === 0) {
return Infinity; //empty lines shouldn't count
}
const leadingSpaces = line.match(/^[\s]+/m);
if (!leadingSpaces) {
return 0;
}
return Math.min(minSpaces, leadingSpaces[0].length);
}, Infinity);
lines = lines.map(line => line.slice(minimumLeadingSpaces));
const outputCode = lines.join(lineEnding);
if (/```/.test(outputCode)) {
log({ returnSnippet: substr }, chalk =>
chalk.red(
`Output snippet for file ${chalk.underline(
filename,
)} contains a code fence. Refusing to embed as that would break the document`,
),
);
return { text: substr, error: false };
}
let replacement =
!!commentEmbedOverrideFilepath || options.stripEmbedComment
? `\`\`\`${infoString}${lineEnding}${outputCode}${lineEnding}\`\`\``
: `\`\`\`${infoString}${lineEnding}${firstLine.trim()}${lineEnding}${lineEnding}${outputCode}${lineEnding}\`\`\``;
if (leadingSpaces.length) {
replacement = replacement
.split(lineEnding)
.map(line => leadingSpaces + line)
.join(lineEnding);
}
if (replacement === substr) {
log({ returnSnippet: substr }, chalk => chalk.gray(`No changes required, already up to date`));
return { text: substr, error: false };
}
if (replacement.slice(0, -3).trimRight() === substr.slice(0, -3).trimRight()) {
log({ returnSnippet: substr }, chalk => chalk.gray(`Changes are trailing whitespace only, ignoring`));
return { text: substr, error: false };
}
const chalkColour = options.verify ? 'yellow' : 'green';
log({ returnSnippet: replacement }, chalk =>
chalk[chalkColour](
`Embedded ${chalk[(chalkColour + 'Bright') as 'greenBright'](lines.length + ' lines')}${
options.stripEmbedComment ? chalk.italic(' without comment line') : ''
} from file ${chalk.underline(commentedFilename)}`,
),
);
return { text: replacement, error: false };
}
function getLineNumber(text: string, index: number, lineEnding: string): number {
return text.substring(0, index).split(lineEnding).length;
}
function detectLineEnding(sourceText: string): string {
let rexp = new RegExp(/\r\n/);
return rexp.test(sourceText) ? '\r\n' : '\n';
}
export function embedme(
sourceText: string,
inputFilePath: string,
options: EmbedmeOptions,
): { outText: string; error: boolean } {
const log = logBuilder(options);
log(chalk => chalk.magenta(` Analysing ${chalk.underline(relative(process.cwd(), inputFilePath))}...`));
/**
* Match a codefence, capture groups around the file extension (optional) and first line starting with // (optional)
*/
const codeFenceFinder: RegExp = /([ \t]*?)```([\s\S]*?)^[ \t]*?```/gm;
/*
* Detects line ending to use based on whether or not CRLF is detected in the source text.
*/
const lineEnding = detectLineEnding(sourceText);
const docPartials = [];
let previousEnd = 0;
let result: RegExpExecArray | null;
let replacementError = false;
while ((result = codeFenceFinder.exec(sourceText)) !== null) {
const [codeFence, leadingSpaces] = result;
const start = sourceText.substring(previousEnd, result.index);
const infoStringMatch = codeFence.match(/```(.*)/);
const infoString = infoStringMatch ? infoStringMatch[1] : '';
const codeExtension = infoString !== '' ? infoString.trim().split(/\s/)[0] : null;
const splitFence = codeFence.split(lineEnding);
const firstLine = splitFence.length >= 3 ? splitFence[1] : null;
/**
* Working out the starting line number is slightly complex as the logic differs depending on whether or not we are
* writing to the file.
*/
const startLineNumber = (() => {
if (options.dryRun || options.stdout || options.verify) {
return getLineNumber(sourceText.substring(0, result.index), result.index, lineEnding);
}
const startingLineNumber = docPartials.join('').split(lineEnding).length - 1;
return (
startingLineNumber + getLineNumber(sourceText.substring(previousEnd, result.index), result.index, lineEnding)
);
})();
const commentInsertion = start.match(/<!--\s*?embedme[ ]+?(\S+?)\s*?-->/);
const { text, error } = getReplacement(
inputFilePath,
options,
log,
codeFence,
leadingSpaces,
lineEnding,
infoString,
codeExtension as SupportedFileType,
firstLine || '',
startLineNumber,
/<!--\s*?embedme[ -]ignore-next\s*?-->/g.test(start),
commentInsertion ? commentInsertion[1] : undefined,
);
if (error) {
replacementError = true;
}
docPartials.push(start, text);
previousEnd = codeFenceFinder.lastIndex;
}
return {
outText: [...docPartials].join('') + sourceText.substring(previousEnd),
error: replacementError,
};
}