forked from ionic-team/ionic-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cli.js
227 lines (178 loc) · 4.47 KB
/
cli.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
const fs = require('fs');
const utils = require('./utils');
const cliJSON = require('./data/cli.json');
const { cli: cliOverrides } = require('./data/meta-override.json');
const commandToKebab = (str) =>
str
.replace('ionic ', '')
.replace(/([a-z])([A-Z])/g, '$1-$2')
.replace(/[\s_]+/g, '-')
.toLowerCase();
(async function () {
// console.log(cliJSON);
cliJSON.commands.map(writePage);
})();
function writePage(page) {
const data = [
renderFrontmatter(page),
renderIntro(page),
renderInputs(page),
renderOptions(page),
renderAdvancedOptions(page),
renderExamples(page),
].join('');
const path = `cli/commands/${commandToKebab(page.name)}.md`;
fs.writeFileSync(`docs/${path}`, data);
fs.writeFileSync(`versioned_docs/version-v6/${path}`, data);
}
function renderFrontmatter({ name, groups }) {
const shortName = name.replace('ionic ', '');
const slug = commandToKebab(shortName);
const frontmatter = {
title: name,
sidebar_label: shortName,
};
const deprecated = groups.includes('deprecated')
? ':::warning\nThis command has been deprecated and will be removed in an upcoming major release of the Ionic CLI.\n:::'
: '';
return `---
${Object.entries(frontmatter)
.map(([key, value]) => `${key}: ${typeof value === 'string' ? `"${value.replace('"', '\\"')}"` : value}`)
.join('\n')}
---
${utils.getHeadTag(cliOverrides[slug])}
${deprecated}
`;
}
function renderIntro({ description, summary, name, options, inputs }) {
let args = '';
if (inputs && inputs.length > 0) {
for (let input of inputs) {
args += ` [${input.name}]`;
}
}
if (options && options.length > 0) {
args += ' [options]';
}
return `
${summary}
\`\`\`shell
$ ${name}${args}
\`\`\`
${description}`;
}
function renderExamples({ exampleCommands }) {
if (!exampleCommands || exampleCommands.length === 0) {
return '';
}
return `
## Examples
\`\`\`shell
${exampleCommands.map((command) => `$ ${command}`).join('\n')}
\`\`\`
`;
}
function renderInputs({ inputs }) {
if (inputs.length === 0) {
return '';
}
return utils.renderList('Inputs', inputs);
}
function renderOptions({ options }) {
options = options.filter((option) => !option.groups.includes('advanced'));
if (options.length === 0) {
return '';
}
return utils.renderOptions('Options', options);
}
function renderAdvancedOptions({ options }) {
options = options.filter((option) => option.groups.includes('advanced'));
if (options.length === 0) {
return '';
}
return utils.renderOptions('Advanced Options', options);
}
// function renderProperties({ props: properties }) {
// if (properties.length === 0) {
// return "";
// }
// return `
// ## Properties
// ${properties
// .map(
// prop => `
// ### ${prop.name}
// | | |
// | --- | --- |
// | **Description** | ${prop.docs.split("\n").join("<br />")} |
// | **Attribute** | \`${prop.attr}\` |
// | **Type** | \`${prop.type.replace(/\|/g, "\\|")}\` |
// | **Default** | \`${prop.default}\` |
// `
// )
// .join("\n")}
// `;
// }
// function renderEvents({ events }) {
// if (events.length === 0) {
// return "";
// }
// return `
// ## Events
// | Name | Description |
// | --- | --- |
// ${events.map(event => `| \`${event.event}\` | ${event.docs} |`).join("\n")}
// `;
// }
// function renderMethods({ methods }) {
// if (methods.length === 0) {
// return "";
// }
// return `
// ## Methods
// ${methods
// .map(
// method => `
// ### ${method.name}
// | | |
// | --- | --- |
// | **Description** | ${method.docs.split("\n").join("<br />")} |
// | **Signature** | \`${method.signature.replace(/\|/g, "\\|")}\` |
// `
// )
// .join("\n")}
// `;
// }
// function renderParts({ parts }) {
// if (parts.length === 0) {
// return "";
// }
// return `
// ## CSS Shadow Parts
// | Name | Description |
// | --- | --- |
// ${parts.map(prop => `| \`${prop.name}\` | ${prop.docs} |`).join("\n")}
// `;
// }
// function renderCustomProps({ styles: customProps }) {
// if (customProps.length === 0) {
// return "";
// }
// return `
// ## CSS Custom Properties
// | Name | Description |
// | --- | --- |
// ${customProps.map(prop => `| \`${prop.name}\` | ${prop.docs} |`).join("\n")}
// `;
// }
// function renderSlots({ slots }) {
// if (slots.length === 0) {
// return "";
// }
// return `
// ## Slots
// | Name | Description |
// | --- | --- |
// ${slots.map(slot => `| \`${slot.name}\` | ${slot.docs} |`).join("\n")}
// `;
// }