fix: add apex rule msg referring to graphql and link rule doc #86
Conversation
ben-zhang-at-salesforce
commented
Nov 15, 2024
ben-zhang-at-salesforce
commented
- polish apex rule to refer graphq.
- add doc link to md file.
ben-zhang-at-salesforce
requested review from
khawkins,
sfdctaka,
maliroteh-sf and
haifeng-li-at-salesforce
as code owners
| @@ -23,12 +24,13 @@ export const rule = ESLintUtils.RuleCreator.withoutDocs({ | |||
| }, | |||
| meta: { | |||
| docs: { | |||
| url: getDocUrl(APEX_IMPORT_RULE_ID), | |||
| description: | |||
| '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. GraphQL API is a new paradigm of sending and receiving data. This API allows developers to interact with the Salesforce Platform through GraphQL, a standard query language for APIs and a runtime for fulfilling those queries with your data. Learn more about creating SOQL queries with GraphQL that may work better for mobile offline use cases. https://developer.salesforce.com/docs/platform/graphql/guide/graphql-wire-lwc.html' | |||
There was a problem hiding this comment.
Hi @khawkins, need your help on the message or description wording polish. thx
There was a problem hiding this comment.
It feels like in a world where we have backing "long-form" docs for each rule, saying less in the inline messaging is probably better, deferring the more detailed content to the long-form doc.
There was a problem hiding this comment.
So yeah, both meta > docs > description (here), and meta > messages > [APEX_IMPORT_RULE_ID] (below) are too long. These should effectively be one-liners. Consider ESLint's array-callback-return docs configuration as an example. Their description value shows up in their extended docs here:
Whereas clicking into the configured url link leads to a detailed doc page. We should be shooting for a similar approach, leaving the description value as something like:
Using Apex in LWC Offline-enabled mobile apps requires additional considerations to ensure proper functioning in offline scenarios.
And then using the backing doc to explain the rest of the details.
There was a problem hiding this comment.
thx @khawkins make sense to shorten the msg to short one line and link to a fat/meaty external doc.
@clivewong you are writing the meaty doc. Mind to give a one line for the written or to be written doc, thx
There was a problem hiding this comment.
thx @clivewong the msg Using Apex in LWC Offline-enabled mobile apps requires additional considerations. Consider using GraphQL for mobile offline use cases. is nice!
| @@ -23,6 +24,7 @@ export const rule: GraphQLESLintRule = { | |||
| hasSuggestions: false, | |||
| docs: { | |||
| category: 'Operations', | |||
| url: getDocUrl(NO_MORE_THAN_100_FIELDS_RULE_ID), | |||
There was a problem hiding this comment.
Hi @clivewong, need your help to create the md file for this rule. thx
