UNPKG

22.8 kBJavaScriptView Raw
1"use strict";
2var __assign = (this && this.__assign) || function () {
3 __assign = Object.assign || function(t) {
4 for (var s, i = 1, n = arguments.length; i < n; i++) {
5 s = arguments[i];
6 for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7 t[p] = s[p];
8 }
9 return t;
10 };
11 return __assign.apply(this, arguments);
12};
13var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14 return new (P || (P = Promise))(function (resolve, reject) {
15 function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
16 function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
17 function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
18 step((generator = generator.apply(thisArg, _arguments || [])).next());
19 });
20};
21var __generator = (this && this.__generator) || function (thisArg, body) {
22 var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
23 return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
24 function verb(n) { return function (v) { return step([n, v]); }; }
25 function step(op) {
26 if (f) throw new TypeError("Generator is already executing.");
27 while (_) try {
28 if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
29 if (y = 0, t) op = [op[0] & 2, t.value];
30 switch (op[0]) {
31 case 0: case 1: t = op; break;
32 case 4: _.label++; return { value: op[1], done: false };
33 case 5: _.label++; y = op[1]; op = [0]; continue;
34 case 7: op = _.ops.pop(); _.trys.pop(); continue;
35 default:
36 if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
37 if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
38 if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
39 if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
40 if (t[2]) _.ops.pop();
41 _.trys.pop(); continue;
42 }
43 op = body.call(thisArg, _);
44 } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
45 if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
46 }
47};
48var _this = this;
49Object.defineProperty(exports, "__esModule", { value: true });
50var validate_documents_1 = require("./loaders/documents/validate-documents");
51var commander = require("commander");
52var path = require("path");
53var fs = require("fs");
54var mkdirp = require("mkdirp");
55var graphql_1 = require("graphql");
56var graphql_config_1 = require("graphql-config");
57var templates_scanner_1 = require("./loaders/template/templates-scanner");
58var graphql_codegen_compiler_1 = require("graphql-codegen-compiler");
59var graphql_codegen_core_1 = require("graphql-codegen-core");
60var epoxy_1 = require("@graphql-modules/epoxy");
61var graphql_tools_1 = require("graphql-tools");
62var load_1 = require("./load");
63var spinner_1 = require("./spinner");
64process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
65function collect(val, memo) {
66 memo.push(val);
67 return memo;
68}
69exports.initCLI = function (args) {
70 commander
71 .usage('gql-gen [options]')
72 .option('-s, --schema <path>', 'Path to GraphQL schema: local JSON file, GraphQL endpoint, local file that exports GraphQLSchema/AST/JSON')
73 .option('-cs, --clientSchema <path>', 'Path to GraphQL client schema: local JSON file, local file that exports GraphQLSchema/AST/JSON')
74 .option('-h, --header [header]', 'Header to add to the introspection HTTP request when using --url/--schema with url', collect, [])
75 .option('-t, --template <template-name>', 'Language/platform name templates, or a name of NPM modules that `export default` GqlGenConfig object')
76 .option('-p, --project <project-path>', 'Project path(s) to scan for custom template files')
77 .option('--config <json-file>', 'Codegen configuration file, defaults to: ./gql-gen.json')
78 .option('-m, --skip-schema', 'Generates only client side documents, without server side schema types')
79 .option('-c, --skip-documents', 'Generates only server side schema types, without client side documents')
80 .option('-o, --out <path>', 'Output file(s) path', String, './')
81 .option('-r, --require [require]', 'module to preload (option can be repeated)', collect, [])
82 .option('-ow, --no-overwrite', 'Skip file writing if the output file(s) already exists in path')
83 .option('-w, --watch', 'Watch for changes and execute generation automatically')
84 .option('--silent', 'Does not print anything to the console')
85 .option('-ms, --merge-schema <merge-logic>', 'Merge schemas with custom logic')
86 .arguments('<options> [documents...]')
87 .parse(args);
88 return commander;
89};
90exports.cliError = function (err, exitOnError) {
91 if (exitOnError === void 0) { exitOnError = true; }
92 spinner_1.default.fail();
93 var msg;
94 if (err instanceof Error) {
95 msg = err.message || err.toString();
96 }
97 else if (typeof err === 'string') {
98 msg = err;
99 }
100 else {
101 msg = JSON.stringify(err);
102 }
103 graphql_codegen_core_1.getLogger().error(msg);
104 if (exitOnError) {
105 process.exit(1);
106 }
107 return;
108};
109exports.validateCliOptions = function (options) {
110 if (options.silent) {
111 graphql_codegen_core_1.setSilentLogger();
112 }
113 else {
114 graphql_codegen_core_1.useWinstonLogger();
115 }
116 var schema = options.schema;
117 var template = options.template;
118 var project = options.project;
119 if (!schema) {
120 try {
121 var graphqlProjectConfig = graphql_config_1.getGraphQLProjectConfig(project);
122 options.schema = graphqlProjectConfig.schemaPath;
123 }
124 catch (e) {
125 if (e instanceof graphql_config_1.ConfigNotFoundError) {
126 exports.cliError('Flag --schema is missing!');
127 }
128 }
129 }
130 if (!template && !project) {
131 exports.cliError('Please specify language/platform, using --template flag, or specify --project to generate with custom project!');
132 }
133};
134exports.executeWithOptions = function (options) { return __awaiter(_this, void 0, void 0, function () {
135 var schema, clientSchema, documents, template, project, gqlGenConfigFilePath, out, generateSchema, generateDocuments, modulesToRequire, templateConfig, localFilePath, localFileExists, templateFromExport, configPath, config, templates, resolvedHelpers_1, relevantEnvVars, addToSchema, asArray, executeGeneration, normalizeOutput;
136 var _this = this;
137 return __generator(this, function (_a) {
138 switch (_a.label) {
139 case 0:
140 spinner_1.default.start('Validating options');
141 exports.validateCliOptions(options);
142 schema = options.schema;
143 clientSchema = options.clientSchema;
144 documents = options.args || [];
145 template = options.template;
146 project = options.project;
147 gqlGenConfigFilePath = options.config || './gql-gen.json';
148 out = options.out || './';
149 generateSchema = !options.skipSchema;
150 generateDocuments = !options.skipDocuments;
151 modulesToRequire = options.require || [];
152 modulesToRequire.forEach(function (mod) { return require(mod); });
153 templateConfig = null;
154 if (template && template !== '') {
155 spinner_1.default.log("Loading template: " + template);
156 graphql_codegen_core_1.debugLog("[executeWithOptions] using template: " + template);
157 // Backward compatibility for older versions
158 if (template === 'ts' ||
159 template === 'ts-single' ||
160 template === 'typescript' ||
161 template === 'typescript-single') {
162 spinner_1.default.warn("You are using the old template name, please install it from NPM and use it by it's new name: \"graphql-codegen-typescript-template\"");
163 template = 'graphql-codegen-typescript-template';
164 }
165 else if (template === 'ts-multiple' || template === 'typescript-multiple') {
166 spinner_1.default.warn("You are using the old template name, please install it from NPM and use it by it's new name: \"graphql-codegen-typescript-template-multiple\"");
167 template = 'graphql-codegen-typescript-template-multiple';
168 }
169 localFilePath = path.resolve(process.cwd(), template);
170 localFileExists = fs.existsSync(localFilePath);
171 try {
172 templateFromExport = require(localFileExists ? localFilePath : template);
173 if (!templateFromExport) {
174 throw new Error();
175 }
176 templateConfig = templateFromExport.default || templateFromExport.config || templateFromExport;
177 spinner_1.default.succeed();
178 }
179 catch (e) {
180 throw new Error("Unknown codegen template: \"" + template + "\", please make sure it's installed using npm/Yarn!");
181 }
182 }
183 graphql_codegen_core_1.debugLog("[executeWithOptions] using project: " + project);
184 configPath = path.resolve(process.cwd(), gqlGenConfigFilePath);
185 config = null;
186 if (fs.existsSync(configPath)) {
187 graphql_codegen_core_1.getLogger().info("Loading config file from: " + configPath);
188 config = JSON.parse(fs.readFileSync(configPath).toString());
189 graphql_codegen_core_1.debugLog("[executeWithOptions] Got project config JSON: " + JSON.stringify(config));
190 }
191 if (project && project !== '') {
192 spinner_1.default.log("Using project: " + project);
193 if (config === null) {
194 throw new Error("To use project feature, please specify --config path or create gql-gen.json in your project root!");
195 }
196 templates = templates_scanner_1.scanForTemplatesInPath(project, graphql_codegen_compiler_1.ALLOWED_CUSTOM_TEMPLATE_EXT);
197 resolvedHelpers_1 = {};
198 Object.keys(config.customHelpers || {}).map(function (helperName) {
199 var filePath = config.customHelpers[helperName];
200 var resolvedPath = path.isAbsolute(filePath) ? filePath : path.resolve(process.cwd(), filePath);
201 if (fs.existsSync(resolvedPath)) {
202 var requiredFile = require(resolvedPath);
203 if (requiredFile && typeof requiredFile === 'function') {
204 resolvedHelpers_1[helperName] = requiredFile;
205 }
206 else {
207 throw new Error("Custom template file " + resolvedPath + " does not have a default export function!");
208 }
209 }
210 else {
211 throw new Error("Custom template file " + helperName + " does not exists in path: " + resolvedPath);
212 }
213 });
214 templateConfig = {
215 inputType: graphql_codegen_core_1.EInputType.PROJECT,
216 templates: templates,
217 flattenTypes: config.flattenTypes,
218 primitives: config.primitives,
219 customHelpers: resolvedHelpers_1
220 };
221 }
222 spinner_1.default.succeed();
223 relevantEnvVars = Object.keys(process.env)
224 .filter(function (name) { return name.startsWith('CODEGEN_'); })
225 .reduce(function (prev, name) {
226 var cleanName = name
227 .replace('CODEGEN_', '')
228 .toLowerCase()
229 .replace(/[-_]+/g, ' ')
230 .replace(/[^\w\s]/g, '')
231 .replace(/ (.)/g, function (res) { return res.toUpperCase(); })
232 .replace(/ /g, '');
233 var value = process.env[name];
234 if (value === 'true') {
235 value = true;
236 }
237 else if (value === 'false') {
238 value = false;
239 }
240 prev[cleanName] = value;
241 return prev;
242 }, {});
243 addToSchema = [];
244 if (graphql_codegen_core_1.isGeneratorConfig(templateConfig)) {
245 templateConfig.config = __assign({}, (config && config.generatorConfig ? config.generatorConfig || {} : {}), (options && options['templateConfig'] ? options['templateConfig'] : {}), (relevantEnvVars || {}));
246 if (templateConfig.deprecationNote) {
247 spinner_1.default.warn("Template " + template + " is deprecated: " + templateConfig.deprecationNote);
248 }
249 if (templateConfig.addToSchema) {
250 asArray = Array.isArray(templateConfig.addToSchema)
251 ? templateConfig.addToSchema
252 : [templateConfig.addToSchema];
253 addToSchema = asArray.map(function (extension) { return (typeof extension === 'string' ? graphql_1.parse(extension) : extension); });
254 }
255 if (config) {
256 if ('flattenTypes' in config) {
257 templateConfig.flattenTypes = config.flattenTypes;
258 }
259 if ('primitives' in config) {
260 templateConfig.primitives = __assign({}, templateConfig.primitives, config.primitives);
261 }
262 }
263 }
264 executeGeneration = function () { return __awaiter(_this, void 0, void 0, function () {
265 var schemas, allSchemas, graphQlSchema, _i, addToSchema_1, extension, context, hasDocuments, documentsFiles, loadDocumentErrors, errorCount, _a, loadDocumentErrors_1, loadDocumentError, _b, _c, graphQLError, transformedDocuments;
266 return __generator(this, function (_d) {
267 switch (_d.label) {
268 case 0:
269 schemas = [];
270 try {
271 spinner_1.default.log('Loading remote schema');
272 graphql_codegen_core_1.debugLog("[executeWithOptions] Schema is being loaded ");
273 schemas.push(load_1.loadSchema(schema, options));
274 spinner_1.default.succeed();
275 }
276 catch (e) {
277 graphql_codegen_core_1.debugLog("[executeWithOptions] Failed to load schema", e);
278 exports.cliError('Invalid --schema provided, please use a path to local file, HTTP endpoint or a glob expression!');
279 }
280 if (clientSchema) {
281 spinner_1.default.log('Loading client schema');
282 try {
283 graphql_codegen_core_1.debugLog("[executeWithOptions] Client Schema is being loaded ");
284 schemas.push(load_1.loadSchema(clientSchema, options));
285 spinner_1.default.succeed();
286 }
287 catch (e) {
288 graphql_codegen_core_1.debugLog("[executeWithOptions] Failed to load client schema", e);
289 exports.cliError('Invalid --clientSchema provided, please use a path to local file or a glob expression!');
290 }
291 }
292 return [4 /*yield*/, Promise.all(schemas)];
293 case 1:
294 allSchemas = _d.sent();
295 graphQlSchema = allSchemas.length === 1
296 ? allSchemas[0]
297 : graphql_tools_1.makeExecutableSchema({ typeDefs: epoxy_1.mergeGraphQLSchemas(allSchemas), allowUndefinedInResolve: true });
298 if (addToSchema && addToSchema.length > 0) {
299 for (_i = 0, addToSchema_1 = addToSchema; _i < addToSchema_1.length; _i++) {
300 extension = addToSchema_1[_i];
301 graphql_codegen_core_1.debugLog("Extending GraphQL Schema with: ", extension);
302 graphQlSchema = graphql_1.extendSchema(graphQlSchema, extension);
303 }
304 }
305 if (process.env.VERBOSE !== undefined) {
306 graphql_codegen_core_1.getLogger().info("GraphQL Schema is: ", graphQlSchema);
307 }
308 context = graphql_codegen_core_1.schemaToTemplateContext(graphQlSchema);
309 graphql_codegen_core_1.debugLog("[executeWithOptions] Schema template context build, the result is: ");
310 Object.keys(context).forEach(function (key) {
311 if (Array.isArray(context[key])) {
312 graphql_codegen_core_1.debugLog("Total of " + key + ": " + context[key].length);
313 }
314 });
315 hasDocuments = documents.length;
316 if (hasDocuments) {
317 spinner_1.default.log('Loading documents');
318 }
319 return [4 /*yield*/, load_1.loadDocuments(documents)];
320 case 2:
321 documentsFiles = _d.sent();
322 loadDocumentErrors = validate_documents_1.validateGraphQlDocuments(graphQlSchema, documentsFiles);
323 if (loadDocumentErrors.length > 0) {
324 errorCount = 0;
325 for (_a = 0, loadDocumentErrors_1 = loadDocumentErrors; _a < loadDocumentErrors_1.length; _a++) {
326 loadDocumentError = loadDocumentErrors_1[_a];
327 for (_b = 0, _c = loadDocumentError.errors; _b < _c.length; _b++) {
328 graphQLError = _c[_b];
329 graphql_codegen_core_1.getLogger().error("[" + loadDocumentError.filePath + "] GraphQL Error: " + graphQLError.message);
330 errorCount++;
331 }
332 }
333 exports.cliError("Found " + errorCount + " errors when validating your GraphQL documents against schema!", !options.watch);
334 }
335 transformedDocuments = graphql_codegen_core_1.transformDocumentsFiles(graphQlSchema, documentsFiles);
336 if (hasDocuments) {
337 spinner_1.default.succeed();
338 }
339 spinner_1.default.log("Compiling template: " + template);
340 return [2 /*return*/, graphql_codegen_compiler_1.compileTemplate(templateConfig, context, [transformedDocuments], {
341 generateSchema: generateSchema,
342 generateDocuments: generateDocuments
343 })];
344 }
345 });
346 }); };
347 normalizeOutput = function (item) {
348 var resultName = item.filename;
349 if (!path.isAbsolute(resultName)) {
350 var resolved = path.resolve(process.cwd(), out);
351 if (fs.existsSync(resolved)) {
352 var stats = fs.lstatSync(resolved);
353 if (stats.isDirectory()) {
354 resultName = path.resolve(resolved, item.filename);
355 }
356 else if (stats.isFile()) {
357 resultName = resolved;
358 }
359 }
360 else {
361 if (out.endsWith('/')) {
362 resultName = path.resolve(resolved, item.filename);
363 }
364 else {
365 resultName = resolved;
366 }
367 }
368 }
369 var resultDir = path.dirname(resultName);
370 mkdirp.sync(resultDir);
371 return {
372 content: item.content,
373 filename: resultName
374 };
375 };
376 return [4 /*yield*/, executeGeneration()];
377 case 1: return [2 /*return*/, (_a.sent()).map(normalizeOutput)];
378 }
379 });
380}); };
381//# sourceMappingURL=codegen.js.map
\No newline at end of file