@graphql-eslint/eslint-plugin
Version:
GraphQL plugin for ESLint
80 lines (79 loc) • 3.42 kB
JavaScript
import { isScalarType, Kind } from "graphql";
import { REPORT_ON_FIRST_CHARACTER, requireGraphQLSchema } from "../../utils.js";
import { NON_OBJECT_TYPES } from "../relay-connection-types/index.js";
const RULE_ID = "relay-page-info", MESSAGE_MUST_EXIST = "MESSAGE_MUST_EXIST", MESSAGE_MUST_BE_OBJECT_TYPE = "MESSAGE_MUST_BE_OBJECT_TYPE", notPageInfoTypesSelector = `:matches(${NON_OBJECT_TYPES})[name.value=PageInfo] > .name`;
let hasPageInfoChecked = !1;
const rule = {
meta: {
type: "problem",
docs: {
category: "Schema",
description: [
"Set of rules to follow Relay specification for `PageInfo` object.",
"",
"- `PageInfo` must be an Object type",
"- `PageInfo` must contain fields `hasPreviousPage` and `hasNextPage`, that return non-null Boolean",
"- `PageInfo` must contain fields `startCursor` and `endCursor`, that return either String or Scalar, which can be null if there are no results"
].join(`
`),
url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
examples: [
{
title: "Correct",
code: (
/* GraphQL */
`
type PageInfo {
hasPreviousPage: Boolean!
hasNextPage: Boolean!
startCursor: String
endCursor: String
}
`
)
}
],
isDisabledForAllConfig: !0,
requiresSchema: !0
},
messages: {
[MESSAGE_MUST_EXIST]: "The server must provide a `PageInfo` object.",
[MESSAGE_MUST_BE_OBJECT_TYPE]: "`PageInfo` must be an Object type."
},
schema: []
},
create(context) {
const schema = requireGraphQLSchema(RULE_ID, context);
return (process.env.NODE_ENV === "test" || !hasPageInfoChecked) && (schema.getType("PageInfo") || context.report({
loc: REPORT_ON_FIRST_CHARACTER,
messageId: MESSAGE_MUST_EXIST
}), hasPageInfoChecked = !0), {
[notPageInfoTypesSelector](node) {
context.report({ node, messageId: MESSAGE_MUST_BE_OBJECT_TYPE });
},
"ObjectTypeDefinition[name.value=PageInfo]"(node) {
const fieldMap = Object.fromEntries(
node.fields?.map((field) => [field.name.value, field]) || []
), checkField = (fieldName, typeName) => {
const field = fieldMap[fieldName];
let isAllowedType = !1;
if (field) {
const type = field.gqlType;
typeName === "Boolean" ? isAllowedType = type.kind === Kind.NON_NULL_TYPE && type.gqlType.kind === Kind.NAMED_TYPE && type.gqlType.name.value === "Boolean" : type.kind === Kind.NAMED_TYPE && (isAllowedType = type.name.value === "String" || isScalarType(schema.getType(type.name.value)));
}
if (!isAllowedType) {
const returnType = typeName === "Boolean" ? "non-null Boolean" : "either String or Scalar, which can be null if there are no results";
context.report({
node: field ? field.name : node.name,
message: field ? `Field \`${fieldName}\` must return ${returnType}.` : `\`PageInfo\` must contain a field \`${fieldName}\`, that return ${returnType}.`
});
}
};
checkField("hasPreviousPage", "Boolean"), checkField("hasNextPage", "Boolean"), checkField("startCursor", "String"), checkField("endCursor", "String");
}
};
}
};
export {
rule
};