-
-
Notifications
You must be signed in to change notification settings - Fork 484
/
getenJSON.js
153 lines (134 loc) · 3.54 KB
/
getenJSON.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
/*
This script generates the en.json file with the data from the data.json.
It's run by the Grunt task runner.
*/
function getenJSON() {
var fs = require('fs');
var data = fs.readFileSync('src/templates/pages/reference/data.json');
var dataJSON = JSON.parse(data);
var staticStrings = fs.readFileSync(
'src/templates/pages/reference/staticStrings.json'
);
var staticStringsJSON = JSON.parse(staticStrings);
var enJSON = {};
// static strings
for (var sstr in staticStringsJSON) {
enJSON[sstr] = staticStringsJSON[sstr].trim();
}
// modules
for (var p5Module in dataJSON.modules) {
if (p5Module !== 'p5.sound') {
enJSON[p5Module] = p5Module;
}
}
// classes: builds the p5 classes objects
for (var p5Class in dataJSON.classes) {
var entry = dataJSON['classes'][p5Class];
var classObj = buildClassObj(entry);
enJSON[entry.name] = classObj;
}
// classitems: adds methods and properties to their respective class object
for (var p5ItemIdx in dataJSON.classitems) {
var entry2 = dataJSON.classitems[p5ItemIdx];
// only consider the items that have a name
if (entry2.name) {
var itemObj = buildItemObj(entry2);
enJSON[entry2.class][entry2.name] = itemObj;
}
}
fs.writeFileSync(
'src/data/reference/en.json',
JSON.stringify(enJSON, null, 2),
err => {
if (err) {
console.error(err);
return;
}
}
);
}
function buildClassObj(p5Class) {
var classObj = {};
if (p5Class.description) {
classObj['description'] = getParagraphs(p5Class.description);
}
if (p5Class.return) {
classObj['returns'] = buildReturnObj(p5Class.return).trim();
}
if (p5Class.params) {
classObj['params'] = buildParamsObj(p5Class.params);
}
return classObj;
}
function buildItemObj(p5Item) {
var itemObj = {};
if (p5Item.description) {
itemObj['description'] = getParagraphs(p5Item.description);
}
if (p5Item.return) {
itemObj['returns'] = buildReturnObj(p5Item.return).trim();
}
if (p5Item.itemtype === 'method') {
if (p5Item.params) {
itemObj['params'] = buildParamsObj(p5Item.params);
}
if (p5Item.overloads) {
itemObj = getOverloads(p5Item, itemObj);
}
}
return itemObj;
}
function buildReturnObj(returns) {
return returns.type + ': ' + getText(returns.description);
}
function buildParamsObj(params) {
var paramsObj = {};
params.forEach(p => {
var descr = p.type;
if (p.description) {
descr += ': ';
}
if ('optional' in p && p['optional']) {
descr += ' (Optional) ';
}
descr += p.description;
paramsObj[p.name] = getText(descr);
});
return paramsObj;
}
function getOverloads(p5Item, itemObj) {
p5Item.overloads.forEach(o => {
if (o.params) {
var moreParams = buildParamsObj(o.params);
if (itemObj.params) {
for (var p in moreParams) {
if (!(p in itemObj.params)) {
itemObj['params'][p] = moreParams[p];
}
}
} else {
itemObj['params'] = moreParams;
}
}
});
return itemObj;
}
// returns the 'clean' version of the input text
function getText(str) {
return str
.trim()
.replace(/<p>|<\/p>|<br>/g, '')
.replace(/\n|\s+/g, ' ')
.trim();
}
// returns an array containing the 'clean' versions of the text in the <p> tags of the input text
function getParagraphs(text) {
return text
.trim()
.replace(/<\/p>|<br>/g, '')
.replace(/\n|\s+/g, ' ')
.split(/<p>/)
.filter(x => x.length > 0)
.map(x => x.trim());
}
module.exports = getenJSON;