-
Notifications
You must be signed in to change notification settings - Fork 0
/
genReferenceDocs.js
230 lines (196 loc) · 6.82 KB
/
genReferenceDocs.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
const fs = require('fs');
const path = require('path');
const { Source, buildSchema } = require('graphql');
const schemaFilePath = './schema.graphql'
const destDirPath = './'
const depthLimit = 100
const typeDef = fs.readFileSync(schemaFilePath, 'utf8')
.replace(`schema {
query: RootQuery
mutation: Mutations
}`, '')
.replace('type Mutations', 'type Mutation')
.replace('type RootQuery', 'type Query')
const source = new Source(typeDef);
const gqlSchema = buildSchema(source);
path.resolve(destDirPath).split(path.sep).reduce((before, cur) => {
const pathTmp = path.join(before, cur + path.sep);
if (!fs.existsSync(pathTmp)) {
fs.mkdirSync(pathTmp);
}
return path.join(before, cur + path.sep);
}, '');
/**
* Compile arguments dictionary for a field
* @param field current field object
* @param duplicateArgCounts map for deduping argument name collisions
* @param allArgsDict dictionary of all arguments
*/
const getFieldArgsDict = (
field,
duplicateArgCounts,
allArgsDict = {},
) => field.args.reduce((o, arg) => {
if (arg.name in duplicateArgCounts) {
const index = duplicateArgCounts[arg.name] + 1;
duplicateArgCounts[arg.name] = index;
o[`${arg.name}${index}`] = arg;
} else if (allArgsDict[arg.name]) {
duplicateArgCounts[arg.name] = 1;
o[`${arg.name}1`] = arg;
} else {
o[arg.name] = arg;
}
return o;
}, {});
/**
* Generate variables string
* @param dict dictionary of arguments
*/
const getArgsToVarsStr = dict => Object.entries(dict)
.map(([varName, arg]) => `${arg.name}: $${varName}`)
.join(', ');
/**
* Generate types string
* @param dict dictionary of arguments
*/
const getVarsToTypesStr = dict => Object.entries(dict)
.map(([varName, arg]) => `$${varName}: ${arg.type}`)
.join(', ');
/**
* Generate the query for the specified field
* @param curName name of the current field
* @param curParentType parent type of the current field
* @param curParentName parent name of the current field
* @param argumentsDict dictionary of arguments from all fields
* @param duplicateArgCounts map for deduping argument name collisions
* @param crossReferenceKeyList list of the cross reference
* @param curDepth currentl depth of field
*/
const generateQuery = (
curName,
curParentType,
curParentName,
argumentsDict = {},
duplicateArgCounts = {},
crossReferenceKeyList = [], // [`${curParentName}To${curName}Key`]
curDepth = 1,
) => {
const field = gqlSchema.getType(curParentType).getFields()[curName];
const curTypeName = field.type.inspect().replace(/[[\]!]/g, '');
const curType = gqlSchema.getType(curTypeName);
let returns = []
let queryStr = '';
let childQuery = '';
if(curDepth === 1) {
if (curType.getFields){
returns = Object.values(curType.getFields())
}}
if (curType.getFields) {
const crossReferenceKey = `${curParentName}To${curName}Key`;
if (crossReferenceKeyList.indexOf(crossReferenceKey) !== -1 || curDepth > depthLimit) return '';
crossReferenceKeyList.push(crossReferenceKey);
const childKeys = Object.keys(curType.getFields());
childQuery = childKeys
.map(cur => generateQuery(cur, curType, curName, argumentsDict, duplicateArgCounts,
crossReferenceKeyList, curDepth + 1).queryStr)
.filter(cur => cur)
.join('\n');
}
if (!(curType.getFields && !childQuery)) {
queryStr = `${' '.repeat(curDepth)}${field.name}`;
if (field.args.length > 0) {
const dict = getFieldArgsDict(field, duplicateArgCounts, argumentsDict);
Object.assign(argumentsDict, dict);
queryStr += `(${getArgsToVarsStr(dict)})`;
}
if (childQuery) {
queryStr += `{\n${childQuery}\n${' '.repeat(curDepth)}}`;
}
}
/* Union types */
if (curType.astNode && curType.astNode.kind === 'UnionTypeDefinition') {
const types = curType.getTypes();
if (types && types.length) {
const indent = `${' '.repeat(curDepth)}`;
const fragIndent = `${' '.repeat(curDepth + 1)}`;
queryStr += '{\n';
for (let i = 0, len = types.length; i < len; i++) {
const valueTypeName = types[i];
const valueType = gqlSchema.getType(valueTypeName);
const unionChildQuery = Object.keys(valueType.getFields())
.map(cur => generateQuery(cur, valueType, curName, argumentsDict, duplicateArgCounts,
crossReferenceKeyList, curDepth + 2).queryStr)
.filter(cur => cur)
.join('\n');
queryStr += `${fragIndent}... on ${valueTypeName} {\n${unionChildQuery}\n${fragIndent}}\n`;
}
queryStr += `${indent}}`;
}
}
return { queryStr, argumentsDict, returns };
};
const getOutputFolderName = description => {
switch (description) {
case 'Mutation': return 'mutations';
case 'Query': return 'queries';
case 'Subscription': return 'subscriptions';
default:
console.log('[warning]:', 'description is required');
}
}
const generateDoc = (type, description, query, args, returns) => `# ${type}
## ${description}
\`\`\`
${query}
\`\`\`
${args.length ? `\n## Arguments
Name | Type
---- | ----
${args.map(({ name, type }) => `${name} | \`${type}\``).join('\n')}
` : ''}
## Returns
Name | Type
---- | ----
${returns.map(({ name, type }) => `${name} | \`${type}\``).join('\n')}
`
/**
* Generate the query for the specified field
* @param obj one of the root objects(Query, Mutation, Subscription)
* @param description description of the current object
*/
const generateFile = (obj, description) => {
const parentFolderName = getOutputFolderName(description)
const parentFolder = path.join(destDirPath, parentFolderName);
if (!fs.existsSync(parentFolder)) {
fs.mkdirSync(parentFolder)
}
Object.keys(obj).forEach((type) => {
const { argumentsDict, queryStr, returns } = generateQuery(type, description);
const varsToTypesStr = getVarsToTypesStr(argumentsDict);
const query = `${description.toLowerCase()} ${type}${varsToTypesStr ? `(${varsToTypesStr})` : ''}{\n${queryStr}\n}`;
const childFolder = path.join(parentFolder, type)
if (!fs.existsSync(childFolder)) {
fs.mkdirSync(childFolder)
}
const args = Object.values(argumentsDict)
const outputFile = path.join(childFolder, 'reference.md')
const output = generateDoc(type, description, query, args, returns)
fs.writeFileSync(outputFile, output);
});
}
if (gqlSchema.getMutationType()) {
generateFile(gqlSchema.getMutationType().getFields(), 'Mutation');
} else {
console.log('[warning]:', 'No mutation type found in your schema');
}
if (gqlSchema.getQueryType()) {
generateFile(gqlSchema.getQueryType().getFields(), 'Query');
} else {
console.log('[warning]:', 'No query type found in your schema');
}
if (gqlSchema.getSubscriptionType()) {
generateFile(gqlSchema.getSubscriptionType().getFields(), 'Subscription');
} else {
console.log('[warning]:', 'No subscription type found in your schema');
}