-
Notifications
You must be signed in to change notification settings - Fork 482
/
sort.js
117 lines (109 loc) · 3.43 KB
/
sort.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
/* @flow */
var parseMarkdown = require('./parse_markdown');
var chalk = require('chalk');
var path = require('path');
var fs = require('fs');
/**
* Sort two documentation objects, given an optional order object. Returns
* a numeric sorting value that is compatible with stream-sort.
*
* @param {Array<Object>} comments all comments
* @param {Object} options options from documentation.yml
* @return {number} sorting value
* @private
*/
module.exports = function sortDocs(comments: Array<Comment>, options: Object) {
if (!options || !options.toc) {
return sortComments(comments, options && options.sortOrder);
}
var indexes = options.toc.reduce(function(memo, val, i) {
if (typeof val === 'object' && val.name) {
val.kind = 'note';
memo[val.name] = i;
} else {
memo[val] = i;
}
return memo;
}, Object.create(null));
var toBeSorted = options.toc.reduce(function(memo, val) {
if (typeof val === 'string') {
memo[val] = false;
}
return memo;
}, Object.create(null));
// Table of contents 'theme' entries: defined as objects
// in the YAML list
var fixed = options.toc
.filter(val => typeof val === 'object' && val.name)
.map(function(val) {
if (typeof val.file === 'string') {
var filename = val.file;
if (!path.isAbsolute(val.file)) {
filename = path.join(process.cwd(), val.file);
}
try {
val.description = fs.readFileSync(filename).toString();
delete val.file;
} catch (err) {
process.stderr.write(chalk.red(`Failed to read file ${filename}`));
}
}
if (typeof val.description === 'string') {
val.description = parseMarkdown(val.description);
}
return val;
});
var unfixed = [];
comments.forEach(function(comment) {
// If comment is of kind 'note', this means that we must be _re_ sorting
// the list, and the TOC note entries were already added to the list. Bail
// out here so that we don't add duplicates.
if (comment.kind === 'note') {
return;
}
// If comment is top-level and `name` matches a TOC entry, add it to the
// to-be-sorted list.
if (!comment.memberof && indexes[comment.name] !== undefined) {
fixed.push(comment);
toBeSorted[comment.name] = true;
} else {
unfixed.push(comment);
}
});
fixed.sort((a, b) => {
if (indexes[a.name] !== undefined && indexes[b.name] !== undefined) {
return indexes[a.name] - indexes[b.name];
}
});
sortComments(unfixed, options.sortOrder);
Object.keys(toBeSorted)
.filter(key => toBeSorted[key] === false)
.forEach(key => {
process.stderr.write(
chalk.red(
'Table of contents defined sorting of ' +
key +
' but no documentation with that namepath was found\n'
)
);
});
return fixed.concat(unfixed);
};
function compareCommentsByName(a: Comment, b: Comment): number {
const akey: ?string = a.name;
const bkey: ?string = b.name;
if (akey && bkey) {
return akey.localeCompare(bkey, undefined, { caseFirst: 'upper' });
}
return 0;
}
function compareCommentsBySourceLocation(a: Comment, b: Comment): number {
return a.context.sortKey.localeCompare(b.context.sortKey);
}
function sortComments(comments: Array<Comment>, sortOrder: string) {
return comments.sort(
sortOrder === 'alpha'
? compareCommentsByName
: compareCommentsBySourceLocation
);
}