Updated docs

Author: victortotem

docs/configuration/config.md

@@ -56,6 +56,9 @@ API_URL=http://localhost:4000/graphql
 `.sgtsrc.js`
 
 ```javascript
+/**
+ * @type { import("simple-graphql-to-typescript").SgtsConfig }
+ */
 module.exports = {
  endpoint: process.env.API_URL,
  output: './generated.ts',

docs/options/codegen-functions.md

@@ -66,17 +66,20 @@ const commentFragment = gql`
  body
  }
 `
-// OR a simple string
+// Or a simple string
 
 const commentFragment = `
  id
  name
  body
 `
 
-const commentsQuery = sgts.comments().$fragment(commentFragment);
+const commentsQuery = sgts.comments(commentFragment);
+// Or
+const commentsQuery = sgts.comments(); // This will take the auto-generated fragment by default
 
-commentsQuery.$args({postId: 5}).$fetch().then(data => console.log(data))
+
+const result = await commentsQuery.$args({postId: 5}).$fetch();
 
 // You can cancel your request any time
 

docs/options/gen-fragments.md

@@ -3,7 +3,10 @@
 ### Type: `boolean`
 
 ::: warning
-**This option is still in alpha and still buggy, do not use in production**
+**This option is still in alpha can still be buggy, use with care**
 :::
 
-Enable fragment generation and queries/mutations auto-fragments so you don't have to pass any
+Enable fragment generation and queries/mutations auto-fragments so you don't have to pass any.
+
+For classic GraphQL types, this will generate the fragment up to 2 levels deep to avoid circulars types.
+For Connection fragments, it will go to 4 levels deep.

package.json

@@ -1,6 +1,6 @@
 {
  "name": "simple-graphql-to-typescript",
- "version": "0.10.10",
+ "version": "0.10.11",
  "description": "Simple Typescript interface generator from GraphQL Schemas",
  "main": "dist/index.js",
  "typings": "types/index.d.ts",
@@ -80,7 +80,6 @@
  "eslint": "^7.21.0",
  "eslint-config-prettier": "^8.1.0",
  "eslint-plugin-prettier": "^3.3.1",
- "inquirer": "^7.3.3",
  "jest": "^26.6.3",
  "lodash": "^4.17.21",
  "rimraf": "^3.0.2",
@@ -94,6 +93,7 @@
  "commander": "^6.2.0",
  "custom-env": "^2.0.1",
  "dotenv": "^8.2.0",
+ "inquirer": "^7.3.3",
  "figlet": "^1.5.0",
  "graphql": "^15.5.0",
  "mkdirp": "^1.0.4",