Skip to content

Commit

Permalink
Enhanced joDoc to also work directly with a browser
Browse files Browse the repository at this point in the history 
It uses command line arguments to decide what to render
Things are rendered as if no output-dir was provided.
Serves up binary data if requested form the output-dir, so in fact the previous line could work on the multifile version
Refactored much of the code with better spacing and encapsulation
Fixed issue with index being appended multiple times, it now replaces the index
  • Loading branch information
@drewwells
drewwells committed Jul 15, 2011
1 parent f4d8e8e commit 2b6299d
Showing 1 changed file with 203 additions and 62 deletions.
265 changes: 203 additions & 62 deletions jodoc.js
View file
Original file line number Diff line number Diff line change
@@ -1,46 +1,60 @@
#!/usr/bin/env node

var fs = require('fs');
var path = require('path');
var jodoc = require(__dirname + '/lib/jodoc-lib.js');
var markdown = require(__dirname + '/lib/showdown.js').showdown;
var fs = require('fs'),
path = require('path'),
jodoc = require(__dirname + '/lib/jodoc-lib.js'),
markdown = require(__dirname + '/lib/showdown.js').showdown;

var options = {};
var sys = require('sys'),
http = require('http');

//Return an options struct, with files
function getOptions() {
var args = process.argv.slice(2),
arg = '',
options = {
files: []
};

// process commandline arguments
function getOpts() {
var args = process.argv.slice(2), arg = '';
var files = [];
while(args.length > 0) {
arg = args.shift();
switch(arg)
{
case '--output':
case '-o': options.output = args.shift();
break;
case '--server':
case '-s': options.server = true;
//Allow port to be passed optionally
if( !isNaN( args[0] ) ){
options.server = args.shift();
}
break;

case '--output':
case '-o': options.output = args.shift();
break;

case '--template': options.template = args.shift();
break;
case '--template': options.template = args.shift();
break;

case '--toc': options.toc = args.shift();
break;
case '--toc': options.toc = args.shift();
break;

case '-t':
case '--title': options.title = args.shift();
break;
case '-t':
case '--title': options.title = args.shift();
break;

case '-ni':
case '--no-index': options.noindex = true;
break;
case '-ni':
case '--no-index': options.noindex = true;
break;

default: files.push(arg);
default: options.files.push(arg);
}
}
return files;
return options;
}

// avoid recursing down VCS directories
function no_vcs(infile) {

// If there's any more, feel free to add
var vcs = /^\.(git|svn|cvs|hg|bzr)$/;
infile = path.basename(infile);
Expand All @@ -49,41 +63,49 @@ function no_vcs(infile) {

// recursively flatten folders into files
function flatten_files(infiles) {
var stat;
var outfiles = [];

var stat,
outfiles = [];

infiles = infiles.filter(no_vcs);
infiles.forEach(function(file) {
stat = fs.statSync(file);
if (stat.isDirectory()) {
// make sure readdir puts path back in after
var newfiles = fs.readdirSync(file).map(function(f){return path.join(file,f)});
var newfiles = fs.readdirSync(file).map(function(f){
return path.join(file,f);
});
// recurse
var flat = flatten_files(newfiles);
// add the flattened bits back in
outfiles = outfiles.concat(flat);
}
/*
* I assume it is a regular file here
* Don't do a stupid and run jodoc on a block device or socket
* You're gonna have a bad time
*/
* I assume it is a regular file here
* Don't do a stupid and run jodoc on a block device or socket
* You're gonna have a bad time
*/
else {
outfiles.push(file);
outfiles.push( file );
}
});
return outfiles;
}

function main() {
var files = getOpts();
(function main( ) {

var options = getOptions(), //Parse command line arguments
files = options.files;

// if no files given, glob the current directory
if (!files.length) {
files.push('.');
}
files = flatten_files(files);

// filter files
files = files.filter(function (file) { return file.match(/\.(js|css|htm[l]?|md(own)?|markdown)$/) });
files = flatten_files( files ).filter(function( file ){
return file.match(/\.(js|css|htm[l]?|md(own)?|markdown)$/);
});

// read files
files = files.map(function (file) {
Expand All @@ -92,50 +114,169 @@ function main() {
if (file.match(/\.(js|css)$/)) {
content = jodoc.docker(content);
}
return {name: file, content: content};
return {
name: file,
content: content
};
});

for(var i = 0, len = files.length; i < len; i++) {
if (!files[i].name.match(/\.htm[l]?$/)) {
files[i].content = markdown(files[i].content);

if ( !files[i].name.match( /\.htm[l]?$/ ) ) {

files[i].content = markdown( files[i].content );
}
}

// toclink the incoming files
if (options.output && options.toc) {
var toc = fs.readFileSync(options.toc, "utf8").toString().split("\n");
var marked_toc = markdown(jodoc.toclinker(toc,files));
files.push({name:"_content", content: marked_toc});
var toc = fs.readFileSync( options.toc, "utf8" ).toString().split("\n");
var marked_toc = markdown( jodoc.toclinker( toc, files ) );
files.push({
name:"_content",
content: marked_toc
});
}
files = files.map(function(file){ file.name = jodoc.munge_filename(file.name); return file; });
var h1stuff = jodoc.h1finder(files);
var linked_files = jodoc.autolink(files,h1stuff.h1s,options.output);
var index = jodoc.indexer(h1stuff.h1s, options.output);
var template;
if (options.template) {
template = fs.readFileSync(options.template,"utf8").toString();
files = files.map(function( file ){

file.name = jodoc.munge_filename(file.name);
return file;
});

if( options.server ){

http.createServer(function( request, response ){

var linked_files,
content;

var filePath = '.' + request.url;

if( filePath !== './' ){ //Files will be looked up via output, if not available

filePath = options.output + filePath;
path.exists(filePath, function(exists) {

if( exists ){
fs.readFile(filePath, "binary", function(error, content) {
if (error) {
response.writeHead(500);
response.end();
}
else {
response.writeHead(200);//, { 'Content-Type': 'text/html' });
response.end( content, 'binary' );
}
});
}
else {
response.writeHead(404);
response.end();
}
});

} else {

linked_files = jodoc.autolink( files,
jodoc.h1finder( files ).h1s,
options.output
);

content = linked_files.map(function( lf ){
return lf.content;
}).join('\n');

response.writeHead( 200, { "Content-Type": "text/html" });

response.end(
jodoc.html_header( content, options.title,
options.template ?
fs.readFileSync(options.template,"utf8").toString() :
undefined )
);


writeToDisk( files, options.output, options.template, options.noindex, options.title );
}
}).listen( !isNaN( options.web ) ? options.web : 1337
, 'localhost');

sys.puts("Server running at http://localhost:1337");

}
if (options.output) {
if (!path.existsSync(options.output)) {
fs.mkdirSync(options.output,0777);

writeToDisk( files, options.output, options.template, options.noindex, options.title );
})();


function indexOfName( arr, name ){
for( var i = 0, l = arr.length; i<l; i++ ){
if( arr[i].name === name ){
return i;
}
if (!options.noindex) {
linked_files.push({name:"_index.html",content:index});
}
return -1;
}

function writeToDisk( files, output, template, noindex, title ){

var h1stuff = jodoc.h1finder( files ),
linked_files = jodoc.autolink( files, h1stuff.h1s, output ),
index = jodoc.indexer( h1stuff.h1s, output),
i;

if( template ){
template = fs.readFileSync( template, "utf8" ).toString();
}

if( !noindex ){
i = indexOfName( linked_files, '_index.html' );
if( ~i ){ //Previous index not found

linked_files.push({
name:"_index.html",
content:index
});
} else {

linked_files[i] = {
name: '_index.html',
content: index
};
}

}

//Create multiple files or just one
if( output ){

if ( !path.existsSync( output ) ) {
fs.mkdirSync( output, 0777 );
}
linked_files.forEach(function(lf) {
var out = jodoc.html_header(lf.content,options.title,template);
fs.writeFile(path.join(options.output,lf.name),out,'utf8',failfast);

linked_files.forEach(function( lf ){

var out = jodoc.html_header( lf.content, title, template );
fs.writeFile( path.join( output,lf.name ), out, 'utf8', failfast );
});

} else {
var out = linked_files.map(function(lf) {return lf.content});
out = out.join('\n');
out = jodoc.html_header(out,options.title,template);
process.stdout.write(out);

var out = linked_files.map(function( lf ){

return lf.content;
}).join('\n');

out = jodoc.html_header( out, title, template );

process.stdout.write( out );
}
}

function failfast(err) {

if (err) throw err;
};

main();


0 comments on commit 2b6299d

Please sign in to comment.