-
Notifications
You must be signed in to change notification settings - Fork 23
/
Copy pathdocumentation.js
553 lines (542 loc) · 17.6 KB
/
documentation.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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
const fs = require('fs')
const path = require('path')
module.exports = {
writeAPI,
writeEnvironment,
writeSitemap
}
function writeAPI () {
const testsFilePath = path.join(global.applicationPath, 'tests.txt')
if (!fs.existsSync(testsFilePath)) {
return
}
let tests = fs.readFileSync(testsFilePath).toString()
tests = tests.substring(tests.indexOf('\n\n'))
while (true) {
const lastTick = tests.lastIndexOf('✓')
const lastLineBreak = tests.lastIndexOf('\n')
if (lastLineBreak > lastTick) {
tests = tests.substring(0, lastLineBreak)
} else {
break
}
}
tests = tests.split('\n\n')
const api = {}
const categories = ['exceptions', 'receives', 'configuration', 'returns', 'redacts']
const verbs = ['get', 'post', 'patch', 'pull', 'delete', 'options', 'head']
for (const test of tests) {
const item = {
url: '',
verb: '',
auth: '',
receives: [],
exceptions: {},
redacts: [],
returns: [],
configuration: []
}
const lines = test.split('\n')
const done = []
let exception
for (let line of lines) {
line = line.trim()
if (!line) {
continue
}
if (!done.length) {
item.url = line
if (!global.sitemap[line]) {
continue
}
item.auth = global.sitemap[item.url].auth !== false
for (const verb of verbs) {
if (global.sitemap[line].api[verb]) {
item.verb = verb
break
}
}
done.push('url')
continue
}
const type = done[done.length - 1]
if (!line.startsWith('✓')) {
if (categories.indexOf(line) > -1) {
done.push(line)
continue
}
exception = line
continue
} else {
line = line.substring(2)
}
if (type === 'exceptions') {
item.exceptions[exception] = item.exceptions[exception] || []
item.exceptions[exception].push(line)
continue
}
if (!item[type] || !item[type].push) {
continue
}
item[type].push(line)
}
api[item.url] = item
}
const sortedURLs = []
for (const url in api) {
sortedURLs.push(url)
}
sortedURLs.sort()
let url = global.dashboardServer
if (global.applicationServer) {
url += ' (dashboard)\n'
url += global.applicationServer + ' (application)'
}
const output = [
'@userdashboard/dashboard ' + global.packageJSON.version,
'\n',
url,
'\n'
]
const groups = ['receives', 'returns', 'redacts', 'exceptions', 'configuration', 'override']
for (const url of sortedURLs) {
const columns = {}
const route = api[url]
if (route.exceptions) {
const exceptions = []
for (const key in route.exceptions) {
exceptions.push(key)
for (const i in route.exceptions[key]) {
const reason = route.exceptions[key][i]
exceptions.push(` * ${reason}`)
if (reason.startsWith('missing')) {
const receives = reason.replace('missing', 'required')
const optional = reason.replace('missing', 'optional')
if (route.receives.indexOf(optional) === -1) {
route.receives.unshift(receives)
}
}
}
}
route.exceptions = exceptions
}
for (const category of groups) {
if (!route[category] || !route[category].length) {
continue
}
columns[category] = category.length + 4
for (const entry of route[category]) {
if (entry.length + 4 > columns[category]) {
columns[category] = entry.length + 4
}
}
}
const groupData = {}
let totalWidth = 0
for (const key of groups) {
if (!route[key] || !route[key].length) {
continue
}
groupData[key] = route[key]
totalWidth += columns[key]
}
if (url.length + 4 > totalWidth) {
for (const key of groups) {
if (!columns[key]) {
continue
}
columns[key] = url.length + 4
break
}
totalWidth = 0
for (const key of groups) {
if (!route[key] || !route[key].length) {
continue
}
totalWidth += columns[key]
}
}
let tallestGroup = 0
for (const key in groupData) {
if (groupData[key].length > tallestGroup) {
tallestGroup = groupData[key].length
}
}
if (tallestGroup === 0) {
continue
}
const topBorder = underlineRight('|', totalWidth)
const urlLine = padRight('| ' + url, totalWidth)
output.push('\n' + topBorder + '|\n' + urlLine + '|\n')
for (const key in groupData) {
const title = underlineRight('| ' + key.toUpperCase(), columns[key])
output.push(title)
}
output.push('|\n')
for (let i = 0, len = tallestGroup; i < len; i++) {
const line = []
for (const key in groupData) {
const groupData = route[key]
if (!groupData || !groupData.length || groupData.length < i || !groupData[i]) {
const segment = padRight('|', columns[key])
line.push(segment)
continue
}
const title = padRight('| ' + groupData[i], columns[key])
line.push(title)
}
output.push(line.join('') + '|\n')
}
for (const key in groupData) {
let segment = '|'
while (segment.length < columns[key]) {
segment += '-'
}
output.push(segment)
}
output.push('|\n')
}
const filePath = path.join(global.applicationPath, 'api.txt')
fs.writeFileSync(filePath, output.join(''))
}
function writeEnvironment () {
const testsFilePath = path.join(global.applicationPath, 'tests.txt')
if (!fs.existsSync(testsFilePath)) {
return
}
let tests = fs.readFileSync(testsFilePath).toString()
tests = tests.substring(0, tests.indexOf('internal-api'))
tests = tests.split('\n')
let start = false
const properties = {}
let lastProperty
for (const i in tests) {
const line = tests[i].trim()
if (!line.length) {
continue
}
if (!start) {
if (line === 'index') {
start = true
}
continue
}
if (line.indexOf(' ') === -1) {
lastProperty = line
properties[lastProperty] = {}
continue
}
if (!lastProperty) {
continue
}
if (!properties[lastProperty].description) {
properties[lastProperty].description = line
continue
}
if (line.indexOf('default') > -1) {
properties[lastProperty].default = line.substring('✓ default '.length).trim()
if (!properties[lastProperty].default.length) {
properties[lastProperty].default = 'unset'
}
} else {
properties[lastProperty].value = line.substring('✓ '.length)
lastProperty = null
}
}
let maximumPropertySize = 0
let maximumDescriptionSize = 0
let maximumValueSize = 0
let maximumDefaultSize = 0
for (const property in properties) {
if (property.length > maximumPropertySize) {
maximumPropertySize = property.length
}
if (properties[property].description && properties[property].description.length > maximumDescriptionSize) {
maximumDescriptionSize = properties[property].description.length
}
let value = properties[property].value || ''
if (value.indexOf(',') > -1) {
value = value.split(',').join(', ')
}
if (value.length > maximumValueSize) {
maximumValueSize = value.length
}
if (properties[property].default && properties[property].default.length > maximumDefaultSize) {
maximumDefaultSize = properties[property].default.length
}
}
maximumPropertySize += 4
maximumDescriptionSize += 2
maximumValueSize += 2
maximumDefaultSize += 2
const output = []
const sorted = Object.keys(properties).sort()
sorted.unshift('Environment variable', '')
properties['Environment variable'] = {
description: 'Description',
default: 'Default value',
value: 'Configured value'
}
properties[''] = {
description: '',
default: '',
value: ''
}
let dotted
for (const property of sorted) {
const delimiter = property === '' ? '-' : ' '
let propertyPadding = ''
const description = properties[property].description
const unset = properties[property].default || ''
let value = properties[property].value || ''
if (value.indexOf(',') > -1) {
value = value.split(',').join(', ')
}
while (property.length + propertyPadding.length < maximumPropertySize) {
propertyPadding += delimiter
}
let descriptionPadding = ''
while (description.length + descriptionPadding.length < maximumDescriptionSize) {
descriptionPadding += delimiter
}
let valuePadding = ''
while (value.length + valuePadding.length < maximumValueSize) {
valuePadding += delimiter
}
let defaultPadding = ''
while (unset.length + defaultPadding.length < maximumDefaultSize) {
defaultPadding += delimiter
}
output.push(`|${delimiter}${property}${propertyPadding}${delimiter}|${delimiter}${description}${descriptionPadding}${delimiter}|${delimiter}${unset}${defaultPadding}${delimiter}|${delimiter}${value}${valuePadding}${delimiter}|`)
if (property === '') {
dotted = output[output.length - 1]
}
}
output.unshift(dotted)
output.push(dotted)
const filePath = path.join(global.applicationPath, 'env.txt')
fs.writeFileSync(filePath, output.join('\n'))
return output.join('\n')
}
function writeSitemap () {
const configuration = parseDashboardConfiguration()
let widestURL = 'URL '.length
let widestHTML = 'HTML '.length
let widestJS = 'NODEJS '.length
const sortedURLs = []
for (const url in configuration.urls) {
sortedURLs.push(url)
if (url.length > widestURL) {
widestURL = url.length
}
const route = configuration.urls[url]
if (route.htmlFilePath && trimNodeModulePath(route.htmlFilePath).length + 4 > widestHTML) {
widestHTML = trimNodeModulePath(route.htmlFilePath).length + 4
}
if (route.jsFilePath && trimNodeModulePath(route.jsFilePath).length + 4 > widestJS) {
widestJS = trimNodeModulePath(route.jsFilePath).length + 4
}
}
sortedURLs.sort()
let url = global.dashboardServer
if (global.applicationServer) {
url += ' (dashboard)\n'
url += global.applicationServer + ' (application)'
}
const output = [
'@userdashboard/dashboard ' + global.packageJSON.version,
url
]
output.push('\nAdministrator menu:')
for (const item of configuration.administrator) {
output.push(item)
}
output.push('\nAccount menu:')
for (const item of configuration.account) {
output.push(item)
}
output.push('\nSpecial HTML files:',
trimApplicationPath(configuration.templateHTMLPath),
trimApplicationPath(configuration.errorHTMLPath),
trimApplicationPath(configuration.redirectHTMLPath))
if (configuration.modules.length) {
output.push('\nDashboard modules:')
const formatted = []
for (const item of configuration.modules) {
formatted.push(`${item.name} (${item.version})`)
}
output.push(formatted.join('\n'))
}
if (configuration.content.length) {
output.push('\nContent handlers:')
for (const item of configuration.content) {
output.push(item)
}
}
if (configuration.server.length) {
output.push('\nServer handlers:')
for (const item of configuration.server) {
output.push(item)
}
}
if (configuration.proxy.length) {
output.push('\nProxy handlers:')
for (const item of configuration.proxy) {
output.push(item)
}
}
for (const url of sortedURLs) {
const route = configuration.urls[url]
const routeURL = padRight(url, widestURL)
const routeHTML = padRight(route.htmlFilePath ? trimNodeModulePath(route.htmlFilePath) : '', widestHTML)
const routeJS = padRight(trimNodeModulePath(route.jsFilePath), widestJS)
const routeVerbs = padRight(route.verbs, 'HTTP REQUESTS '.length)
const routeAuth = padRight(route.authDescription, 'AUTH '.length)
const routeTemplate = padRight(route.templateDescription, 'TEMPLATE '.length)
output.push(`${routeURL} ${routeAuth} ${routeTemplate} ${routeVerbs} ${routeJS} ${routeHTML}`)
}
const routeURL = underlineRight('URL ', widestURL)
const routeAuth = underlineRight('AUTH ', 'AUTH '.length)
const routeTemplate = underlineRight('TEMPLATE ', 'TEMPLATE '.length)
const routeVerbs = underlineRight('HTTP REQUESTS ', 'HTTP REQUESTS '.length)
const routeJS = underlineRight('NODEJS ', widestJS)
const routeHTML = underlineRight('HTML ', widestHTML)
output.splice(output.length - sortedURLs.length, 0, `\n${routeURL} ${routeAuth} ${routeTemplate} ${routeVerbs} ${routeJS} ${routeHTML}`)
const filePath = path.join(global.applicationPath, 'sitemap.txt')
fs.writeFileSync(filePath, output.join('\n'))
return output.join('\n')
}
function parseDashboardConfiguration () {
const configuration = {
administrator: [],
account: [],
modules: [],
content: [],
server: [],
proxy: [],
urls: {},
templateHTMLPath: trimApplicationPath(global.packageJSON.dashboard.templateHTMLPath),
errorHTMLPath: trimApplicationPath(global.packageJSON.dashboard.errorHTMLPath),
redirectHTMLPath: trimApplicationPath(global.packageJSON.dashboard.redirectHTMLPath)
}
const HTML = require('./src/html.js')
for (const link of global.packageJSON.dashboard.menus.administrator) {
const item = HTML.parse(`<div>${link}</div>`).child[0]
if (!item.attr) {
continue
}
let text = item.toString()
text = text.substring(text.indexOf('>') + 1)
text = text.substring(0, text.indexOf('</a>'))
text = text.replace('&', '&')
if (item.attr['data-module']) {
configuration.administrator.push(item.attr['data-module'] + '/src/www' + item.attr.href + ' "' + text + '"')
} else {
configuration.administrator.push(item.attr.href + ' "' + text + '"')
}
}
for (const link of global.packageJSON.dashboard.menus.account) {
const item = HTML.parse(`<div>${link}</div>`).child[0]
if (!item.attr) {
continue
}
let text = item.toString()
text = text.substring(text.indexOf('>') + 1)
text = text.substring(0, text.indexOf('</a>'))
text = text.replace('&', '&')
if (item.attr['data-module']) {
configuration.account.push(item.attr['data-module'] + '/src/www' + item.attr.href + ' "' + text + '"')
} else {
configuration.account.push(item.attr.href + ' "' + text + '"')
}
}
if (global.packageJSON.dashboard.moduleNames.length) {
for (const i in global.packageJSON.dashboard.moduleNames) {
const name = global.packageJSON.dashboard.moduleNames[i]
const version = global.packageJSON.dashboard.moduleVersions[i]
configuration.modules.push({ name, version })
}
}
if (global.packageJSON.dashboard.contentFilePaths.length) {
for (const item of global.packageJSON.dashboard.contentFilePaths) {
configuration.content.push(item[0] === '@' ? item : trimApplicationPath(item))
}
}
if (global.packageJSON.dashboard.serverFilePaths.length) {
for (const item of global.packageJSON.dashboard.serverFilePaths) {
configuration.server.push(item[0] === '@' ? item : trimApplicationPath(item))
}
}
if (global.packageJSON.dashboard.proxyFilePaths.length) {
for (const item of global.packageJSON.dashboard.proxyFilePaths) {
configuration.proxy.push(item[0] === '@' ? item : trimApplicationPath(item))
}
}
const httpVerbs = ['DELETE', 'HEAD', 'GET', 'OPTIONS', 'PATCH', 'POST', 'PUT']
for (const url in global.sitemap) {
const route = global.sitemap[url]
const item = configuration.urls[url] = {}
item.htmlFilePath = route.htmlFilePath
item.jsFilePath = route.jsFilePath
item.templateDescription = route.template === false ? 'FULLSCREEN' : ''
item.verbs = ''
if (url.startsWith('/api/')) {
item.authDescription = route.api.auth === false ? 'GUEST' : ''
const verbs = []
for (const verb of httpVerbs) {
if (route.api[verb.toLowerCase()]) {
verbs.push(verb)
}
}
item.verbs = verbs.join(' ')
} else {
item.authDescription = route.auth === false ? 'GUEST' : ''
const verbs = []
if (route.jsFilePath === 'static-page') {
verbs.push('GET')
} else {
const pageFile = route.api
for (const verb of httpVerbs) {
if (pageFile[verb.toLowerCase()]) {
verbs.push(verb)
}
}
}
item.verbs = verbs.join(' ')
}
}
return configuration
}
function trimApplicationPath (str) {
if (!str) {
return 'static-page'
}
if (str.startsWith('/src/www/')) {
return '/src/www'
}
if (!str.startsWith(global.applicationPath)) {
return str
}
const trimmed = str.substring(global.applicationPath.length)
if (trimmed.startsWith('/node_modules/')) {
return trimNodeModulePath(trimmed)
}
return trimmed
}
function trimNodeModulePath (str) {
if (!str) {
return 'static-page'
}
if (str.indexOf('/src/www/') === 0) {
return '/src/www'
}
return str.substring('/node_modules/'.length).split('/src/www')[0]
}
function padRight (str, totalSize) {
const blank = ' '
return (str + blank).substring(0, totalSize)
}
function underlineRight (str, totalSize) {
const blank = '--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------'
return (str + blank).substring(0, totalSize)
}