123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288 |
- import flatMap from '../polyfills/flatMap';
- import objectValues from '../polyfills/objectValues';
- import inspect from '../jsutils/inspect';
- import invariant from '../jsutils/invariant';
- import { print } from '../language/printer';
- import { printBlockString } from '../language/blockString';
- import { isIntrospectionType } from '../type/introspection';
- import { GraphQLString, isSpecifiedScalarType } from '../type/scalars';
- import { GraphQLDirective, DEFAULT_DEPRECATION_REASON, isSpecifiedDirective } from '../type/directives';
- import { isScalarType, isObjectType, isInterfaceType, isUnionType, isEnumType, isInputObjectType } from '../type/definition';
- import { astFromValue } from '../utilities/astFromValue';
- /**
- * Accepts options as a second argument:
- *
- * - commentDescriptions:
- * Provide true to use preceding comments as the description.
- *
- */
- export function printSchema(schema, options) {
- return printFilteredSchema(schema, function (n) {
- return !isSpecifiedDirective(n);
- }, isDefinedType, options);
- }
- export function printIntrospectionSchema(schema, options) {
- return printFilteredSchema(schema, isSpecifiedDirective, isIntrospectionType, options);
- }
- function isDefinedType(type) {
- return !isSpecifiedScalarType(type) && !isIntrospectionType(type);
- }
- function printFilteredSchema(schema, directiveFilter, typeFilter, options) {
- var directives = schema.getDirectives().filter(directiveFilter);
- var typeMap = schema.getTypeMap();
- var types = objectValues(typeMap).sort(function (type1, type2) {
- return type1.name.localeCompare(type2.name);
- }).filter(typeFilter);
- return [printSchemaDefinition(schema)].concat(directives.map(function (directive) {
- return printDirective(directive, options);
- }), types.map(function (type) {
- return printType(type, options);
- })).filter(Boolean).join('\n\n') + '\n';
- }
- function printSchemaDefinition(schema) {
- if (isSchemaOfCommonNames(schema)) {
- return;
- }
- var operationTypes = [];
- var queryType = schema.getQueryType();
- if (queryType) {
- operationTypes.push(" query: ".concat(queryType.name));
- }
- var mutationType = schema.getMutationType();
- if (mutationType) {
- operationTypes.push(" mutation: ".concat(mutationType.name));
- }
- var subscriptionType = schema.getSubscriptionType();
- if (subscriptionType) {
- operationTypes.push(" subscription: ".concat(subscriptionType.name));
- }
- return "schema {\n".concat(operationTypes.join('\n'), "\n}");
- }
- /**
- * GraphQL schema define root types for each type of operation. These types are
- * the same as any other type and can be named in any manner, however there is
- * a common naming convention:
- *
- * schema {
- * query: Query
- * mutation: Mutation
- * }
- *
- * When using this naming convention, the schema description can be omitted.
- */
- function isSchemaOfCommonNames(schema) {
- var queryType = schema.getQueryType();
- if (queryType && queryType.name !== 'Query') {
- return false;
- }
- var mutationType = schema.getMutationType();
- if (mutationType && mutationType.name !== 'Mutation') {
- return false;
- }
- var subscriptionType = schema.getSubscriptionType();
- if (subscriptionType && subscriptionType.name !== 'Subscription') {
- return false;
- }
- return true;
- }
- export function printType(type, options) {
- if (isScalarType(type)) {
- return printScalar(type, options);
- } else if (isObjectType(type)) {
- return printObject(type, options);
- } else if (isInterfaceType(type)) {
- return printInterface(type, options);
- } else if (isUnionType(type)) {
- return printUnion(type, options);
- } else if (isEnumType(type)) {
- return printEnum(type, options);
- } else if (isInputObjectType(type)) {
- return printInputObject(type, options);
- } // Not reachable. All possible types have been considered.
- /* istanbul ignore next */
- invariant(false, 'Unexpected type: ' + inspect(type));
- }
- function printScalar(type, options) {
- return printDescription(options, type) + "scalar ".concat(type.name);
- }
- function printObject(type, options) {
- var interfaces = type.getInterfaces();
- var implementedInterfaces = interfaces.length ? ' implements ' + interfaces.map(function (i) {
- return i.name;
- }).join(' & ') : '';
- return printDescription(options, type) + "type ".concat(type.name).concat(implementedInterfaces) + printFields(options, type);
- }
- function printInterface(type, options) {
- return printDescription(options, type) + "interface ".concat(type.name) + printFields(options, type);
- }
- function printUnion(type, options) {
- var types = type.getTypes();
- var possibleTypes = types.length ? ' = ' + types.join(' | ') : '';
- return printDescription(options, type) + 'union ' + type.name + possibleTypes;
- }
- function printEnum(type, options) {
- var values = type.getValues().map(function (value, i) {
- return printDescription(options, value, ' ', !i) + ' ' + value.name + printDeprecated(value);
- });
- return printDescription(options, type) + "enum ".concat(type.name) + printBlock(values);
- }
- function printInputObject(type, options) {
- var fields = objectValues(type.getFields()).map(function (f, i) {
- return printDescription(options, f, ' ', !i) + ' ' + printInputValue(f);
- });
- return printDescription(options, type) + "input ".concat(type.name) + printBlock(fields);
- }
- function printFields(options, type) {
- var fields = objectValues(type.getFields()).map(function (f, i) {
- return printDescription(options, f, ' ', !i) + ' ' + f.name + printArgs(options, f.args, ' ') + ': ' + String(f.type) + printDeprecated(f);
- });
- return printBlock(fields);
- }
- function printBlock(items) {
- return items.length !== 0 ? ' {\n' + items.join('\n') + '\n}' : '';
- }
- function printArgs(options, args) {
- var indentation = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
- if (args.length === 0) {
- return '';
- } // If every arg does not have a description, print them on one line.
- if (args.every(function (arg) {
- return !arg.description;
- })) {
- return '(' + args.map(printInputValue).join(', ') + ')';
- }
- return '(\n' + args.map(function (arg, i) {
- return printDescription(options, arg, ' ' + indentation, !i) + ' ' + indentation + printInputValue(arg);
- }).join('\n') + '\n' + indentation + ')';
- }
- function printInputValue(arg) {
- var defaultAST = astFromValue(arg.defaultValue, arg.type);
- var argDecl = arg.name + ': ' + String(arg.type);
- if (defaultAST) {
- argDecl += " = ".concat(print(defaultAST));
- }
- return argDecl;
- }
- function printDirective(directive, options) {
- return printDescription(options, directive) + 'directive @' + directive.name + printArgs(options, directive.args) + (directive.isRepeatable ? ' repeatable' : '') + ' on ' + directive.locations.join(' | ');
- }
- function printDeprecated(fieldOrEnumVal) {
- if (!fieldOrEnumVal.isDeprecated) {
- return '';
- }
- var reason = fieldOrEnumVal.deprecationReason;
- var reasonAST = astFromValue(reason, GraphQLString);
- if (reasonAST && reason !== '' && reason !== DEFAULT_DEPRECATION_REASON) {
- return ' @deprecated(reason: ' + print(reasonAST) + ')';
- }
- return ' @deprecated';
- }
- function printDescription(options, def) {
- var indentation = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
- var firstInBlock = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : true;
- if (!def.description) {
- return '';
- }
- var lines = descriptionLines(def.description, 120 - indentation.length);
- if (options && options.commentDescriptions) {
- return printDescriptionWithComments(lines, indentation, firstInBlock);
- }
- var text = lines.join('\n');
- var preferMultipleLines = text.length > 70;
- var blockString = printBlockString(text, '', preferMultipleLines);
- var prefix = indentation && !firstInBlock ? '\n' + indentation : indentation;
- return prefix + blockString.replace(/\n/g, '\n' + indentation) + '\n';
- }
- function printDescriptionWithComments(lines, indentation, firstInBlock) {
- var description = indentation && !firstInBlock ? '\n' : '';
- for (var _i2 = 0; _i2 < lines.length; _i2++) {
- var line = lines[_i2];
- if (line === '') {
- description += indentation + '#\n';
- } else {
- description += indentation + '# ' + line + '\n';
- }
- }
- return description;
- }
- function descriptionLines(description, maxLen) {
- var rawLines = description.split('\n');
- return flatMap(rawLines, function (line) {
- if (line.length < maxLen + 5) {
- return line;
- } // For > 120 character long lines, cut at space boundaries into sublines
- // of ~80 chars.
- return breakLine(line, maxLen);
- });
- }
- function breakLine(line, maxLen) {
- var parts = line.split(new RegExp("((?: |^).{15,".concat(maxLen - 40, "}(?= |$))")));
- if (parts.length < 4) {
- return [line];
- }
- var sublines = [parts[0] + parts[1] + parts[2]];
- for (var i = 3; i < parts.length; i += 2) {
- sublines.push(parts[i].slice(1) + parts[i + 1]);
- }
- return sublines;
- }
|