@graphql-eslint/eslint-plugin
Version:
GraphQL plugin for ESLint
90 lines (88 loc) • 3.55 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.rule = void 0;
const graphql_1 = require("graphql");
const HASHTAG_COMMENT = 'HASHTAG_COMMENT';
exports.rule = {
meta: {
type: 'suggestion',
hasSuggestions: true,
schema: [],
messages: {
[HASHTAG_COMMENT]: 'Using hashtag `#` for adding GraphQL descriptions is not allowed. Prefer using `"""` for multiline, or `"` for a single line description.',
},
docs: {
description: 'Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.\nAllows to use hashtag for comments, as long as it\'s not attached to an AST definition.',
category: 'Schema',
url: 'https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/no-hashtag-description.md',
examples: [
{
title: 'Incorrect',
code: /* GraphQL */ `
# Represents a user
type User {
id: ID!
name: String
}
`,
},
{
title: 'Correct',
code: /* GraphQL */ `
" Represents a user "
type User {
id: ID!
name: String
}
`,
},
{
title: 'Correct',
code: /* GraphQL */ `
# This file defines the basic User type.
# This comment is valid because it's not attached specifically to an AST object.
" Represents a user "
type User {
id: ID! # This one is also valid, since it comes after the AST object
name: String
}
`,
},
],
recommended: true,
},
},
create(context) {
const selector = 'Document[definitions.0.kind!=/^(OperationDefinition|FragmentDefinition)$/]';
return {
[selector](node) {
const rawNode = node.rawNode();
let token = rawNode.loc.startToken;
while (token) {
const { kind, prev, next, value, line, column } = token;
if (kind === graphql_1.TokenKind.COMMENT && prev && next) {
const isEslintComment = value.trimStart().startsWith('eslint');
const linesAfter = next.line - line;
if (!isEslintComment &&
line !== prev.line &&
next.kind === graphql_1.TokenKind.NAME &&
linesAfter < 2) {
context.report({
messageId: HASHTAG_COMMENT,
loc: {
line,
column: column - 1,
},
suggest: ['"""', '"'].map(descriptionSyntax => ({
desc: `Replace with \`${descriptionSyntax}\` description syntax`,
fix: fixer => fixer.replaceTextRange([token.start, token.end], [descriptionSyntax, value.trim(), descriptionSyntax].join('')),
})),
});
}
}
token = next;
}
},
};
},
};