This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
/
index.js
408 lines (358 loc) · 13.8 KB
/
index.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
var _ = require('lodash');
var fs = require('fs');
var os = require('os');
var path = require('path');
var semver = require('semver');
/*jshint -W079 */
var Filter = require('./filter');
var Parser = require('./parser');
var Worker = require('./worker');
var PluginLoader = require('./plugin_loader');
var FileError = require('./errors/file_error');
var ParserError = require('./errors/parser_error');
var WorkerError = require('./errors/worker_error');
// const
var SPECIFICATION_VERSION = '0.3.0';
var defaults = {
excludeFilters: [],
includeFilters: [ '.*\\.(clj|cls|coffee|cpp|cs|dart|erl|exs?|go|groovy|ino?|java|js|jsx|litcoffee|lua|p|php?|pl|pm|py|rb|scala|ts|vue)$' ],
src: path.join(__dirname, '../example/'),
filters: {},
languages: {},
parsers: {},
workers: {},
lineEnding: os.EOL,
encoding: 'utf8'
};
var app = {
options : {}, // see defaults
log : logger,
generator : {},
packageInfos: {},
markdownParser: false,
filters: {
apierror : './filters/api_error.js',
apiheader : './filters/api_header.js',
apiparam : './filters/api_param.js',
apisuccess : './filters/api_success.js'
},
languages: {
'.clj' : './languages/clj.js',
'.coffee' : './languages/coffee.js',
'.erl' : './languages/erl.js',
'.ex' : './languages/ex.js',
'.exs' : './languages/ex.js',
'.litcoffee' : './languages/coffee.js',
'.lua' : './languages/lua.js',
'.pl' : './languages/pm.js',
'.pm' : './languages/pm.js',
'.py' : './languages/py.js',
'.rb' : './languages/rb.js',
'default' : './languages/default.js'
},
parsers: {
api : './parsers/api.js',
apidefine : './parsers/api_define.js',
apidescription : './parsers/api_description.js',
apierror : './parsers/api_error.js',
apierrorexample : './parsers/api_error_example.js',
apiexample : './parsers/api_example.js',
apiheader : './parsers/api_header.js',
apiheaderexample : './parsers/api_header_example.js',
apigroup : './parsers/api_group.js',
apiname : './parsers/api_name.js',
apiparam : './parsers/api_param.js',
apiparamexample : './parsers/api_param_example.js',
apipermission : './parsers/api_permission.js',
apisuccess : './parsers/api_success.js',
apisuccessexample : './parsers/api_success_example.js',
apiuse : './parsers/api_use.js',
apiversion : './parsers/api_version.js',
apisamplerequest : './parsers/api_sample_request.js',
apideprecated : './parsers/api_deprecated.js',
apiprivate : './parsers/api_private.js',
},
workers: {
apierrorstructure : './workers/api_error_structure.js',
apierrortitle : './workers/api_error_title.js',
apigroup : './workers/api_group.js',
apiheaderstructure : './workers/api_header_structure.js',
apiheadertitle : './workers/api_header_title.js',
apiname : './workers/api_name.js',
apiparamtitle : './workers/api_param_title.js',
apipermission : './workers/api_permission.js',
apisamplerequest : './workers/api_sample_request.js',
apistructure : './workers/api_structure.js',
apisuccessstructure : './workers/api_success_structure.js',
apisuccesstitle : './workers/api_success_title.js',
apiuse : './workers/api_use.js'
},
hooks: {},
addHook: addHook,
hook: applyHook
};
var defaultGenerator = {
name : 'apidoc',
time : new Date(),
url : 'https://apidocjs.com',
version: '0.0.0'
};
// TODO: find abetter name for PackageInfos (-> apidoc-conf)
var defaultPackageInfos = {
description: '',
name : '',
sampleUrl : false,
version : '0.0.0',
defaultVersion: '0.0.0'
};
// Simple logger interace
var logger = {
debug : function() { console.log(arguments); },
verbose: function() { console.log(arguments); },
info : function() { console.log(arguments); },
warn : function() { console.log(arguments); },
error : function() { console.log(arguments); }
};
/**
* Return the used specification version
*
* @returns {String}
*/
function getSpecificationVersion() {
return SPECIFICATION_VERSION;
}
/**
* Parser
*
* @param {Object} options Overwrite default options.
* @param {Object} logger Logger (with methods: debug, verbose, info, warn and error is necessary).
* @returns {Mixed} true = ok, but nothing todo | false = error | Object with parsed data and project-informations.
* {
* data : { ... }
* project: { ... }
* }
*/
function parse(options) {
options = _.defaults({}, options, defaults);
// extend with custom functions
app.filters = _.defaults({}, options.filters, app.filters);
app.languages = _.defaults({}, options.languages, app.languages);
app.parsers = _.defaults({}, options.parsers, app.parsers);
app.workers = _.defaults({}, options.workers, app.workers);
app.hooks = _.defaults({}, options.hooks, app.hooks);
// options
app.options = options;
// generator
app.generator = _.defaults({}, app.generator, defaultGenerator);
// packageInfos
app.packageInfos = _.defaults({}, app.packageInfos, defaultPackageInfos);
var parsedFiles = [];
var parsedFilenames = [];
try {
// Log version information
var filename = path.join(__dirname, '../', './package.json');
var packageJson = JSON.parse( fs.readFileSync( filename , 'utf8') );
app.log.verbose('apidoc-generator name: ' + app.generator.name);
app.log.verbose('apidoc-generator version: ' + app.generator.version);
app.log.verbose('apidoc-core version: ' + packageJson.version);
app.log.verbose('apidoc-spec version: ' + getSpecificationVersion());
new PluginLoader(app);
var parser = new Parser(app);
var worker = new Worker(app);
var filter = new Filter(app);
// Make them available for plugins
app.parser = parser;
app.worker = worker;
app.filter = filter;
// if input option for source is an array of folders,
// parse each folder in the order provided.
app.log.verbose('run parser');
if (options.src instanceof Array) {
options.src.forEach(function(folder) {
// Keep same options for each folder, but ensure the 'src' of options
// is the folder currently being processed.
var folderOptions = options;
folderOptions.src = path.join(folder, './');
parser.parseFiles(folderOptions, parsedFiles, parsedFilenames);
});
}
else {
// if the input option for source is a single folder, parse as usual.
options.src = path.join(options.src, './');
parser.parseFiles(options, parsedFiles, parsedFilenames);
}
if (parsedFiles.length > 0) {
// process transformations and assignments
app.log.verbose('run worker');
worker.process(parsedFiles, parsedFilenames, app.packageInfos);
// cleanup
app.log.verbose('run filter');
var blocks = filter.process(parsedFiles, parsedFilenames);
// sort by group ASC, name ASC, version DESC
blocks.sort(function(a, b) {
var nameA = a.group + a.name;
var nameB = b.group + b.name;
if (nameA === nameB) {
if (a.version === b.version)
return 0;
return (semver.gte(a.version, b.version)) ? -1 : 1;
}
return (nameA < nameB) ? -1 : 1;
});
// add apiDoc specification version
app.packageInfos.apidoc = SPECIFICATION_VERSION;
// add apiDoc specification version
app.packageInfos.generator = app.generator;
// api_data
var apiData = JSON.stringify(blocks, null, 2);
apiData = apiData.replace(/(\r\n|\n|\r)/g, app.options.lineEnding);
// api_project
var apiProject = JSON.stringify(app.packageInfos, null, 2);
apiProject = apiProject.replace(/(\r\n|\n|\r)/g, app.options.lineEnding);
return {
data : apiData,
project: apiProject
};
}
return true;
} catch(e) {
// display error by instance
var extra;
var meta = {};
if (e instanceof FileError) {
meta = { 'Path': e.path };
app.log.error(e.message, meta);
} else if (e instanceof ParserError) {
extra = e.extra;
if (e.source)
extra.unshift({ 'Source': e.source });
if (e.element)
extra.unshift({ 'Element': '@' + e.element });
if (e.block)
extra.unshift({ 'Block': e.block });
if (e.file)
extra.unshift({ 'File': e.file });
extra.forEach(function(obj) {
var key = Object.keys(obj)[0];
meta[key] = obj[key];
});
app.log.error(e.message, meta);
}
else if (e instanceof WorkerError) {
extra = e.extra;
if (e.definition)
extra.push({ 'Definition': e.definition });
if (e.example)
extra.push({ 'Example': e.example });
extra.unshift({ 'Element': '@' + e.element });
extra.unshift({ 'Block': e.block });
extra.unshift({ 'File': e.file });
extra.forEach(function(obj) {
var key = Object.keys(obj)[0];
meta[key] = obj[key];
});
app.log.error(e.message, meta);
}
else {
app.log.error(e.message);
if (e.stack)
app.log.debug(e.stack);
}
return false;
}
}
/**
* Set generator informations.
*
* @param {Object} [generator] Generator informations.
* @param {String} [generator.name] Generator name (UI-Name).
* @param {String} [generator.time] Time for the generated doc
* @param {String} [generator.version] Version (semver) of the generator, e.g. 1.2.3
* @param {String} [generator.url] Url to the generators homepage
*/
function setGeneratorInfos(generator) {
app.generator = generator;
}
/**
* Set a logger.
*
* @param {Object} logger A Logger (@see https://github.com/flatiron/winston for details)
* Interface:
* debug(msg, meta)
* verbose(msg, meta)
* info(msg, meta)
* warn(msg, meta)
* error(msg, meta)
*/
function setLogger(logger) {
app.log = logger;
}
/**
* Set the markdown parser.
*
* @param {Object} [markdownParser] Markdown parser.
*/
function setMarkdownParser(markdownParser) {
app.markdownParser = markdownParser;
}
/**
* Set package infos.
*
* @param {Object} [packageInfos] Collected from apidoc.json / package.json.
* @param {String} [packageInfos.name] Project name.
* @param {String} [packageInfos.version] Version (semver) of the project, e.g. 1.0.27
* @param {String} [packageInfos.description] A short description.
* @param {String} [packageInfos.sampleUrl] @see https://apidocjs.com/#param-api-sample-request
*/
function setPackageInfos(packageInfos) {
app.packageInfos = packageInfos;
}
/**
* Register a hook function.
*
* @param {String} name Name of the hook. Hook overview: https://github.com/apidoc/apidoc-core/hooks.md
* @param {Function} func Callback function.
* @param {Integer} [priority=100] Hook priority. Lower value will be executed first.
* Same value overwrite a previously defined hook.
*/
function addHook(name, func, priority) {
priority = priority || 100;
if ( ! app.hooks[name])
app.hooks[name] = [];
app.log.debug('add hook: ' + name + ' [' + priority + ']');
// Find position and overwrite same priority
var replace = 0;
var pos = 0;
app.hooks[name].forEach( function(entry, index) {
if (priority === entry.priority) {
pos = index;
replace = 1;
} else if (priority > entry.priority) {
pos = index + 1;
}
});
app.hooks[name].splice(pos, replace, {
func: func,
priority: priority
});
}
/**
* Execute a hook.
*/
function applyHook(name /* , ...args */) {
if ( ! app.hooks[name])
return Array.prototype.slice.call(arguments, 1, 2)[0];
var args = Array.prototype.slice.call(arguments, 1);
app.hooks[name].forEach( function(hook) {
hook.func.apply(this, args);
});
return args[0];
}
module.exports = {
getSpecificationVersion: getSpecificationVersion,
parse : parse,
setGeneratorInfos : setGeneratorInfos,
setLogger : setLogger,
setMarkdownParser : setMarkdownParser,
setPackageInfos : setPackageInfos
};