@graphql-tools/utils
Version:
Common package containing utils and types for GraphQL tools
79 lines (78 loc) • 2.89 kB
JavaScript
import { Source as GraphQLSource, isTypeSystemDefinitionNode, Kind, parse, print, visit, } from 'graphql';
import { dedentBlockStringValue, getLeadingCommentBlock } from './comments.js';
export function parseGraphQLSDL(location, rawSDL, options = {}) {
let document;
try {
if (options.commentDescriptions && rawSDL.includes('#')) {
document = transformCommentsToDescriptions(rawSDL, options);
// If noLocation=true, we need to make sure to print and parse it again, to remove locations,
// since `transformCommentsToDescriptions` must have locations set in order to transform the comments
// into descriptions.
if (options.noLocation) {
document = parse(print(document), options);
}
}
else {
document = parse(new GraphQLSource(rawSDL, location), options);
}
}
catch (e) {
if (e.message.includes('EOF') && rawSDL.replace(/(\#[^*]*)/g, '').trim() === '') {
document = {
kind: Kind.DOCUMENT,
definitions: [],
};
}
else {
throw e;
}
}
return {
location,
document,
};
}
export function transformCommentsToDescriptions(sourceSdl, options = {}) {
const parsedDoc = parse(sourceSdl, {
...options,
noLocation: false,
});
const modifiedDoc = visit(parsedDoc, {
leave: (node) => {
if (isDescribable(node)) {
const rawValue = getLeadingCommentBlock(node);
if (rawValue !== undefined) {
const commentsBlock = dedentBlockStringValue('\n' + rawValue);
const isBlock = commentsBlock.includes('\n');
if (!node.description) {
return {
...node,
description: {
kind: Kind.STRING,
value: commentsBlock,
block: isBlock,
},
};
}
else {
return {
...node,
description: {
...node.description,
value: node.description.value + '\n' + commentsBlock,
block: true,
},
};
}
}
}
},
});
return modifiedDoc;
}
export function isDescribable(node) {
return (isTypeSystemDefinitionNode(node) ||
node.kind === Kind.FIELD_DEFINITION ||
node.kind === Kind.INPUT_VALUE_DEFINITION ||
node.kind === Kind.ENUM_VALUE_DEFINITION);
}