diff --git a/.gitignore b/.gitignore index f6c76e6..1088321 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ test-report.xml junit.xml tsconfig.tsbuildinfo +.DS_Store diff --git a/src/rules/apex/apex-import.ts b/src/rules/apex/apex-import.ts index 2c26ad6..ec1b88c 100644 --- a/src/rules/apex/apex-import.ts +++ b/src/rules/apex/apex-import.ts @@ -24,11 +24,11 @@ export const rule = ESLintUtils.RuleCreator.withoutDocs({ meta: { docs: { description: - 'Using Apex in LWC Offline-enabled mobile apps requires additional considerations to ensure proper functioning in offline scenarios. See https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/apex.htm for more details.' + 'Using Apex in LWC Offline-enabled mobile apps requires additional considerations to ensure proper functioning in offline scenarios. See Use Apex While Mobile and Offline (https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/apex.htm) for more details.' }, messages: { [APEX_IMPORT_RULE_ID]: - 'Using Apex in LWC Offline-enabled mobile apps requires careful consideration.' + 'Using Apex in LWC Offline-enabled mobile apps requires careful consideration in offline scenarios.' }, type: 'suggestion', schema: [] diff --git a/src/rules/graphql/no-aggregate-query-supported.ts b/src/rules/graphql/no-aggregate-query-supported.ts index ffb92f3..91e8f0d 100644 --- a/src/rules/graphql/no-aggregate-query-supported.ts +++ b/src/rules/graphql/no-aggregate-query-supported.ts @@ -17,7 +17,7 @@ export const rule: GraphQLESLintRule = { docs: { category: 'Operations', description: - 'Aggregate operations in a GraphQL query are not supported for Offline GraphQL.', + 'Aggregate operations in a GraphQL query are not supported for mobile offline. See Feature Limitations of Offline GraphQL (https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/use_graphql_limitations.htm) for more details.', examples: [ { title: 'Incorrect', @@ -48,7 +48,7 @@ export const rule: GraphQLESLintRule = { }, messages: { [NO_AGGREGATE_QUERY_SUPPORTED_RULE_ID]: - 'Offline GraphQL: Aggregate operations in a query are not supported for mobile offline' + 'Offline GraphQL: Aggregate operations in a query are not supported for mobile offline.' }, schema: [] }, diff --git a/src/rules/graphql/no-fiscal-date-filtering-supported.ts b/src/rules/graphql/no-fiscal-date-filtering-supported.ts index f3b51f1..857bcea 100644 --- a/src/rules/graphql/no-fiscal-date-filtering-supported.ts +++ b/src/rules/graphql/no-fiscal-date-filtering-supported.ts @@ -16,7 +16,8 @@ export const rule: GraphQLESLintRule = { meta: { type: 'problem', docs: { - description: 'Fiscal date literals and ranges are not supported in Offline GraphQL', + description: + 'Fiscal date literals and ranges are not supported in filters for mobile offline. See Feature Limitations of Offline GraphQL (https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/use_graphql_limitations.htm) for more details.', category: 'Operations', recommended: true, examples: [ @@ -94,7 +95,7 @@ export const rule: GraphQLESLintRule = { }, messages: { [NO_FISCAL_DATE_FILTER_SUPPORTED_RULE_ID]: - 'Offline GraphQL: Date {{filterType}} "{{filterName}}" is not supported offline.' + 'Offline GraphQL: Date {{filterType}} "{{filterName}}" is not supported for mobile offline.' }, schema: [] }, diff --git a/src/rules/graphql/no-more-than-1-parent-record.ts b/src/rules/graphql/no-more-than-1-parent-record.ts index f23c71b..099da0f 100644 --- a/src/rules/graphql/no-more-than-1-parent-record.ts +++ b/src/rules/graphql/no-more-than-1-parent-record.ts @@ -16,7 +16,7 @@ export const rule: GraphQLESLintRule = { hasSuggestions: false, docs: { category: 'Operations', - description: `Offline GraphQL: You should only query one parent entity, for queries fetching child entities. Set the parent's 'first' argument value to 1.`, + description: `Queries fetching child entities can only fetch 1 parent record. Set the parent's 'first' argument value to 1.`, examples: [ { title: 'Correct', @@ -90,7 +90,7 @@ export const rule: GraphQLESLintRule = { ] }, messages: { - [NO_MORE_THAN_1_PARENT_RECORD_RULE_ID]: `Offline GraphQL: Queries fetching child entities should only fetch 1 parent record. Currently it's "{{pageSize}}".` + [NO_MORE_THAN_1_PARENT_RECORD_RULE_ID]: `Offline GraphQL: Queries fetching child entities can only fetch 1 parent record. Currently it's "{{pageSize}}".` }, schema: [] }, diff --git a/src/rules/graphql/no-more-than-3-child-entities.ts b/src/rules/graphql/no-more-than-3-child-entities.ts index 35bd5c2..99a83f8 100644 --- a/src/rules/graphql/no-more-than-3-child-entities.ts +++ b/src/rules/graphql/no-more-than-3-child-entities.ts @@ -16,7 +16,7 @@ export const rule: GraphQLESLintRule = { hasSuggestions: false, docs: { category: 'Operations', - description: `Offline GraphQL: Do not fetch more than 3 child entities.`, + description: `Do not fetch more than 3 child entities.`, examples: [ { title: 'Correct', @@ -102,7 +102,7 @@ export const rule: GraphQLESLintRule = { ] }, messages: { - [NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID]: `Offline GraphQL: fetch no more than 3 child entities.` + [NO_MORE_THAN_3_CHILD_ENTITIES_RULE_ID]: `Offline GraphQL: Do not fetch more than 3 child entities.` }, schema: [] }, diff --git a/src/rules/graphql/no-more-than-3-root-entities.ts b/src/rules/graphql/no-more-than-3-root-entities.ts index 4f6337d..e7b321d 100644 --- a/src/rules/graphql/no-more-than-3-root-entities.ts +++ b/src/rules/graphql/no-more-than-3-root-entities.ts @@ -133,7 +133,7 @@ export const rule: GraphQLESLintRule = { ] }, messages: { - [NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID]: `Offline GraphQL: fetch no more than 3 root entities.` + [NO_MORE_THAN_3_ROOT_ENTITIES_RULE_ID]: `Offline GraphQL: Do not fetch more than 3 root entities.` }, schema: [] }, diff --git a/src/rules/graphql/no-mutation-supported.ts b/src/rules/graphql/no-mutation-supported.ts index 5e66a93..592b43f 100644 --- a/src/rules/graphql/no-mutation-supported.ts +++ b/src/rules/graphql/no-mutation-supported.ts @@ -17,7 +17,8 @@ export const rule: GraphQLESLintRule = { hasSuggestions: false, docs: { category: 'Operations', - description: 'Mutation (data modification) is not supported for mobile offline', + description: + 'Mutation (data modification) is not supported for mobile offline. See Feature Limitations of Offline GraphQL (https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/use_graphql_limitations.htm) for more details.', recommended: true, examples: [ { @@ -62,7 +63,7 @@ export const rule: GraphQLESLintRule = { }, messages: { [NO_MUTATION_SUPPORTED_RULE_ID]: - 'Offline GraphQL: Mutation (data modification) is not supported offline.' + 'Offline GraphQL: Mutation (data modification) is not supported for mobile offline.' }, schema: [] }, diff --git a/src/rules/graphql/no-semi-anti-join-supported.ts b/src/rules/graphql/no-semi-anti-join-supported.ts index b8f17b9..7884e84 100644 --- a/src/rules/graphql/no-semi-anti-join-supported.ts +++ b/src/rules/graphql/no-semi-anti-join-supported.ts @@ -14,7 +14,8 @@ export const rule: GraphQLESLintRule = { type: 'problem', hasSuggestions: false, docs: { - description: 'Semi-join and anti-join filters are not supported for mobile offline', + description: + 'Semi-join and anti-join filters are not supported for mobile offline. See Feature Limitations of Offline GraphQL (https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/use_graphql_limitations.htm) for more details.', category: 'Operations', recommended: true, examples: [ diff --git a/src/rules/graphql/unsupported-scope.ts b/src/rules/graphql/unsupported-scope.ts index 377a41e..e63ee4e 100644 --- a/src/rules/graphql/unsupported-scope.ts +++ b/src/rules/graphql/unsupported-scope.ts @@ -25,7 +25,7 @@ export const rule: GraphQLESLintRule = { type: 'problem', docs: { category: 'Operations', - description: `Offline GraphQL supports the scope "MINE" for all entities, and "ASSIGNEDTOME" for ServiceAppointment. All other scopes (for example TEAM, QUEUE_OWNED and USER_OWNED) are not supported.`, + description: `Offline GraphQL supports the scope "MINE" for all entities, and "ASSIGNEDTOME" for ServiceAppointment. All other scopes (for example TEAM, QUEUE_OWNED and USER_OWNED) are not supported for mobile offline. See Feature Limitations of Offline GraphQL (https://developer.salesforce.com/docs/atlas.en-us.mobile_offline.meta/mobile_offline/use_graphql_limitations.htm) for more details.`, recommended: true, examples: [ { @@ -68,7 +68,7 @@ export const rule: GraphQLESLintRule = { }, messages: { [SCOPE_SUPPORTED_FOR_CERTAIN_ENTITIES_ONLY]: - 'Offline GraphQL: Scope "{{scopeName}}" is only supported for the "{{supportedEntities}}" entity for mobile offline use cases', + 'Offline GraphQL: Scope "{{scopeName}}" is only supported for the "{{supportedEntities}}" entity for mobile offline use cases.', [OTHER_UNSUPPORTED_SCOPE]: 'Offline GraphQL: Scope "{{scopeName}}" is unsupported for mobile offline use cases.' },