feat: add more than 100 fields rules (#62)

* feat: warning is thrown if an entity has more than 100 fields

* fix: rule tester import error

* Update src/rules/graphql/no-more-than-100-fields.ts

Co-authored-by: Kevin Hawkins <[email protected]>

* Update src/rules/graphql/no-more-than-100-fields.ts

Co-authored-by: Kevin Hawkins <[email protected]>

* fix: check entity record size before warning is issued.

* fix: root query has the over 100 fields warning

* fix: remove wrong comment

---------

Co-authored-by: Kevin Hawkins <[email protected]>

Author: haifeng-li-at-salesforce

.github/workflows/lint.yml

@@ -9,8 +9,8 @@ jobs:
                 node: [18, 20]
         name: Linting on Ubuntu with Node ${{ matrix.node }}
         steps:
-            - uses: actions/checkout@v3
-            - uses: actions/setup-node@v3
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
               with:
                   node-version: ${{ matrix.node }}
                   cache: 'npm'

.github/workflows/prettier.yml

@@ -1,18 +1,18 @@
 name: prettier
 run-name: Installs project and runs prettier checks
-on: [ push, pull_request ]
+on: [push, pull_request]
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [ 18, 20 ]
-    name: Prettier on Ubuntu with Node ${{ matrix.node }}
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-      - run: npm install
-      - run: npm run format
+    lint:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node: [18, 20]
+        name: Prettier on Ubuntu with Node ${{ matrix.node }}
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node }}
+                  cache: 'npm'
+            - run: npm install
+            - run: npm run format

.github/workflows/run-tests.yml

@@ -1,32 +1,32 @@
 name: run-tests
 run-name: Installs project and runs tests
-on: [ push, pull_request ]
+on: [push, pull_request]
 jobs:
-  run-tests-nix:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [ 18, 20 ]
-    name: Run tests on Ubuntu with Node ${{ matrix.node }}
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-      - run: npm install
-      - run: npm run test
-  run-tests-win:
-    runs-on: windows-latest
-    strategy:
-      matrix:
-        node: [ 18, 20 ]
-    name: Run tests on Windows with Node ${{ matrix.node }}
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-          cache: 'npm'
-      - run: npm install
-      - run: npm run test
+    run-tests-nix:
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                node: [18, 20]
+        name: Run tests on Ubuntu with Node ${{ matrix.node }}
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node }}
+                  cache: 'npm'
+            - run: npm install
+            - run: npm run test
+    run-tests-win:
+        runs-on: windows-latest
+        strategy:
+            matrix:
+                node: [18, 20]
+        name: Run tests on Windows with Node ${{ matrix.node }}
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ matrix.node }}
+                  cache: 'npm'
+            - run: npm install
+            - run: npm run test

src/configs/recommended.ts

@@ -14,6 +14,7 @@ import { NO_SEMI_ANTI_JOIN_SUPPORTED_RULE_ID } from '../rules/graphql/no-semi-an
 import { NO_MORE_THAN_1_PARENT_RECORD_RULE_ID } from '../rules/graphql/no-more-than-1-parent-record.js';
 import { NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID } from '../rules/graphql/no-more-than-3-child-entities.js';
 import { NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID } from '../rules/graphql/no-more-than-3-root-entities.js';
+import { NO_MORE_THAN_100_FIELDS_RULE_ID } from '../rules/graphql/no-more-than-100-fields.js';
 import { createScopedModuleRuleName } from '../util/rule-helpers.js';
 
 export = {
@@ -41,6 +42,7 @@ export = {
                 [createScopedModuleRuleName(NO_MORE_THAN_1_PARENT_RECORD_RULE_ID)]: 'warn',
                 [createScopedModuleRuleName(NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID)]: 'warn',
                 [createScopedModuleRuleName(NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID)]: 'warn',
+                [createScopedModuleRuleName(NO_MORE_THAN_100_FIELDS_RULE_ID)]: 'warn',
                 [createScopedModuleRuleName(UNSUPPORTED_SCOPE_RULE_ID)]: 'warn'
             }
         }

src/index.ts

@@ -28,6 +28,10 @@ import {
     rule as fiscalDataFilteringNotSupported
 } from './rules/graphql/no-fiscal-date-filtering-supported.js';
 
+import {
+    NO_MORE_THAN_100_FIELDS_RULE_ID,
+    rule as noMoreThan100Fields
+} from './rules/graphql/no-more-than-100-fields.js';
 import {
     NO_SEMI_ANTI_JOIN_SUPPORTED_RULE_ID,
     rule as noSemiAntiJoinSupported
@@ -67,6 +71,7 @@ export = {
         [NO_MORE_THAN_1_PARENT_RECORD_RULE_ID]: noMoreThan1ParentRecord,
         [NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID]: noMoreThan3ChildEntities,
         [NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID]: noMoreThan3RootEntities,
+        [NO_MORE_THAN_100_FIELDS_RULE_ID]: noMoreThan100Fields,
         [NO_SEMI_ANTI_JOIN_SUPPORTED_RULE_ID]: noSemiAntiJoinSupported,
         [UNSUPPORTED_SCOPE_RULE_ID]: unsupportedScope
     }