forked from jashkenas/docco
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docco.js
155 lines (155 loc) · 5.25 KB
/
docco.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
(function() {
var destination, docco_styles, docco_template, ensure_directory, exec, ext, fs, generate_documentation, generate_html, get_language, highlight, highlight_end, highlight_start, l, languages, parse, path, showdown, sources, spawn, template, _ref;
generate_documentation = function(source, callback) {
return fs.readFile(source, "utf-8", function(error, code) {
var sections;
if (error) {
throw error;
}
sections = parse(source, code);
return highlight(source, sections, function() {
generate_html(source, sections);
return callback();
});
});
};
parse = function(source, code) {
var code_text, docs_text, has_code, language, line, lines, save, sections, _i, _len;
lines = code.split('\n');
sections = [];
language = get_language(source);
has_code = docs_text = code_text = '';
save = function(docs, code) {
return sections.push({
docs_text: docs,
code_text: code
});
};
for (_i = 0, _len = lines.length; _i < _len; _i++) {
line = lines[_i];
if (line.match(language.comment_matcher) && !line.match(language.comment_filter)) {
if (has_code) {
save(docs_text, code_text);
has_code = docs_text = code_text = '';
}
docs_text += line.replace(language.comment_matcher, '') + '\n';
} else {
has_code = true;
code_text += line + '\n';
}
}
save(docs_text, code_text);
return sections;
};
highlight = function(source, sections, callback) {
var language, output, pygments, section, _i, _len, _results;
language = get_language(source);
pygments = spawn('pygmentize', ['-l', language.name, '-f', 'html', '-O', 'encoding=utf-8']);
output = '';
pygments.stderr.addListener('data', function(error) {
if (error) {
return console.error(error);
}
});
pygments.stdout.addListener('data', function(result) {
if (result) {
return output += result;
}
});
pygments.addListener('exit', function() {
var fragments, i, section, _len;
output = output.replace(highlight_start, '').replace(highlight_end, '');
fragments = output.split(language.divider_html);
for (i = 0, _len = sections.length; i < _len; i++) {
section = sections[i];
section.code_html = highlight_start + fragments[i] + highlight_end;
section.docs_html = showdown.makeHtml(section.docs_text);
}
return callback();
});
pygments.stdin.write((function() {
_results = [];
for (_i = 0, _len = sections.length; _i < _len; _i++) {
section = sections[_i];
_results.push(section.code_text);
}
return _results;
}()).join(language.divider_text));
return pygments.stdin.end();
};
generate_html = function(source, sections) {
var dest, html, title;
title = path.basename(source);
dest = destination(source);
html = docco_template({
title: title,
sections: sections,
sources: sources,
path: path,
destination: destination
});
console.log("docco: " + source + " -> " + dest);
return fs.writeFile(dest, html);
};
fs = require('fs');
path = require('path');
showdown = require('./../vendor/showdown').Showdown;
_ref = require('child_process'), spawn = _ref.spawn, exec = _ref.exec;
languages = {
'.coffee': {
name: 'coffee-script',
symbol: '#'
},
'.js': {
name: 'javascript',
symbol: '//'
},
'.rb': {
name: 'ruby',
symbol: '#'
},
'.py': {
name: 'python',
symbol: '#'
}
};
for (ext in languages) {
l = languages[ext];
l.comment_matcher = new RegExp('^\\s*' + l.symbol + '\\s?');
l.comment_filter = new RegExp('(^#![/]|^\\s*#\\{)');
l.divider_text = '\n' + l.symbol + 'DIVIDER\n';
l.divider_html = new RegExp('\\n*<span class="c1?">' + l.symbol + 'DIVIDER<\\/span>\\n*');
}
get_language = function(source) {
return languages[path.extname(source)];
};
destination = function(filepath) {
return 'docs/' + path.basename(filepath, path.extname(filepath)) + '.html';
};
ensure_directory = function(callback) {
return exec('mkdir -p docs', function() {
return callback();
});
};
template = function(str) {
return new Function('obj', 'var p=[],print=function(){p.push.apply(p,arguments);};' + 'with(obj){p.push(\'' + str.replace(/[\r\t\n]/g, " ").replace(/'(?=[^<]*%>)/g, "\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g, "',$1,'").split('<%').join("');").split('%>').join("p.push('") + "');}return p.join('');");
};
docco_template = template(fs.readFileSync(__dirname + '/../resources/docco.jst').toString());
docco_styles = fs.readFileSync(__dirname + '/../resources/docco.css').toString();
highlight_start = '<div class="highlight"><pre>';
highlight_end = '</pre></div>';
sources = process.ARGV.sort();
if (sources.length) {
ensure_directory(function() {
var files, next_file;
fs.writeFile('docs/docco.css', docco_styles);
files = sources.slice(0);
next_file = function() {
if (files.length) {
return generate_documentation(files.shift(), next_file);
}
};
return next_file();
});
}
}).call(this);