/
index.js
267 lines (229 loc) · 6.29 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
/*!
* Dox
* Copyright(c) 2010 TJ Holowaychuk <tj@vision-media.ca>
* MIT Licensed
*/
/**
* Module dependencies.
*/
require.paths.unshift(__dirname + '/koala/lib');
var sys = require('sys'),
fs = require('fs'),
path = require('path'),
koala = require('koala'),
utils = require('./utils'),
markdown = require('./markdown/lib/markdown');
/**
* Library version.
*/
var version = '0.0.1';
/**
* Style name.
*
* @type String
*/
var style = 'default';
/**
* Project title.
*
* @type String
*/
var title = 'Dont forget to use --title to specify me!';
/**
* Parse JSDoc.
*
* @type Boolean
*/
var jsdoc = true;
/**
* Project description.
*
* @type String
*/
var desc = '';
/**
* Show private code.
*
* @type Boolean
*/
var showPrivate = false;
/**
* Github url for the ribbon.
*
* @type String
*/
var ribbon = '';
/**
* Usage documentation.
*/
var usage = ''
+ 'Usage: dox [options] <file ...>\n'
+ '\n'
+ 'Options:\n'
+ ' -t, --title STR Project title\n'
+ ' -d, --desc STR Project description (markdown)\n'
+ ' -r, --ribbon URL Github ribbon url\n'
+ ' -s, --style NAME Document style, available: ["default"]\n'
+ ' -J, --no-jsdoc Disable jsdoc parsing (coverts to markdown)\n'
+ ' -p, --private Output private code in documentation\n'
+ ' -v, --version Output dox library version\n'
+ ' -h, --help Display help information'
+ '\n';
/**
* Log the given message.
*
* @param {String} msg
* @api private
*/
function log(msg){
sys.error('... ' + msg);
}
/**
* Parse the given arguments.
*
* @param {Array} args
* @api public
*/
exports.parse = function(args){
var files = [];
// Require an argument
function requireArg(){
if (args.length) {
return args.shift();
} else {
throw new Error(arg + ' requires an argument.');
}
}
// Parse arguments
while (args.length) {
var arg = args.shift();
switch (arg) {
case '-h':
case '--help':
sys.puts(usage);
process.exit(1);
break;
case '-v':
case '--version':
sys.puts(version);
process.exit(1);
break;
case '-t':
case '--title':
title = requireArg();
break;
case '-d':
case '--desc':
desc = requireArg();
break;
case '-s':
case '--style':
style = requireArg();
break;
case '-J':
case '--no-jsdoc':
jsdoc = false;
break;
case '-p':
case '--private':
showPrivate = true;
break;
case '-r':
case '--ribbon':
ribbon = requireArg();
break;
default:
files.push(arg);
}
}
if (files.length) {
log('parsing ' + files.length + ' file(s)');
var pending = files.length;
// Style
log('loading ' + style + ' style');
var head = fs.readFileSync(__dirname + '/styles/' + style + '/head.html', 'utf8');
var foot = fs.readFileSync(__dirname + '/styles/' + style + '/foot.html', 'utf8');
var css = fs.readFileSync(__dirname + '/styles/' + style + '/style.css', 'utf8');
// Substitutions
head = head.replace(/\{\{title\}\}/g, title).replace(/\{\{style\}\}/, css);
// Ribbon
if (ribbon) {
log('generating ribbon');
sys.print('<a href="' + ribbon + '">'
+ '<img alt="Fork me on GitHub" id="ribbon"'
+ ' src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png">'
+ '</a>');
}
sys.print(head);
sys.print('<table id="source"><tbody>');
// Render files
var first = true;
files.forEach(function(file){
log('parsing ' + file);
fs.readFile(file, 'utf8', function(err, str){
if (err) throw err;
if (first) {
if (desc) desc = markdown.toHTML(desc);
sys.print('<tr><td><h1>' + title + '</h1>' + desc + '</td><td></td></tr>');
first = false;
}
sys.print('<tr class="filename"><td><h2 id="' + file + '"><a href="#">'
+ path.basename(file, '.js') + '</a></h2></td><td>'
+ file + '</td></tr>');
sys.print(render(str, file));
--pending || sys.print(foot, '</tbody></table>');
});
});
} else {
throw new Error('files required.');
}
};
/**
* Generate html for the given string of code.
*
* - foo
* - bar
* - baz
*
* @param {String} str
* @param {String} file
* @return {String}
* @api public
*/
var render = exports.render = function(str, file){
var parts = str.split(/\s*\/\*([^]+?)\*\/\s*/g),
blocks = [];
// Populate blocks
for (var i = 0, len = parts.length; i < len; ++i) {
var part = parts[i],
next = parts[i + 1] || '';
// Empty
if (/^\s*$/.test(part)) {
continue;
// Ignored comment
} else if (/^!\s*\*/.test(part)) {
continue;
} else {
++i;
// Support @ignore and --private
if (utils.ignore(part) || (utils.isPrivate(part) && !showPrivate)) continue;
var part = part.replace(/^ *\* ?/gm, '');
blocks.push({
comment: markdown.toHTML(utils.toMarkdown(part)),
code: koala.render(".js", utils.escape(next))
});
}
}
// Generate html
var html = [];
for (var i = 0, len = blocks.length; i < len; ++i) {
var block = blocks[i];
html.push('<tr class="code">');
html.push('<td class="docs">', block.comment || '', '</td>');
html.push('<td class="code">', block.code
? '<pre><code>' + block.code + '</code></pre>'
: '', '</td>');
html.push('</tr>');
}
return html.join('\n');
};