forked from vuetifyjs/vuetify
/
export.js
221 lines (192 loc) Β· 6.43 KB
/
export.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
const rimraf = require('rimraf')
const { resolve } = require('path')
const { writeJsonFile } = require('./helpers/write')
const { capitalize, kebabCase, pascalize } = require('./helpers/text')
const { getComponentsApi, getDirectivesApi } = require('./index')
const pkg = require('../package.json')
const createVeturApi = () => {
const components = getComponentsApi(['en'])
const tags = components.reduce((obj, component) => {
return {
...obj,
[component.name]: {
attributes: component.props.map(p => kebabCase(p.name)).sort(),
description: '',
},
}
}, {})
const attributes = components.reduce((obj, component) => {
const attrs = component.props.reduce((a, prop) => {
let type = prop.type || ''
if (!type) type = ''
else if (Array.isArray(type)) type = type.map(t => t.toLowerCase()).join('|')
else type = type.toLowerCase()
a[`${component.name}/${kebabCase(prop.name)}`] = {
type,
description: prop.description.en || '',
}
return a
}, {})
return { ...obj, ...attrs }
}, {})
writeJsonFile(tags, 'dist/tags.json')
writeJsonFile(attributes, 'dist/attributes.json')
}
// Create web-types.json to provide autocomplete in JetBrains IDEs
const createWebTypesApi = () => {
const components = getComponentsApi(['en'])
const directives = getDirectivesApi(['en'])
const getDocUrl = (cmp, heading = null) => `https://www.vuetifyjs.com/api/${cmp}${heading ? `#${heading}` : ''}`
const createTag = component => {
const createTagSlotPattern = slot => {
const patternIndex = slot.name.indexOf('<name>')
if (patternIndex < 0) { return {} }
let itemName
const slotPrefix = slot.name.substring(0, patternIndex)
if (slotPrefix === 'header.') {
// VDataTable header.<name>
itemName = 'header column'
} else if (slotPrefix === 'item.') {
// VDataTable item.<name>
itemName = 'column'
} else {
// Fallback
itemName = 'item'
}
const itemsPath = itemName.replace(' ', '-') + 's'
return {
pattern: {
items: itemsPath,
template: [
slotPrefix,
'#item:' + itemName,
],
},
[itemsPath]: {
name: itemName[0].toUpperCase() + itemName.substring(1),
pattern: {
regex: '.+',
},
'doc-hide-pattern': true,
},
}
}
const createTagSlot = slot => {
return {
name: slot.name,
...createTagSlotPattern(slot),
description: slot.description.en || '',
'doc-url': getDocUrl(component.name, 'slots'),
'vue-properties': slot.props && Object.keys(slot.props).map(key => createTypedEntity(key, slot.props[key])),
}
}
const createTagEvent = event => {
return {
name: event.name,
description: event.description.en || '',
'doc-url': getDocUrl(component.name, 'events'),
arguments: [createTypedEntity('argument', event.value)], // TODO: value should be replaced by arguments array
}
}
const createTagAttribute = prop => {
return {
name: prop.name,
description: prop.description.en || '',
'doc-url': getDocUrl(component.name, 'props'),
default: typeof prop.default !== 'string' ? JSON.stringify(prop.default) : prop.default,
required: undefined, // TODO: implement this
value: createTagValue(prop.type),
type: prop.type === 'boolean' ? 'boolean' : undefined, // this is deprecated but should be const 'boolean' for compatibility with 2019.2
}
}
const createTagValue = type => {
return {
kind: 'expression',
type,
}
}
const pascalName = pascalize(component.name)
return {
name: pascalName,
source: {
module: './src/components/index.ts',
symbol: pascalName,
},
aliases: undefined, // TODO: are we using this? deprecated name changes?
description: '', // TODO: we should probably include component description in locale files
'doc-url': getDocUrl(component.name),
attributes: component.props.map(createTagAttribute),
events: component.events.map(createTagEvent),
slots: component.slots.map(createTagSlot),
'vue-model': { // TODO: we should expose this in api data if we can
prop: 'value',
event: 'input',
},
}
}
const createTypedEntity = (name, type) => {
return {
name,
type: typeof type !== 'string' ? JSON.stringify(type) : type,
}
}
const createAttribute = directive => {
const createAttributeVueArgument = argument => {
return {
pattern: undefined,
description: argument.description && argument.description.en ? argument.description.en : '',
'doc-url': getDocUrl(directive.name, 'argument'),
required: undefined,
}
}
const createAttributeVueModifier = modifier => {
return {
name: modifier.name,
pattern: undefined,
description: modifier.description.en || '',
'doc-url': getDocUrl(directive.name, 'modifiers'),
}
}
const createAttributeValue = argument => {
return {
kind: 'expression',
type: argument.type,
}
}
return {
name: directive.name,
aliases: undefined,
description: '', // TODO: we should probably include directive description in locale files
'doc-url': getDocUrl(directive.name),
default: '',
required: false,
value: createAttributeValue(directive.argument),
source: {
module: './src/directives/index.ts',
symbol: capitalize(directive.name.slice(2)),
},
'vue-argument': directive.argument && createAttributeVueArgument(directive.argument), // TODO: how to use this in comparison to value?
'vue-modifiers': directive.modifiers && directive.modifiers.map(createAttributeVueModifier),
}
}
const tags = components.map(createTag)
const attributes = directives.map(createAttribute)
const webTypes = {
$schema: 'http://json.schemastore.org/web-types',
framework: 'vue',
name: 'vuetify',
version: pkg.version,
contributions: {
html: {
'types-syntax': 'typescript',
'description-markup': 'markdown',
tags,
attributes,
},
},
}
writeJsonFile(webTypes, 'dist/web-types.json')
}
rimraf.sync(resolve('./dist'))
createVeturApi()
createWebTypesApi()