guides.js
2.81 KB
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
var path = require('path');
var fs = require('graceful-fs');
var _ = require('lodash');
var gs = require('glob-stream');
var fm = require('front-matter');
var mkdirp = require('mkdirp');
var stream = require('./utils/stream').obj;
var render = require('./utils/render-guide');
module.exports = function (options) {
var guideFilePaths = options.src;
var destDir = options.destDir;
var output = stream.create();
gs.create(guideFilePaths)
.pipe(stream.get('path'))
.pipe(getFileContents())
.pipe(constructGuide(destDir))
.pipe(output);
return output;
};
function getFileContents () {
return stream.asyncMap(function (filepath, enc, done) {
fs.readFile(filepath, function (err, content) {
done(err, {
path: filepath,
content: content.toString()
});
});
});
}
function constructGuide (destDir) {
return stream.concurrent(function (file, enc, done) {
var rawGuide = fm(file.content);
var packageName = getPackageName(file.path);
var guideName = getGuideName(file.path);
if (packageName) guideName = path.join(packageName, guideName);
var guide = _(rawGuide.attributes)
//.omit('updated', 'summary')
.extend({
name: guideName,
package: packageName
})
.value();
// Convert markdown guides to HTML
writeGuidesFile({
src: file.path,
dest: destDir,
body: rawGuide.body
}, function (err) {
done(err, guide)
});
});
}
function writeGuidesFile (options, done) {
var src = options.src;
var body = options.body;
var destDir = options.dest;
var guideDestPath = formatParsedGuideFilepath(src, destDir);
var dir = path.dirname(guideDestPath);
mkdirp(dir, function (err) {
if (err) {
return done(err);
}
fs.writeFile(guideDestPath, render(body), done);
});
}
function getPackageName (filepath) {
var segments = filepath.split('/');
if (segments.indexOf('bower_components') >= 0) {
return segments[segments.length - 3];
}
}
function getGuideName (filepath) {
var segments = filepath.split('/');
return _.last(segments).split('.')[0];
}
function formatParsedGuideFilepath (srcPath, destDir) {
var relativeSrcPath = srcPath
.replace(process.cwd() + path.sep, '')
.split('/')
.filter(function (segment) {
return segment !== 'bower_components';
});
// Elements in the bower_components directory
// need to have the guides segment put before the
// element name in the path
if (relativeSrcPath[0] !== 'guides') {
relativeSrcPath[1] = relativeSrcPath[0];
relativeSrcPath[0] = 'guides';
}
var filename = _.last(relativeSrcPath).split('.')[0] + '.html';
relativeSrcPath = path.dirname(relativeSrcPath.join('/'));
return path.join(
process.cwd(),
destDir,
'data',
relativeSrcPath,
filename
);
}