1 | 'use strict';
|
2 |
|
3 | Object.defineProperty(exports, "__esModule", {
|
4 | value: true
|
5 | });
|
6 | exports.default = extract;
|
7 |
|
8 | var _parse = require('./parse');
|
9 |
|
10 | var _parse2 = _interopRequireDefault(_parse);
|
11 |
|
12 | var _fs = require('fs');
|
13 |
|
14 | var _fs2 = _interopRequireDefault(_fs);
|
15 |
|
16 | var _babelTraverse = require('babel-traverse');
|
17 |
|
18 | var _babelTraverse2 = _interopRequireDefault(_babelTraverse);
|
19 |
|
20 | var _doctrine = require('doctrine');
|
21 |
|
22 | var _doctrine2 = _interopRequireDefault(_doctrine);
|
23 |
|
24 | var _babelTypes = require('babel-types');
|
25 |
|
26 | function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
27 |
|
28 |
|
29 |
|
30 |
|
31 |
|
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 |
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 | function extract(transform, filename) {
|
45 |
|
46 | var code = _fs2.default.readFileSync(filename, { encoding: 'utf8' });
|
47 |
|
48 | var ast = (0, _parse2.default)(code, { sourceFilename: filename });
|
49 |
|
50 | var results = [];
|
51 |
|
52 | var done = false;
|
53 | (0, _babelTraverse2.default)(ast, {
|
54 | enter: function enter(path) {
|
55 | if (path.node.leadingComments) {
|
56 | path.node.leadingComments.filter(isJSDocComment).forEach(function (comment) {
|
57 | var result = _doctrine2.default.parse(comment.value, {
|
58 | unwrap: true,
|
59 | sloppy: true,
|
60 | recoverable: true,
|
61 | lineNumbers: true
|
62 | });
|
63 |
|
64 | if (result.tags) {
|
65 | result.tags.forEach(function (tag) {
|
66 | if (tag.title === 'example') {
|
67 | results.push(transform({
|
68 | comment: tag.description,
|
69 | name: getNodeName(path.node),
|
70 | filename: path.node.loc.filename,
|
71 | type: path.node.type
|
72 | }));
|
73 | }
|
74 | });
|
75 | }
|
76 | });
|
77 | }
|
78 | },
|
79 |
|
80 | Program: {
|
81 | exit: function exit(path) {
|
82 | if ((0, _babelTypes.isProgram)(path)) {
|
83 | if (done) {
|
84 | return;
|
85 | }
|
86 | path.pushContainer('body', results);
|
87 | done = true;
|
88 | }
|
89 | }
|
90 | }
|
91 | });
|
92 |
|
93 | return ast;
|
94 | }
|
95 |
|
96 |
|
97 |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 |
|
103 |
|
104 |
|
105 | function getNodeName(node) {
|
106 | if (node.id) {
|
107 | return node.id.name;
|
108 | }
|
109 |
|
110 | if (node.key) {
|
111 | return node.key.name;
|
112 | }
|
113 |
|
114 | throw new Error('Could not find name for node');
|
115 | }
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 | function isJSDocComment(comment) {
|
122 | var asterisks = comment.value.match(/^(\*+)/);
|
123 | if (comment.value.startsWith('/*') && comment.value.endsWith('*/')) {
|
124 | return false;
|
125 | }
|
126 |
|
127 |
|
128 | return (comment.type === 'CommentBlock' ||
|
129 |
|
130 | comment.type === 'Block') &&
|
131 |
|
132 | asterisks && asterisks[1].length === 1;
|
133 | }
|
134 |
|