-
Notifications
You must be signed in to change notification settings - Fork 9
/
ndoc.js
432 lines (340 loc) · 10.2 KB
/
ndoc.js
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
/**
* class NDoc
*
* Handles documentation tree.
**/
'use strict';
// Node < 0.8 shims
if (!require('fs').exists) {
require('fs').exists = require('path').exists;
}
if (!require('fs').existsSync) {
require('fs').existsSync = require('path').existsSync;
}
// stdlib
var path = require('path');
// 3rd-party
var _ = require('underscore');
var async = require('async');
// internal
var template = require('./ndoc/common').template;
var renderers = require('./ndoc/renderers');
var parsers = require('./ndoc/parsers');
////////////////////////////////////////////////////////////////////////////////
var NDoc = module.exports = {};
////////////////////////////////////////////////////////////////////////////////
// parse all files and prepare a "raw list of nodes
function parse_files(files, options, callback) {
var nodes = {
// root section node
'': {
id: '',
type: 'section',
children: [],
description: '',
short_description: '',
href: '#',
root: true,
file: '',
line: 0
}
};
async.forEachSeries(files, function (file, next_file) {
var fn = parsers[path.extname(file)];
if (!fn) {
next_file();
return;
}
console.info('Parsing file: ' + file);
fn(file, options, function (err, file_nodes) {
// TODO: fail on name clash here as well -- as we might get name clash
// from different parsers, or even differnret files
_.extend(nodes, file_nodes);
next_file(err);
});
}, function (err) {
callback(err, nodes);
});
}
function build_tree(nodes, options) {
var tree, parted, sections, children;
//
// preprocess nodes
//
_.each(nodes, function (node) {
if (!node.href && !node.root && options.linkFormat) {
node.href = template(options.linkFormat, {
'package' : options.package,
'file' : node.file.replace(/\\/g, '/'),
'line' : node.line
});
}
});
//
// for each element with undefined section try to guess the section
// E.g. for ".Ajax.Updater" we try to find "SECTION.Ajax" element.
// If found, rename ".Ajax.Updater" to "SECTION.Ajax.Updater"
//
// prepare nodes of sections
// N.B. starting with 1 we skip "" section
parted = _.keys(nodes).sort().slice(1).map(function (id) {
return {id: id, parted: id.split(/[.#@]/), node: nodes[id]};
});
_.each(parted, function (data) {
var found;
// leave only ids without defined section
if ('' !== data.parted[0]) {
return;
}
found = _.find(parted, function (other) {
return !!other.parted[0] && other.parted[1] === data.parted[1];
});
if (found) {
delete nodes[data.id];
data.node.id = found.parted[0] + data.id;
data.parted[0] = found.parted[0];
nodes[data.node.id] = data.node;
}
});
// sort elements in case-insensitive manner
tree = {};
sections = _.keys(nodes).sort(function (a, b) {
a = a.toLowerCase();
b = b.toLowerCase();
return a === b ? 0 : a < b ? -1 : 1;
});
sections.forEach(function (id) {
tree[id] = nodes[id];
});
// rebuild the tree from the end to beginning.
// N.B. since the nodes we iterate over is sorted, we can determine precisely
// the parent of any element.
_.each(sections.slice(0).reverse(), function (id) {
var idx, parent;
// parent name is this element's name without portion after
// the last '.' for class member, last '#' for instance member,
// or first '@' for events
// first check for event, because event name can contain '.', '#' and '@'
idx = id.indexOf('@');
if (idx === -1) {
idx = Math.max(id.lastIndexOf('.'), id.lastIndexOf('#'));
}
// get parent element
parent = tree[id.substring(0, idx)];
// no '.' or '#' or '@' found or no parent? -- top level section. skip it
if (-1 === idx || !parent) {
return;
}
// parent element found. move this element to parent's children nodes,
// maintaing order
parent.children.unshift(tree[id]);
delete tree[id];
});
// cleanup nodes, reassign right ids after we resolved
// to which sections every element belongs
_.each(nodes, function (node, id) {
delete nodes[id];
// compose new id
node.id = id.replace(/^[^.]*\./, '');
// First check for event, because event name can contain '.' and '#'
var idx = node.id.indexOf('@'); // get position of @event start
// Otherwise get property/method delimiter position
if (idx === -1) {
idx = Math.max(node.id.lastIndexOf('.'), node.id.lastIndexOf('#'));
}
if (-1 === idx) {
node.name = node.id;
} else {
node.name = node.id.substring(idx + 1);
node.name_prefix = node.id.substring(0, idx + 1);
}
// sections have lowercased ids, to not clash with other elements
if ('section' === node.type) {
node.id = node.id.toLowerCase();
}
// prototype members have different paths
node.path = node.id.replace(/#/g, '.prototype.');
// events have different paths as well, but only first '@' separates event name
node.path = node.path.replace(/@/, '.event.');
delete node.section;
// prune sections from nodes
if ('section' !== node.type) {
nodes[node.id] = node;
}
});
// assign aliases, subclasses, constructors
// correct method types (class or entity)
_.each(nodes, function (node /*, id*/) {
// aliases
if (node.alias_of && nodes[node.alias_of]) {
nodes[node.alias_of].aliases.push(node.id);
}
// classes hierarchy
if ('class' === node.type) {
//if (d.superclass) console.log('SUPER', id, d.superclass)
if (node.superclass && nodes[node.superclass]) {
nodes[node.superclass].subclasses.push(node.id);
}
return;
}
if ('constructor' === node.type) {
node.id = 'new ' + node.id.replace(/\.new$/, '');
return;
}
// methods and properties
if ('method' === node.type || 'property' === node.type) {
// FIXME: shouldn't it be assigned by parser?
if (node.id.match(/^\$/)) {
node.type = 'utility';
return;
}
// first check for event, because event name can contain '.' and '#'
if (node.id.indexOf('@') >= 0) {
node.type = 'event';
return;
}
if (node.id.indexOf('#') >= 0) {
node.type = 'instance ' + node.type;
return;
}
if (node.id.indexOf('.') >= 0) {
node.type = 'class ' + node.type;
return;
}
}
});
// tree is hash of sections.
// convert sections to uniform children array of tree top level
children = [];
_.each(tree, function (node, id) {
if (id === '') {
children = children.concat(node.children);
} else {
children.push(node);
}
delete tree[id];
});
tree.children = children;
return {list: nodes, tree: tree};
}
////////////////////////////////////////////////////////////////////////////////
/**
* NDoc.parse(files, options, callback) -> Void
* - files (Array): Files to be parsed
* - options (Object): Parser options
* - callback (Function): Notifies parsing is finished with `callback(err, ast)`
*
* Execute `name` parser against `files` with given options.
*
*
* ##### Options
*
* - **linkFormat**: Format for link to source file. This can have variables:
* - `{file}`: Current file
* - `{line}`: Current line
* - `{package.*}`: Any package.json variable
**/
NDoc.parse = function parse(files, options, callback) {
parse_files(files, options, function (err, nodes) {
callback(err, build_tree(nodes, options));
});
};
/**
* NDoc.render(name, ast, options, callback) -> Void
* - name (String): Renderer name
* - ast (Object): Parsed AST (should consist of `list` and `tree`)
* - options (Object): Renderer options
* - callback (Function): Notifies rendering is finished with `callback(err)`
*
* Execute `name` renderer for `ast` with given options.
**/
NDoc.render = function render(name, ast, options, callback) {
if (!renderers[name]) {
callback("Unknown renderer: " + name);
return;
}
renderers[name](ast, options, callback);
};
/**
* NDoc.cli -> cli
**/
NDoc.cli = require('./ndoc/cli');
/**
* NDoc.VERSION -> String
*
* NDoc version.
**/
NDoc.VERSION = require('./ndoc/version');
/**
* NDoc.use(plugin) -> Void
* - plugin (Function): Infection `plugin(NDocClass)`
*
* Runs given `plugin` against NDoc base class.
*
*
* ##### Examples
*
* NDoc.use(require('my-renderer'));
**/
NDoc.use = function use(plugin) {
plugin(this);
};
/**
* NDoc.registerRenderer(name, func) -> Void
* - name (String): Name of the renderer, e.g. `'html'`
* - func (Function): Renderer function `func(ast, options, callback)`
*
* Registers given function as `name` renderer.
**/
NDoc.registerRenderer = function (name, func) {
renderers[name] = func;
};
/**
* NDoc.registerParser(extension, func) -> Void
* - extension (String): Extension suitable for the parser, e.g. `'js'`
* - func (Function): Parser function `func(source, options, callback)`
*
* Registers given function as `name` renderer.
**/
NDoc.registerParser = function (extension, func) {
extension = path.extname('name.' + extension);
Object.defineProperty(parsers, extension, {
get: function () { return func; },
configurable: true
});
};
/**
* NDoc.extensionAlias(alias, extension) -> Void
* - alias (String): Extension as for the parser, e.g. `'cc'`
* - extension (String): Extension as for the parser, e.g. `'js'`
*
* Registers `alias` of the `extension` parser.
*
*
* ##### Example
*
* Parse all `*.cc` files with parser registered for `*.js`
*
* ``` javascript
* ndoc.extensionAlias('cc', 'js');
* ```
*
*
* ##### See Also
*
* - [[NDoc.registerParser]]
**/
NDoc.extensionAlias = function (alias, extension) {
alias = path.extname('name.' + alias);
extension = path.extname('name.' + extension);
Object.defineProperty(parsers, alias, {
get: function () { return parsers[extension]; },
configurable: true
});
};
//
// require base plugins
//
NDoc.use(require(__dirname + '/ndoc/plugins/parsers/javascript'));
NDoc.use(require(__dirname + '/ndoc/plugins/renderers/html'));
NDoc.use(require(__dirname + '/ndoc/plugins/renderers/json'));