123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372 |
- // @flow strict
- 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 { type GraphQLSchema } from '../type/schema';
- import { isIntrospectionType } from '../type/introspection';
- import { GraphQLString, isSpecifiedScalarType } from '../type/scalars';
- import {
- GraphQLDirective,
- DEFAULT_DEPRECATION_REASON,
- isSpecifiedDirective,
- } from '../type/directives';
- import {
- type GraphQLNamedType,
- type GraphQLScalarType,
- type GraphQLEnumType,
- type GraphQLObjectType,
- type GraphQLInterfaceType,
- type GraphQLUnionType,
- type GraphQLInputObjectType,
- isScalarType,
- isObjectType,
- isInterfaceType,
- isUnionType,
- isEnumType,
- isInputObjectType,
- } from '../type/definition';
- import { astFromValue } from '../utilities/astFromValue';
- type Options = {|
-
- commentDescriptions?: boolean,
- |};
- export function printSchema(schema: GraphQLSchema, options?: Options): string {
- return printFilteredSchema(
- schema,
- n => !isSpecifiedDirective(n),
- isDefinedType,
- options,
- );
- }
- export function printIntrospectionSchema(
- schema: GraphQLSchema,
- options?: Options,
- ): string {
- return printFilteredSchema(
- schema,
- isSpecifiedDirective,
- isIntrospectionType,
- options,
- );
- }
- function isDefinedType(type: GraphQLNamedType): boolean {
- return !isSpecifiedScalarType(type) && !isIntrospectionType(type);
- }
- function printFilteredSchema(
- schema: GraphQLSchema,
- directiveFilter: (type: GraphQLDirective) => boolean,
- typeFilter: (type: GraphQLNamedType) => boolean,
- options,
- ): string {
- const directives = schema.getDirectives().filter(directiveFilter);
- const typeMap = schema.getTypeMap();
- const types = objectValues(typeMap)
- .sort((type1, type2) => type1.name.localeCompare(type2.name))
- .filter(typeFilter);
- return (
- [printSchemaDefinition(schema)]
- .concat(
- directives.map(directive => printDirective(directive, options)),
- types.map(type => printType(type, options)),
- )
- .filter(Boolean)
- .join('\n\n') + '\n'
- );
- }
- function printSchemaDefinition(schema: GraphQLSchema): ?string {
- if (isSchemaOfCommonNames(schema)) {
- return;
- }
- const operationTypes = [];
- const queryType = schema.getQueryType();
- if (queryType) {
- operationTypes.push(` query: ${queryType.name}`);
- }
- const mutationType = schema.getMutationType();
- if (mutationType) {
- operationTypes.push(` mutation: ${mutationType.name}`);
- }
- const subscriptionType = schema.getSubscriptionType();
- if (subscriptionType) {
- operationTypes.push(` subscription: ${subscriptionType.name}`);
- }
- return `schema {\n${operationTypes.join('\n')}\n}`;
- }
- function isSchemaOfCommonNames(schema: GraphQLSchema): boolean {
- const queryType = schema.getQueryType();
- if (queryType && queryType.name !== 'Query') {
- return false;
- }
- const mutationType = schema.getMutationType();
- if (mutationType && mutationType.name !== 'Mutation') {
- return false;
- }
- const subscriptionType = schema.getSubscriptionType();
- if (subscriptionType && subscriptionType.name !== 'Subscription') {
- return false;
- }
- return true;
- }
- export function printType(type: GraphQLNamedType, options?: Options): string {
- 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.
- invariant(false, 'Unexpected type: ' + inspect((type: empty)));
- }
- function printScalar(type: GraphQLScalarType, options): string {
- return printDescription(options, type) + `scalar ${type.name}`;
- }
- function printObject(type: GraphQLObjectType, options): string {
- const interfaces = type.getInterfaces();
- const implementedInterfaces = interfaces.length
- ? ' implements ' + interfaces.map(i => i.name).join(' & ')
- : '';
- return (
- printDescription(options, type) +
- `type ${type.name}${implementedInterfaces}` +
- printFields(options, type)
- );
- }
- function printInterface(type: GraphQLInterfaceType, options): string {
- return (
- printDescription(options, type) +
- `interface ${type.name}` +
- printFields(options, type)
- );
- }
- function printUnion(type: GraphQLUnionType, options): string {
- const types = type.getTypes();
- const possibleTypes = types.length ? ' = ' + types.join(' | ') : '';
- return printDescription(options, type) + 'union ' + type.name + possibleTypes;
- }
- function printEnum(type: GraphQLEnumType, options): string {
- const values = type
- .getValues()
- .map(
- (value, i) =>
- printDescription(options, value, ' ', !i) +
- ' ' +
- value.name +
- printDeprecated(value),
- );
- return (
- printDescription(options, type) + `enum ${type.name}` + printBlock(values)
- );
- }
- function printInputObject(type: GraphQLInputObjectType, options): string {
- const fields = objectValues(type.getFields()).map(
- (f, i) =>
- printDescription(options, f, ' ', !i) + ' ' + printInputValue(f),
- );
- return (
- printDescription(options, type) + `input ${type.name}` + printBlock(fields)
- );
- }
- function printFields(options, type) {
- const fields = objectValues(type.getFields()).map(
- (f, i) =>
- 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, indentation = '') {
- if (args.length === 0) {
- return '';
- }
- // If every arg does not have a description, print them on one line.
- if (args.every(arg => !arg.description)) {
- return '(' + args.map(printInputValue).join(', ') + ')';
- }
- return (
- '(\n' +
- args
- .map(
- (arg, i) =>
- printDescription(options, arg, ' ' + indentation, !i) +
- ' ' +
- indentation +
- printInputValue(arg),
- )
- .join('\n') +
- '\n' +
- indentation +
- ')'
- );
- }
- function printInputValue(arg) {
- const defaultAST = astFromValue(arg.defaultValue, arg.type);
- let argDecl = arg.name + ': ' + String(arg.type);
- if (defaultAST) {
- argDecl += ` = ${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 '';
- }
- const reason = fieldOrEnumVal.deprecationReason;
- const reasonAST = astFromValue(reason, GraphQLString);
- if (reasonAST && reason !== '' && reason !== DEFAULT_DEPRECATION_REASON) {
- return ' @deprecated(reason: ' + print(reasonAST) + ')';
- }
- return ' @deprecated';
- }
- function printDescription(
- options,
- def,
- indentation = '',
- firstInBlock = true,
- ): string {
- if (!def.description) {
- return '';
- }
- const lines = descriptionLines(def.description, 120 - indentation.length);
- if (options && options.commentDescriptions) {
- return printDescriptionWithComments(lines, indentation, firstInBlock);
- }
- const text = lines.join('\n');
- const preferMultipleLines = text.length > 70;
- const blockString = printBlockString(text, '', preferMultipleLines);
- const prefix =
- indentation && !firstInBlock ? '\n' + indentation : indentation;
- return prefix + blockString.replace(/\n/g, '\n' + indentation) + '\n';
- }
- function printDescriptionWithComments(lines, indentation, firstInBlock) {
- let description = indentation && !firstInBlock ? '\n' : '';
- for (const line of lines) {
- if (line === '') {
- description += indentation + '#\n';
- } else {
- description += indentation + '# ' + line + '\n';
- }
- }
- return description;
- }
- function descriptionLines(description: string, maxLen: number): Array<string> {
- const rawLines = description.split('\n');
- return flatMap(rawLines, 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: string, maxLen: number): Array<string> {
- const parts = line.split(new RegExp(`((?: |^).{15,${maxLen - 40}}(?= |$))`));
- if (parts.length < 4) {
- return [line];
- }
- const sublines = [parts[0] + parts[1] + parts[2]];
- for (let i = 3; i < parts.length; i += 2) {
- sublines.push(parts[i].slice(1) + parts[i + 1]);
- }
- return sublines;
- }
|