How to configure graphdoc

Old GraphQL

For old GraphQL nothing special have to be done, but the following configuration can be also applied.

New GraphQL

To avoid getting the following error:

 ✗ Syntax Error GraphQL (1:1) Unexpected String

1: """
   ^
2: ...

It is necessary to override graphql version dependency for graphdoc package.

yarn

• Use yarn resolutions:

  "resolutions": {
    "@2fd/graphdoc/**/graphql": "15.5.0"
  }

then package.json will result in something like:

  "devDependencies": {
    "@2fd/graphdoc": "2.4.0",
    "graphdoc-plugin-erase" :"1.0.1",
    "graphdoc-plugin-flexible": "1.0.2",
    "graphdoc-plugin-operations": "2.0.0",
    "graphdoc-plugin-schema": "2.0.0",
    "yarn": "^1.22.10"
  },
  "resolutions": {
    "@2fd/graphdoc/**/graphql": "15.5.0"
  },

Online Examples

• Pokemon GraphQL schema: Project and Online generated documentation.

npm

npm has not an easy solution yet defined at the core, so use npm-force-resolutions:

• npm-force-resolutions provides a similar resolutions config field:

  "resolutions": {
    "graphql": "15.5.0"
  }

then package.json will result in something like:

  "devDependencies": {
    "@2fd/graphdoc": "2.4.0",
    "graphdoc-plugin-erase" :"1.0.1",
    "graphdoc-plugin-flexible": "1.0.2",
    "graphdoc-plugin-operations": "2.0.0",
    "graphdoc-plugin-schema": "2.0.0",
    "yarn": "^1.22.10"
  },
  "resolutions": {
    "@2fd/graphdoc/**/graphql": "15.5.0"
  },,
  "scripts": {
    "preinstall": "npx npm-force-resolutions",
    "doc": "graphdoc -p graphdoc/../../graphdoc-plugin-erase -p graphdoc/../../graphdoc-plugin-operations -p graphdoc/../../graphdoc-plugin-schema -p graphdoc/../../graphdoc-plugin-flexible -s ./src/schema.graphql -t ./template -o ./docs -f -v"
  }

note the preinstall script.

Online Examples

• Github GraphQL schema: Project and Online generated documentation.

---

Main documentation

Back to homepage