Add comment about debugging config + add comment specifying the language #28
Conversation
| @@ -29,9 +30,21 @@ In your `apollo.config.js` file: | |||
|
|
|||
| ```js | |||
| const { config } = require("vscode-apollo-relay").generateConfig() | |||
| // If you want to debug the config, uncomment the following line | |||
| // console.log(JSON.stringify(config)) | |||
| // You have to restart Visual Code after installing and check the output of Apollo GraphQL (next to the Terimal window) | |||
There was a problem hiding this comment.
I think this line would probably work better as its own paragraph outside of the code block and perhaps include a screenshot that shows the output pane, rather than trying to describe it with “next to the Terminal window”. What do you think?
| @@ -29,9 +30,21 @@ In your `apollo.config.js` file: | |||
|
|
|||
| ```js | |||
| const { config } = require("vscode-apollo-relay").generateConfig() | |||
| // If you want to debug the config, uncomment the following line | |||
| // console.log(JSON.stringify(config)) | |||
There was a problem hiding this comment.
I think JSON.stringify was introducing all those nulls in the validationRules` array. Perhaps something like this would be better? (Untested code.)
console.log(util.inspect(config, false, null, true))| .............. | ||
| language: 'typescript', | ||
| } | ||
| ``` |
There was a problem hiding this comment.
This section may not be necessary, as I would normally expect this to be implied and applies to all of the config entries. Perhaps the docs should be amended to instead state something like “be sure to specify all configuration required to run relay-compiler in your relay.config.js file”?
No description provided.