polishing up registering rule in to index.ts

src/index.ts

@@ -8,7 +8,10 @@
 import base from './configs/base.js';
 import recommended from './configs/recommended.js';
 import enforceFooBar from './rules/dummy/enforce-foo-bar.js';
-import { rule as noAggregateQuerySupported } from './rules/graphql/no-aggregate-query-supported.js';
+import { 
+    NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID, 
+    rule as noAggregateQuerySupported 
+} from './rules/graphql/no-aggregate-query-supported.js';
 
 import { name, version } from '../package.json';
 
@@ -23,6 +26,6 @@ export = {
     },
     rules: {
         'enforce-foo-bar': enforceFooBar,
-        'no-aggregate-query-supported': noAggregateQuerySupported
+        [NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID]: noAggregateQuerySupported
     }
 };

src/rules/graphql/no-aggregate-query-supported.ts

@@ -1,17 +1,44 @@
 import { FieldNode } from 'graphql';
 import { GraphQLESLintRule, GraphQLESLintRuleContext } from '@graphql-eslint/eslint-plugin';
 
+export const NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID = 'no-aggregate-query-supported';
+
 export const rule: GraphQLESLintRule = {
     meta: {
         type: 'suggestion',
         docs: {
             category: 'Operations',
             description:
-                'Inform that aggregate operation in graphql query is not supported for mobile offline.'
+                'Inform that aggregate operation in graphql query is not supported for mobile offline.',
             // url:
+            examples: [{
+                title: 'Incorrect',
+                code: /* GraphQL */ `
+                    query AvgOpportunityExample {
+                        uiapi {
+                            aggregate {
+                                Opportunity {
+                                    edges {
+                                        node {
+                                            aggregate {
+                                                Amount {
+                                                    avg {
+                                                        value
+                                                        displayValue
+                                                    }
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }                    
+                `
+            }]
         },
         messages: {
-            aggregateQueryNotSupported:
+            [NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID]:
                 'Aggregate operation in graphql query is not supported for mobile offline'
         },
         schema: []
@@ -20,7 +47,7 @@ export const rule: GraphQLESLintRule = {
     create(context: GraphQLESLintRuleContext) {
         return {
             Field(node) {
-                // report
+                // report lint issue if the graphql is like '... uiapi { aggregate { ...'
                 if (
                     node.name.value !== 'aggregate' ||
                     node.parent?.parent === undefined ||
@@ -34,10 +61,10 @@ export const rule: GraphQLESLintRule = {
                 if (upperField.name.value === 'uiapi') {
                     context.report({
                         node: node.name,
-                        messageId: 'aggregateQueryNotSupported'
+                        messageId: NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID
                     });
                 }
             }
         };
     }
-};
+};