functional mutation-not-supported-rule

Author: haifeng-li-at-salesforce

eslint.config.mjs

@@ -8,13 +8,10 @@
 import eslint from '@eslint/js';
 import tsEslint from 'typescript-eslint';
 
-export default tsEslint.config(
-    eslint.configs.recommended,
-    ...tsEslint.configs.recommended,
-    {
-        rules: {
-            strict: ['error', 'global'],
-            '@typescript-eslint/no-extra-non-null-assertion': 'off'
-        }
-    },
-);
+export default tsEslint.config(eslint.configs.recommended, ...tsEslint.configs.recommended, {
+    rules: {
+        strict: ['error', 'global'],
+        '@typescript-eslint/no-extra-non-null-assertion': 'off',
+        '@typescript-eslint/no-explicit-any': 'off'
+    }
+});

jest.config.ts

@@ -11,17 +11,18 @@ const config: Config = {
     displayName: 'Unit Tests',
     setupFilesAfterEnv: ['jest-extended', 'jest-chain'],
     preset: 'ts-jest',
-    testMatch: [
-        '<rootDir>/test/plugin.ts',
-        '<rootDir>/test/rules/**/*.ts',
-        '!**/test/rules/shared.ts'
-    ],
+    testMatch: ['<rootDir>/test/rules/**/*.ts'],
     moduleFileExtensions: ['ts', 'js', 'json'],
     testResultsProcessor: 'jest-sonar-reporter',
     testPathIgnorePatterns: ['/node_modules/', '<rootDir>/lib/'],
     moduleDirectories: ['node_modules'],
     collectCoverage: true,
-    collectCoverageFrom: ['src/**/*.ts'],
+    collectCoverageFrom: [
+        'src/**/*.ts',
+        '!src/index.ts',
+        '!src/configs/*.ts',
+        '!src/graphql/types.ts'
+    ],
     coverageDirectory: 'reports/coverage',
     reporters: [
         'default',

package-lock.json

@@ -65,6 +65,7 @@
     "devDependencies": {
         "@eslint/js": "^9.2.0",
         "@jest/globals": "^29.7.0",
+        "@types/jest": "^29.5.12",
         "@typescript-eslint/eslint-plugin": "^7.8.0",
         "@typescript-eslint/parser": "^7.8.0",
         "@typescript-eslint/rule-tester": "^7.8.0",

package.json

@@ -7,5 +7,22 @@
 import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';
 
 export = {
-    plugins: ['@salesforce/lwc-mobile']
+    plugins: ['@salesforce/lwc-mobile', '@graphql-eslint'],
+    overrides: [
+        {
+            files: ['*.js'],
+            processor: '@graphql-eslint/graphql'
+        },
+        {
+            files: ['*.graphql'],
+            parser: '@graphql-eslint/eslint-plugin',
+
+            parserOptions: {
+                skipGraphQLConfig: true
+            },
+            rules: {
+                '@salesforce/lwc-mobile/mutation-not-supported': 'warn'
+            }
+        }
+    ]
 } satisfies ClassicConfig.Config;

src/configs/base.ts

@@ -5,11 +5,10 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
  */
 
-import type { Linter } from '@typescript-eslint/utils/ts-eslint';
-
 import base from './configs/base.js';
 import recommended from './configs/recommended.js';
 import enforceFooBar from './rules/dummy/enforce-foo-bar.js';
+import { rule as mutionNotSupported } from './rules/graphql/mutation-not-supported.js';
 import { name, version } from '../package.json';
 export = {
     configs: {
@@ -21,6 +20,7 @@ export = {
         version
     },
     rules: {
-        'enforce-foo-bar': enforceFooBar
+        'enforce-foo-bar': enforceFooBar,
+        'mutation-not-supported': mutionNotSupported
     }
-} satisfies Linter.Plugin;
+};

src/index.ts

@@ -0,0 +1,52 @@
+import { GraphQLESLintRule, GraphQLESLintRuleContext } from '@graphql-eslint/eslint-plugin';
+
+import { getLocation } from '../utils';
+export const MESSAGE_ID = 'mutation-not-supported';
+
+export const rule: GraphQLESLintRule = {
+    meta: {
+        type: 'problem',
+        hasSuggestions: false,
+        docs: {
+            description: 'mutation is not supported offline',
+            category: 'Operations',
+            recommended: true,
+            examples: [
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+                        mutation AccountExample {
+                            uiapi {
+                                AccountCreate(input: { Account: { Name: "Trailblazer Express" } }) {
+                                    Record {
+                                        Id
+                                        Name {
+                                            value
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    `
+                }
+            ]
+        },
+        messages: {
+            [MESSAGE_ID]: 'Mutation is not supported offline'
+        },
+        schema: []
+    },
+
+    create(context: GraphQLESLintRuleContext) {
+        return {
+            OperationDefinition(node) {
+                if (node.operation === 'mutation') {
+                    context.report({
+                        messageId: MESSAGE_ID,
+                        loc: getLocation(node.loc.start, node.operation)
+                    });
+                }
+            }
+        };
+    }
+};

src/rules/graphql/mutation-not-supported.ts

@@ -0,0 +1,16 @@
+import { Position } from 'estree';
+import { AST } from 'eslint';
+
+export function getLocation(start: Position, fieldName = ''): AST.SourceLocation {
+    const { line, column } = start;
+    return {
+        start: {
+            line,
+            column
+        },
+        end: {
+            line,
+            column: column + fieldName.length
+        }
+    };
+}

src/rules/graphql/utils/types.ts src/rules/graphql/types.ts

@@ -0,0 +1,32 @@
+import { RuleTester } from '@typescript-eslint/rule-tester';
+import { rule, MESSAGE_ID } from '../../../src/rules/graphql/mutation-not-supported';
+
+const ruleTester = new RuleTester({
+    parser: '@graphql-eslint/eslint-plugin',
+    parserOptions: {
+        graphQLConfig: {}
+    }
+});
+
+ruleTester.run('@salesforce/lwc-mobile/mutation-not-supported', rule as any, {
+    valid: [],
+    invalid: [
+        {
+            code: /* GraphQL */ `
+                mutation AccountExample {
+                    uiapi {
+                        AccountCreate(input: { Account: { Name: "Trailblazer Express" } }) {
+                            Record {
+                                Id
+                                Name {
+                                    value
+                                }
+                            }
+                        }
+                    }
+                }
+            `,
+            errors: [{ messageId: MESSAGE_ID }]
+        }
+    ]
+});

src/rules/utils.ts

@@ -0,0 +1,20 @@
+import { describe } from 'node:test';
+import { getLocation } from '../../src/rules/utils';
+import { Position } from 'estree';
+
+import { expect } from '@jest/globals';
+
+describe('utils', () => {
+    it('getLocation() should return location with field name length added', () => {
+        const startLocation: Position = {
+            line: 1,
+            column: 1
+        };
+
+        const result = getLocation(startLocation, 'Field1');
+        expect(result.end).toMatchObject({
+            line: 1,
+            column: 7
+        });
+    });
+});

test/rules/graphql/mutation-not-supported.spec.ts

@@ -4,7 +4,9 @@
         "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
         "module": "Node16" /* Specify what module code is generated. */,
         "moduleResolution": "Node16" /* Specify how TypeScript looks up a file from a given module specifier. */,
-        "types": [] /* Specify type package names to be included without being referenced in a source file. */,
+        "types": [
+            "jest"
+        ] /* Specify type package names to be included without being referenced in a source file. */,
         "rootDir": "./src",
         "outDir": "dist" /* Specify an output folder for all emitted files. */,
         "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,