comment-parser 1.2.4 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -0
- package/browser/index.js +38 -36
- package/es6/parser/index.d.ts +3 -2
- package/es6/parser/index.js +4 -3
- package/es6/parser/source-parser.d.ts +3 -2
- package/es6/parser/source-parser.js +12 -12
- package/es6/parser/tokenizers/description.d.ts +4 -3
- package/es6/parser/tokenizers/description.js +7 -6
- package/es6/primitives.d.ts +7 -0
- package/es6/primitives.js +1 -0
- package/es6/transforms/align.d.ts +2 -1
- package/es6/transforms/align.js +7 -7
- package/lib/parser/index.cjs +6 -2
- package/lib/parser/index.cjs.map +1 -1
- package/lib/parser/index.d.ts +3 -2
- package/lib/parser/source-parser.cjs +11 -10
- package/lib/parser/source-parser.cjs.map +1 -1
- package/lib/parser/source-parser.d.ts +3 -2
- package/lib/parser/tokenizers/description.cjs +7 -6
- package/lib/parser/tokenizers/description.cjs.map +1 -1
- package/lib/parser/tokenizers/description.d.ts +4 -3
- package/lib/primitives.cjs +2 -0
- package/lib/primitives.cjs.map +1 -1
- package/lib/primitives.d.ts +7 -0
- package/lib/transforms/align.cjs +7 -7
- package/lib/transforms/align.cjs.map +1 -1
- package/lib/transforms/align.d.ts +2 -1
- package/package.json +4 -3
- package/src/parser/index.ts +6 -3
- package/src/parser/source-parser.ts +14 -12
- package/src/parser/tokenizers/description.ts +11 -8
- package/src/primitives.ts +8 -0
- package/src/transforms/align.ts +14 -12
- package/tests/e2e/examples.js +1 -1
- package/tests/unit/source-parser.spec.ts +150 -0
|
@@ -286,3 +286,153 @@ test('carriage returns', () => {
|
|
|
286
286
|
|
|
287
287
|
expect(parsed).toEqual([...nulls(3), block, null]);
|
|
288
288
|
});
|
|
289
|
+
|
|
290
|
+
test('custom markers', () => {
|
|
291
|
+
_parse = getParser({
|
|
292
|
+
markers: {
|
|
293
|
+
start: '////',
|
|
294
|
+
nostart: '// ',
|
|
295
|
+
delim: '///',
|
|
296
|
+
end: '////',
|
|
297
|
+
},
|
|
298
|
+
});
|
|
299
|
+
|
|
300
|
+
const parsed = parse(`
|
|
301
|
+
////
|
|
302
|
+
/// description 0
|
|
303
|
+
///
|
|
304
|
+
/// description 1
|
|
305
|
+
///
|
|
306
|
+
/// @param {string} value value description 0
|
|
307
|
+
\`\`\`
|
|
308
|
+
@sample code
|
|
309
|
+
\`\`\`
|
|
310
|
+
/// description 1
|
|
311
|
+
////`);
|
|
312
|
+
|
|
313
|
+
const block = [
|
|
314
|
+
{
|
|
315
|
+
number: 1,
|
|
316
|
+
source: ' ////',
|
|
317
|
+
tokens: seedTokens({
|
|
318
|
+
start: ' ',
|
|
319
|
+
delimiter: '////',
|
|
320
|
+
postDelimiter: '',
|
|
321
|
+
description: '',
|
|
322
|
+
end: '',
|
|
323
|
+
}),
|
|
324
|
+
},
|
|
325
|
+
{
|
|
326
|
+
number: 2,
|
|
327
|
+
source: ' /// description 0',
|
|
328
|
+
tokens: seedTokens({
|
|
329
|
+
start: ' ',
|
|
330
|
+
delimiter: '///',
|
|
331
|
+
postDelimiter: ' ',
|
|
332
|
+
description: 'description 0',
|
|
333
|
+
end: '',
|
|
334
|
+
}),
|
|
335
|
+
},
|
|
336
|
+
{
|
|
337
|
+
number: 3,
|
|
338
|
+
source: ' ///',
|
|
339
|
+
tokens: seedTokens({
|
|
340
|
+
start: ' ',
|
|
341
|
+
delimiter: '///',
|
|
342
|
+
postDelimiter: '',
|
|
343
|
+
description: '',
|
|
344
|
+
end: '',
|
|
345
|
+
}),
|
|
346
|
+
},
|
|
347
|
+
{
|
|
348
|
+
number: 4,
|
|
349
|
+
source: ' /// description 1',
|
|
350
|
+
tokens: seedTokens({
|
|
351
|
+
start: ' ',
|
|
352
|
+
delimiter: '///',
|
|
353
|
+
postDelimiter: ' ',
|
|
354
|
+
description: 'description 1',
|
|
355
|
+
end: '',
|
|
356
|
+
}),
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
number: 5,
|
|
360
|
+
source: ' ///',
|
|
361
|
+
tokens: seedTokens({
|
|
362
|
+
start: ' ',
|
|
363
|
+
delimiter: '///',
|
|
364
|
+
postDelimiter: '',
|
|
365
|
+
description: '',
|
|
366
|
+
end: '',
|
|
367
|
+
}),
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
number: 6,
|
|
371
|
+
source: ' /// @param {string} value value description 0',
|
|
372
|
+
tokens: seedTokens({
|
|
373
|
+
start: ' ',
|
|
374
|
+
delimiter: '///',
|
|
375
|
+
postDelimiter: ' ',
|
|
376
|
+
description: '@param {string} value value description 0',
|
|
377
|
+
end: '',
|
|
378
|
+
}),
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
number: 7,
|
|
382
|
+
source: ' ```',
|
|
383
|
+
tokens: seedTokens({
|
|
384
|
+
start: ' ',
|
|
385
|
+
delimiter: '',
|
|
386
|
+
postDelimiter: '',
|
|
387
|
+
description: '```',
|
|
388
|
+
end: '',
|
|
389
|
+
}),
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
number: 8,
|
|
393
|
+
source: ' @sample code',
|
|
394
|
+
tokens: seedTokens({
|
|
395
|
+
start: ' ',
|
|
396
|
+
delimiter: '',
|
|
397
|
+
postDelimiter: '',
|
|
398
|
+
description: '@sample code',
|
|
399
|
+
end: '',
|
|
400
|
+
}),
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
number: 9,
|
|
404
|
+
source: ' ```',
|
|
405
|
+
tokens: seedTokens({
|
|
406
|
+
start: ' ',
|
|
407
|
+
delimiter: '',
|
|
408
|
+
postDelimiter: '',
|
|
409
|
+
description: '```',
|
|
410
|
+
end: '',
|
|
411
|
+
}),
|
|
412
|
+
},
|
|
413
|
+
{
|
|
414
|
+
number: 10,
|
|
415
|
+
source: ' /// description 1',
|
|
416
|
+
tokens: seedTokens({
|
|
417
|
+
start: ' ',
|
|
418
|
+
delimiter: '///',
|
|
419
|
+
postDelimiter: ' ',
|
|
420
|
+
description: 'description 1',
|
|
421
|
+
end: '',
|
|
422
|
+
}),
|
|
423
|
+
},
|
|
424
|
+
{
|
|
425
|
+
number: 11,
|
|
426
|
+
source: ' ////',
|
|
427
|
+
tokens: seedTokens({
|
|
428
|
+
start: ' ',
|
|
429
|
+
delimiter: '',
|
|
430
|
+
postDelimiter: '',
|
|
431
|
+
description: '',
|
|
432
|
+
end: '////',
|
|
433
|
+
}),
|
|
434
|
+
},
|
|
435
|
+
];
|
|
436
|
+
|
|
437
|
+
expect(parsed).toEqual([...nulls(11), block]);
|
|
438
|
+
});
|