-
Notifications
You must be signed in to change notification settings - Fork 0
/
publish.js
311 lines (274 loc) · 9.48 KB
/
publish.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
/** @module publish */
const path = require('path');
const ejs = require('ejs');
const fs = require('fs-extra-promise');
const slugify = require('slugify');
const bluebird = require('bluebird');
const LinkHelper = require('./src/helpers/link');
const helpers = {
link: null,
};
/**
* A custom logger.
* @todo replace console calls with Function.prototype when options.debug === false
* @type {Object}
*/
const logger = {
/* eslint-disable no-console */
log: console.log.bind(console),
info: console.info.bind(console),
warn: console.warn.bind(console),
error: console.error.bind(console),
/* eslint-enable no-console */
};
function copyFile(src, dest) {
return fs.readFileAsync(src)
.then(content => fs.outputFile(dest, content));
}
function renderTemplate(relpath, data, options) {
return new Promise((resolve, reject) => {
data.helpers = helpers;
ejs.renderFile(path.resolve(__dirname, relpath), data, options, (err, html) => {
if (err) {
logger.error(err);
return reject(err);
}
resolve(html);
});
});
}
function createRecordPage(outpath, page, wrapper) {
return renderTemplate('tpl/page/record.ejs', page)
.then(html => wrapper(html, page.record.longname))
.then(html => fs.outputFileAsync(path.resolve(outpath, page.recordUrl), html));
}
/**
* Generate documentation output.
*
* @param {TAFFY} data - A TaffyDB collection representing
* all the symbols documented in your code.
* @param {object} opts - An object with options information.
*/
exports.publish = function(data, opts) {
const conf = opts.configure ? JSON.parse(fs.readFileSync(path.resolve(process.cwd(), opts.configure), 'utf-8')) : null;
const pkg = {
name: conf ? conf.title : 'documentation',
};
const tplConf = conf && conf.template ? conf.template : {};
helpers.link = new LinkHelper(tplConf);
const outpath = path.resolve(process.cwd(), opts.destination || 'docs');
// @todo handle multiple entries
const srcpath = path.resolve(process.cwd(), opts._[0]);
const menuData = {};
const pages = [];
// store list of classes declared with "unique identifier" generated from name,
// filename and lineno.
const declaredClasses = new Set();
// @todo move this thing in a "outputTaffy" debug template
// fs.outputFileAsync('./taffydata.json', data().stringify()).then(() => logger.log('output done'));
data({ name: 'AccessibilityManager' }).each(record => console.log(record));
// find modules members
data({ kind: 'module' }).each((module) => {
module.$functions = [];
module.$typedefs = [];
module.$constants = [];
module.$classes = [];
module.$other = [];
data({ memberof: module.longname, undocumented: { '!is': true } }).each(moduleMember => {
moduleMember.skip = true;
switch (moduleMember.kind) {
case 'function':
module.$functions.push(moduleMember);
break;
case 'typedef':
module.$typedefs.push(moduleMember);
break;
case 'constant':
module.$constants.push(moduleMember);
break;
case 'classes':
module.$classes.push(moduleMember);
break;
default:
module.$other.push(moduleMember);
break;
}
});
});
// defines members arrays
data({ kind: ['class', 'interface'] }).each((record) => {
record.$methods = [];
record.$attributes = [];
record.$staticmethods = [];
record.$staticproperties = [];
record.$augments = [];
record.$augmentedBy = [];
});
// associate classes with members
data({ kind: ['class', 'interface'] }).each((record) => {
if (record.description) {
const copy = JSON.parse(JSON.stringify(record));
copy.name = 'constructor';
copy.classConstructor = true;
copy.slug = 'constructor';
record.$methods.push(copy);
}
// find members
data({
memberof: record.longname,
}).each((memberRecord) => {
if (memberRecord.undocumented) {
return;
}
memberRecord.skip = true;
memberRecord.slug = slugify(memberRecord.longname);
if (memberRecord.meta.code.type === 'MethodDefinition' ||
(memberRecord.kind === 'function' && memberRecord.scope === 'instance')) {
record.$methods.push(memberRecord);
} else {
record.$attributes.push(memberRecord);
}
});
// find agmented
if (record.augments) {
record.augments.forEach(typeName => {
const superclassRecord = data({ longname: typeName }).first();
if (superclassRecord && superclassRecord.$augmentedBy !== undefined) {
record.$augments.push(superclassRecord);
superclassRecord.$augmentedBy.push({ name: record.name });
} else {
record.$augments.push({ name: typeName });
}
});
}
});
logger.log('================');
let sourceFiles = [];
data().each((record) => {
if (!record.meta) {
if (record.kind === 'package') {
sourceFiles = record.files;
}
return;
}
if (record.undocumented) return;
const { name, kind, scope } = record;
const { filename, path: filepath, lineno } = record.meta;
console.log(filepath, srcpath);
const relpath = filepath !== srcpath ? filepath.replace(srcpath, '').slice(1, filepath.length - srcpath.length) : '';
const fullpath = path.join(relpath, filename);
const modulepath = relpath;
const menupath = tplConf.referencePaths !== 'folder' ? fullpath.replace('.js', '') : modulepath;
// prefix with menu object keys with `_` to avoid conflict with native
// object methods. e.g. if `menupath === "toString"`
const menukey = `_${menupath}`;
const filepath2 = path.join(relpath, filename);
record.filepath = filepath2;
logger.log(name, '(', fullpath, '-', lineno, ')', kind, scope);
if (kind === 'class' || kind === 'function') {
// check this is not a duplicate record
const classUniqueKey = `${record.londname}:${fullpath}:${lineno}`;
if (declaredClasses.has(classUniqueKey)) {
logger.warn('Dropping duplicate record ', record.longname);
return;
} else {
declaredClasses.add(classUniqueKey);
}
}
if (!menuData[menukey]) {
menuData[menukey] = [];
}
let klassRecord = null;
if (record.meta.code.type === 'MethodDefinition') {
klassRecord = data({ name: record.memberof, kind: 'class' }).first();
if (name === 'applyBlueprint') {
logger.log(klassRecord);
}
if (klassRecord) {
record.skip = true;
} else {
// logger.warn('member will not show up in documentation');
}
} else if (record.scope === 'instance' && record.memberof) {
// attribute
klassRecord = data({ name: record.memberof, kind: 'class' }).first();
if (klassRecord) {
record.skip = true;
} else {
// logger.warn('member attribute will not show up in documentation');
}
}
if (record.kind !== 'member' && !record.skip) {
recordUrl = slugify(`${menupath}-${name}.html`);
if (recordUrl.startsWith('-')) {
recordUrl = recordUrl.slice(1, recordUrl.length - 1);
}
helpers.link.registerType(name, recordUrl);
menuData[menukey].push({
name: name,
kind: kind,
record: record,
scope: scope,
recordUrl: recordUrl,
});
pages.push({
name: name,
kind: kind,
record: record,
tplConf: tplConf,
recordUrl: recordUrl,
});
record.url = recordUrl;
}
});
// build record links
data({ kind: 'typedef', skip: true }).each((record) => {
const moduleRecord = data({ longname: record.memberof }).first();
if (moduleRecord) {
const url = `${moduleRecord.url}#${record.name}`;
helpers.link.registerType(record.name, url);
helpers.link.registerType(record.longname.replace(/^module\:/, ''), url);
record.url = url;
console.log('REGISTER', record.name);
console.log('REGISTER', record.longname);
}
});
let _menuhtml = null;
const menuWrapper = (html, pageTitle) => renderTemplate('tpl/index.ejs', {
menu: _menuhtml,
title: `${pageTitle || 'Doclet'} - ${pkg.name}`,
content: html,
tplConf: tplConf,
});
renderTemplate('tpl/menu/menu.ejs', { menuData: menuData })
.then(html => {
_menuhtml = html;
return html;
})
// index page
.then(html => renderTemplate('tpl/index.ejs', {
menu: html,
title: `Home - ${pkg.name}`,
content: `<div class="doc-gutter">${opts.readme}</div>`,
tplConf: tplConf,
}))
.then(html => fs.outputFileAsync(path.resolve(outpath, 'index.html'), html))
.then(() => bluebird.map(pages, page => createRecordPage(outpath, page, menuWrapper)))
.then(copyFile(path.resolve(__dirname, 'tpl/style.css'), path.resolve(outpath, 'style.css')))
.then(() => bluebird.map(sourceFiles, filepath => {
const relpath = filepath.replace(srcpath, '');
return fs.readFileAsync(filepath, 'utf-8')
.then(source => renderTemplate('tpl/page/source.ejs', {
source: source,
path: filepath.replace(srcpath, ''),
})).then(html => renderTemplate('tpl/index.ejs', {
menu: _menuhtml,
title: `source: ${relpath} - ${pkg.name}`,
content: html,
tplConf: tplConf,
}))
.then(html =>
fs.outputFileAsync(path.resolve(outpath, `source-${slugify(relpath)}.html`), html)
);
}, { concurrency: 5 }));
};