merge main

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing Guide For @salesforce/eslint-plugin-lwc-mobile
+
+This page lists the operational governance model of this project, as well as the recommendations and requirements for how to best contribute to @salesforce/eslint-plugin-lwc-mobile. We strive to obey these as best as possible. As always, thanks for contributing – we hope these guidelines make it easier and shed some light on our approach and processes.
+
+# Governance Model
+
+## Salesforce Sponsored
+
+The intent and goal of open sourcing this project is to increase the contributor and user base. However, only Salesforce employees will be given `admin` rights and will be the final arbitrars of what contributions are accepted or not.
+
+# Issues, requests & ideas
+
+Use GitHub Issues page to submit issues, enhancement requests and discuss ideas.
+
+### Bug Reports and Fixes
+-  If you find a bug, please search for it in the [Issues](https://github.com/salesforce/eslint-plugin-lwc-mobile/issues), and if it isn't already tracked,
+   [create a new issue](https://github.com/salesforce/eslint-plugin-lwc-mobile/issues/new). Fill out the "Bug Report" section of the issue template. Even if an Issue is closed, feel free to comment and add details, it will still
+   be reviewed.
+-  Issues that have already been identified as a bug (note: able to reproduce) will be labelled `bug`.
+-  If you'd like to submit a fix for a bug, [send a Pull Request](#creating_a_pull_request) and mention the Issue number.
+  -  Include tests that isolate the bug and verifies that it was fixed.
+
+### New Features
+-  If you'd like to add new functionality to this project, describe the problem you want to solve in a [new Issue](https://github.com/salesforce/eslint-plugin-lwc-mobile/issues/new).
+-  Issues that have been identified as a feature request will be labelled `enhancement`.
+-  If you'd like to implement the new feature, please wait for feedback from the project
+   maintainers before spending too much time writing the code. In some cases, `enhancement`s may
+   not align well with the project objectives at the time.
+
+### Tests, Documentation, Miscellaneous
+-  If you'd like to improve the tests, you want to make the documentation clearer, you have an
+   alternative implementation of something that may have advantages over the way its currently
+   done, or you have any other change, we would be happy to hear about it!
+  -  If its a trivial change, go ahead and [send a Pull Request](#creating_a_pull_request) with the changes you have in mind.
+  -  If not, [open an Issue](https://github.com/salesforce/eslint-plugin-lwc-mobile/issues/new) to discuss the idea first.
+
+If you're new to our project and looking for some way to make your first contribution, look for
+Issues labelled `good first contribution`.
+
+# Contribution Checklist
+
+- [x] Clean, simple, well styled code
+- [x] Commits should be atomic and messages must be descriptive. Related issues should be mentioned by Issue number.
+- [x] Comments
+  - Module-level & function-level comments.
+  - Comments on complex blocks of code or algorithms (include references to sources).
+- [x] Tests
+  - The test suite, if provided, must be complete and pass
+  - Increase code coverage, not versa.
+  - Use any of our testkits that contains a bunch of testing facilities you would need. For example: `import com.salesforce.op.test._` and borrow inspiration from existing tests.
+- [x] Dependencies
+  - Minimize number of dependencies.
+  - Prefer Apache 2.0, BSD3, MIT, ISC and MPL licenses.
+- [x] Reviews
+  - Changes must be approved via peer code review
+
+# Creating a Pull Request
+
+1. **Ensure the bug/feature was not already reported** by searching on GitHub under Issues.  If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress).
+3. **Clone** the forked repo to your machine.
+4. **Create** a new branch to contain your work (e.g. `git br fix-issue-11`)
+4. **Commit** changes to your own branch.
+5. **Push** your work back up to your fork. (e.g. `git push fix-issue-11`)
+6. **Submit** a Pull Request against the `main` branch and refer to the issue(s) you are fixing. Try not to pollute your pull request with unintended changes. Keep it simple and small.
+7. **Sign** the Salesforce CLA (you will be prompted to do so when submitting the Pull Request)
+
+> **NOTE**: Be sure to [sync your fork](https://help.github.com/articles/syncing-a-fork/) before making a pull request.
+
+
+# Code of Conduct
+Please follow our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+# License
+By contributing your code, you agree to license your contribution under the terms of our project [LICENSE](LICENSE.txt) and to sign the [Salesforce CLA](https://cla.salesforce.com/sign-cla)

eslint.config.mjs

@@ -8,14 +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',
-            '@typescript-eslint/no-explicit-any':'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,13 @@ 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'],
     coverageDirectory: 'reports/coverage',
     reporters: [
         'default',

package.json

@@ -58,13 +58,14 @@
         "/dist"
     ],
     "dependencies": {
-        "@graphql-eslint/eslint-plugin": "^3.20.1",
-        "@types/eslint": "^8.56.10",
-        "@types/estree": "^1.0.5"
+        "@graphql-eslint/eslint-plugin": "^3.20.1"
     },
     "devDependencies": {
         "@eslint/js": "^9.2.0",
         "@jest/globals": "^29.7.0",
+        "@types/jest": "^29.5.12",
+        "@types/eslint": "^8.56.10",
+        "@types/estree": "^1.0.5",
         "@typescript-eslint/eslint-plugin": "^7.8.0",
         "@typescript-eslint/parser": "^7.8.0",
         "@typescript-eslint/rule-tester": "^7.8.0",

src/configs/base.ts

@@ -8,22 +8,7 @@ import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';
 
 export = {
     plugins: ['@salesforce/lwc-mobile', '@graphql-eslint'],
-    overrides: [
-        {
-            files: ['*.js'],
-            processor: '@graphql-eslint/graphql'
-        },
-        {
-            files: ['*.graphql'],
-            parser: '@graphql-eslint/eslint-plugin',
-
-            parserOptions: {
-                skipGraphQLConfig: true
-            },
-            rules: {
-                '@graphql-eslint/no-duplicate-fields': 'error',
-                '@salesforce/lwc-mobile/no-aggregate-query-supported': 'warn'
-            }
-        }
-    ]
+    rules: {
+        '@salesforce/lwc-mobile/enforce-foo-bar': 'warn'
+    }
 } satisfies ClassicConfig.Config;

src/configs/recommended.ts

@@ -8,7 +8,22 @@ import type { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';
 
 export = {
     extends: ['./configs/base'],
-    rules: {
-        '@salesforce/lwc-mobile/enforce-foo-bar': 'error'
-    }
+    overrides: [
+        {
+            files: ['*.js'],
+            processor: '@graphql-eslint/graphql'
+        },
+        {
+            files: ['*.graphql'],
+            parser: '@graphql-eslint/eslint-plugin',
+
+            parserOptions: {
+                skipGraphQLConfig: true
+            },
+            rules: {
+                '@salesforce/lwc-mobile/offline-graphql-no-mutation-supported': 'warn',
+                '@salesforce/lwc-mobile/no-aggregate-query-supported': 'warn'
+            }
+        }
+    ]
 } satisfies ClassicConfig.Config;

src/index.ts

@@ -13,6 +13,11 @@ import {
     rule as noAggregateQuerySupported
 } from './rules/graphql/no-aggregate-query-supported.js';
 
+import {
+    NO_MUTATION_SUPPORTED_RULE_ID,
+    rule as mutionNotSupported
+} from './rules/graphql/no-mutation-supported.js';
+
 import { name, version } from '../package.json';
 
 export = {
@@ -26,6 +31,7 @@ export = {
     },
     rules: {
         'enforce-foo-bar': enforceFooBar,
+        [NO_MUTATION_SUPPORTED_RULE_ID]: mutionNotSupported,
         [NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID]: noAggregateQuerySupported
     }
 };

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

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * SPDX-License-Identifier: MIT
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
+ */
+import { GraphQLESLintRule, GraphQLESLintRuleContext } from '@graphql-eslint/eslint-plugin';
+
+import { getLocation } from '../../utils';
+export const NO_MUTATION_SUPPORTED_RULE_ID = 'offline-graphql-no-mutation-supported';
+
+export const rule: GraphQLESLintRule = {
+    meta: {
+        type: 'problem',
+        hasSuggestions: false,
+        docs: {
+            description: 'mutation is not supported offline',
+            category: 'Operations',
+            recommended: true,
+            examples: [
+                {
+                    title: 'Correct',
+                    code: /* GraphQL */ `
+                        query accountQuery {
+                            uiapi {
+                                query {
+                                    Account {
+                                        edges {
+                                            node {
+                                                Id
+                                                Name {
+                                                    value
+                                                }
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    `
+                },
+                {
+                    title: 'Incorrect',
+                    code: /* GraphQL */ `
+                        mutation AccountExample {
+                            uiapi {
+                                AccountCreate(input: { Account: { Name: "Trailblazer Express" } }) {
+                                    Record {
+                                        Id
+                                        Name {
+                                            value
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    `
+                }
+            ]
+        },
+        messages: {
+            [NO_MUTATION_SUPPORTED_RULE_ID]:
+                'Offline GraphQL: Mutation (data modification) is not supported offline.'
+        },
+        schema: []
+    },
+
+    create(context: GraphQLESLintRuleContext) {
+        return {
+            OperationDefinition(node) {
+                if (node.operation === 'mutation') {
+                    context.report({
+                        messageId: NO_MUTATION_SUPPORTED_RULE_ID,
+                        loc: getLocation(node.loc.start, node.operation)
+                    });
+                }
+            }
+        };
+    }
+};

src/utils.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
+        }
+    };
+}