-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
no-unused-fields.ts
107 lines (95 loc) · 2.76 KB
/
no-unused-fields.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
import { GraphQLESLintRule } from '../types';
import { getLocation, requireUsedFieldsFromContext } from '../utils';
const UNUSED_FIELD = 'UNUSED_FIELD';
const RULE_NAME = 'no-unused-fields';
const rule: GraphQLESLintRule = {
meta: {
messages: {
[UNUSED_FIELD]: `Field "{{fieldName}}" is unused`,
},
docs: {
description: `Requires all fields to be used at some level by siblings operations.`,
category: 'Best Practices',
url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_NAME}.md`,
requiresSiblings: true,
requiresSchema: true,
examples: [
{
title: 'Incorrect',
code: /* GraphQL */ `
type User {
id: ID!
name: String
someUnusedField: String
}
type Query {
me: User
}
query {
me {
id
name
}
}
`,
},
{
title: 'Correct',
code: /* GraphQL */ `
type User {
id: ID!
name: String
}
type Query {
me: User
}
query {
me {
id
name
}
}
`,
},
],
},
fixable: 'code',
type: 'suggestion',
schema: [],
},
create(context) {
const usedFields = requireUsedFieldsFromContext(RULE_NAME, context);
return {
FieldDefinition(node) {
const fieldName = node.name.value;
const parentTypeName = (node as any).parent.name.value;
const isUsed = usedFields[parentTypeName]?.has(fieldName);
if (isUsed) {
return;
}
context.report({
loc: getLocation(node.loc, fieldName),
messageId: UNUSED_FIELD,
data: { fieldName },
fix(fixer) {
const sourceCode = context.getSourceCode();
const tokenBefore = (sourceCode as any).getTokenBefore(node);
const tokenAfter = (sourceCode as any).getTokenAfter(node);
const isEmptyType = tokenBefore.type === '{' && tokenAfter.type === '}';
if (isEmptyType) {
// Remove type
const { parent } = node as any;
const parentBeforeToken = sourceCode.getTokenBefore(parent);
return parentBeforeToken
? fixer.removeRange([parentBeforeToken.range[1], parent.range[1]])
: fixer.remove(parent);
}
// Remove whitespace before token
return fixer.removeRange([tokenBefore.range[1], node.range[1]]);
},
});
},
};
},
};
export default rule;