diff --git a/gatsby-node.js b/gatsby-node.js index eefb490c..c38c0f59 100755 --- a/gatsby-node.js +++ b/gatsby-node.js @@ -153,7 +153,7 @@ exports.createPages = ({ graphql, actions }) => { // Create pages from swagger json files // const apiSwaggerTemplate = path.resolve( - './src/templates/ApiSwagger.jsx' + './src/templates/Swagger/index.jsx' ) const petStoreSlug = '/references/petstore/' @@ -202,7 +202,7 @@ exports.createPages = ({ graphql, actions }) => { // const typeDocSpecs = ['./data/squid-js.json'] const typedocTemplate = path.resolve( - './src/templates/Typedoc.jsx' + './src/templates/Typedoc/index.jsx' ) typeDocSpecs.forEach(spec => { diff --git a/package.json b/package.json index 7db010e5..648b0a09 100644 --- a/package.json +++ b/package.json @@ -73,6 +73,7 @@ "eslint-plugin-prettier": "^3.0.0", "markdownlint-cli": "^0.13.0", "npm-run-all": "^4.1.5", + "ora": "^3.0.0", "prettier": "^1.15.3", "prettier-stylelint": "^0.4.2", "stylelint": "^9.9.0", diff --git a/scripts/typedoc.js b/scripts/typedoc.js index 42443663..1953ddd8 100644 --- a/scripts/typedoc.js +++ b/scripts/typedoc.js @@ -1,10 +1,11 @@ #!/usr/bin/env node -/* eslint-disable no-console, security/detect-child-process */ +/* eslint-disable no-console, security/detect-child-process, security/detect-non-literal-fs-filename */ const fs = require('fs') const typedoc = require('typedoc') const typescript = require('typescript') +const ora = require('ora') const squidJsPackage = require('../external/squid-js/package.json') const { exec } = require('child_process') @@ -21,17 +22,18 @@ const config = typescript.findConfigFile( ) // npm install for squid-js -console.log('Installing submodule dependencies...') +const spinnerNpm = ora('Installing submodule dependencies...').start() const install = exec( 'cd ./external/squid-js && npm i && git checkout package-lock.json' ) install.on('exit', () => { + spinnerNpm.succeed('Installed submodule dependencies.') generateJson() }) const generateJson = () => { - console.log('Generating TypeDoc json...') + const spinnerTypedoc = ora('Generating TypeDoc json...').start() // Setup our TypeDoc app const app = new typedoc.Application({ @@ -45,7 +47,7 @@ const generateJson = () => { app.generateJson(project, outPath) // Parse and modify json output - const jsonOrig = JSON.parse(fs.readFileSync(outPath, 'utf8')) // eslint-disable-line + const jsonOrig = JSON.parse(fs.readFileSync(outPath, 'utf8')) const jsonFinal = { info: { @@ -58,5 +60,7 @@ const generateJson = () => { ...jsonOrig } - fs.writeFileSync(outPath, JSON.stringify(jsonFinal, null, 4)) // eslint-disable-line + fs.writeFileSync(outPath, JSON.stringify(jsonFinal, null, 4)) + + spinnerTypedoc.succeed('Generated TypeDoc json.') } diff --git a/src/templates/ApiSwagger.jsx b/src/templates/ApiSwagger.jsx deleted file mode 100644 index 1635122e..00000000 --- a/src/templates/ApiSwagger.jsx +++ /dev/null @@ -1,321 +0,0 @@ -import React, { Component } from 'react' -import PropTypes from 'prop-types' -import { graphql } from 'gatsby' -import Helmet from 'react-helmet' -import slugify from 'slugify' -import Layout from '../components/Layout' -import Content from '../components/Content' -import HeaderSection from '../components/HeaderSection' -import Sidebar from '../components/Sidebar' -import DocHeader from '../components/DocHeader' -import DocFooter from '../components/DocFooter' -import SEO from '../components/Seo' -import stylesDoc from './Doc.module.scss' -import styles from './ApiSwagger.module.scss' - -const cleanKey = key => { - let keyCleaned = key - - if (key.includes('aquarius')) { - keyCleaned = key.replace(/\/api\/v1\/aquarius/gi, '') - } - - if (key.includes('brizo')) { - keyCleaned = key.replace(/\/api\/v1\/brizo/gi, '') - } - - return keyCleaned -} - -const toc = api => { - const items = Object.keys(api.paths).map( - key => `
  • - ${cleanKey( - key - )} -
    • ` - ) - - return `` -} - -const SwaggerMeta = ({ contact, license }) => ( - -) - -SwaggerMeta.propTypes = { - contact: PropTypes.object, - license: PropTypes.object -} - -const ParameterExample = ({ properties }) => ( - // - // HEADS UP! - // - // Constructing the example request body here based on the defined properties - // where `key` is the name of the property, and `properties[key].example` is - // the value for it. - // - // Making prism.js pick up on the strings only output didn't work out so well - // so the spans and classes this plugin would add are added manually here. Since we - // include the prism css file globally this is picked up by that. - // - // But this can only work if all keys and values are manually constructed here, which - // is almost impossible to do for deep nested objects or arrays as example value. Running - // that code through `JSON.stringify` won't syntax highlight that part of the code. - // - 
    -        
-            {'{'}
-            {properties &&
-                Object.keys(properties).map(key => (
-                    
    
-                        {`  "${key}"`}
-                        {`: `}
-                        {properties[key].type === 'string' && (
-                            {`"${
-                                properties[key].example
-                            }"`}
-                        )}
-                        {(properties[key].type === 'integer' ||
-                            properties[key].type === 'number') && (
-                            
-                                {`${properties[key].example}`}
-                            
-                        )}
-                        {(properties[key].type === 'array' ||
-                            properties[key].type === 'object') &&
-                            JSON.stringify(properties[key].example, null, 2)}
-                        ,
-                    
    
-                ))}
-            {'}'}
-            
-
    -) - -ParameterExample.propTypes = { - properties: PropTypes.object -} - -const Parameters = ({ parameters }) => ( - <> -

    Parameters

    - - {parameters.map(parameter => { - const { name, type, required, description, schema } = parameter - - return ( -
    -
    - {name} - {required && ( - - * - - )} - {type} -
    - -

    {description}

    - - {schema && ( - - )} -
    - ) - })} - -) - -const Responses = ({ responses }) => ( - <> -

    Responses

    - {Object.keys(responses).map(key => ( -
    - {key} {responses[key].description} -
    - ))} - -) - -const Method = ({ keyName, value }) => { - const { summary, description, parameters, responses } = value - - return ( -
    -

    - {keyName} -

    - -

    {summary}

    - - {description &&

    {description}

    } - - {/* - {consumes && - consumes.map((item, i) => ( -
    - {item} -
    - ))} - */} - - {parameters && parameters.length && ( - - )} - {responses && Object.keys(responses).length !== 0 && ( - - )} -
    - ) -} - -Method.propTypes = { - keyName: PropTypes.string, - value: PropTypes.object -} - -const Paths = ({ paths }) => - Object.entries(paths).map(([key, value]) => ( -
    -

    - {cleanKey(key)} -

    - - {Object.entries(value).map(([key, value]) => ( - - ))} -
    - )) - -const BasePath = ({ host, basePath }) => ( -
    -

    Base Path

    - - {host} - {basePath} - -
    -) - -BasePath.propTypes = { - host: PropTypes.string, - basePath: PropTypes.string -} - -export default class ApiSwaggerTemplate extends Component { - static propTypes = { - data: PropTypes.object.isRequired, - location: PropTypes.object.isRequired, - pageContext: PropTypes.object.isRequired - } - - render() { - const { location, data, pageContext } = this.props - const sections = data.allSectionsYaml.edges - const { api } = pageContext - const { host, basePath, info, paths } = api - const { title, description, version, license, contact } = info - - // output section title as defined in sections.yml - const sectionTitle = sections.map(({ node }) => { - // compare section against section title from sections.yml - if (node.title.toLowerCase().includes('references')) { - return node.title - } - }) - - return ( - <> - - - - - - - - - - -
    - -
    - - {version} - - } - /> - - {(contact || license) && ( - - )} - - {(host || basePath) && ( - - )} - - - - -
    -
    -     -     - - ) - } -} - -export const apiSwaggerQuery = graphql` - query { - allSectionsYaml { - edges { - node { - title - description - link - } - } - } - } -` diff --git a/src/templates/Doc.jsx b/src/templates/Doc.jsx index e8762621..d92cde7e 100644 --- a/src/templates/Doc.jsx +++ b/src/templates/Doc.jsx @@ -38,22 +38,25 @@ export default class DocTemplate extends Component { location: PropTypes.object.isRequired } + // output section title as defined in sections.yml + sectionTitle = this.props.data.allSectionsYaml.edges.map(({ node }) => { + // compare section against section title from sections.yml + if ( + node.title + .toLowerCase() + .includes(this.props.data.markdownRemark.fields.section) + ) { + return node.title + } + }) + render() { const { location } = this.props const post = this.props.data.markdownRemark - const sections = this.props.data.allSectionsYaml.edges const { section, slug } = post.fields const { title, description } = post.frontmatter const { tableOfContents } = post - // output section title as defined in sections.yml - const sectionTitle = sections.map(({ node }) => { - // compare section against section title from sections.yml - if (node.title.toLowerCase().includes(section)) { - return node.title - } - }) - const isApiSection = location.pathname.includes('/references/') return ( @@ -70,7 +73,9 @@ export default class DocTemplate extends Component { /> - + {section ? ( diff --git a/src/templates/Doc.module.scss b/src/templates/Doc.module.scss index d57dd8c9..6e8e7a9e 100644 --- a/src/templates/Doc.module.scss +++ b/src/templates/Doc.module.scss @@ -48,3 +48,9 @@ max-width: 73%; margin: auto; } + +.version { + font-size: $font-size-base; + font-family: $font-family-monospace; + color: $brand-grey-light; +} diff --git a/src/templates/Swagger/Paths.jsx b/src/templates/Swagger/Paths.jsx new file mode 100644 index 00000000..c5e2615c --- /dev/null +++ b/src/templates/Swagger/Paths.jsx @@ -0,0 +1,151 @@ +import React from 'react' +import PropTypes from 'prop-types' +import slugify from 'slugify' +import { cleanPathKey } from './utils' +import styles from './Paths.module.scss' + +const ParameterExample = ({ properties }) => ( + // + // HEADS UP! + // + // Constructing the example request body here based on the defined properties + // where `key` is the name of the property, and `properties[key].example` is + // the value for it. + // + // Making prism.js pick up on the strings only output didn't work out so well + // so the spans and classes this plugin would add are added manually here. Since we + // include the prism css file globally this is picked up by that. + // + // But this can only work if all keys and values are manually constructed here, which + // is almost impossible to do for deep nested objects or arrays as example value. Running + // that code through `JSON.stringify` won't syntax highlight that part of the code. + // + 
    +        
+            {'{'}
+            {properties &&
+                Object.keys(properties).map(key => (
+                    
    
+                        {`  "${key}"`}
+                        {`: `}
+                        {properties[key].type === 'string' && (
+                            {`"${
+                                properties[key].example
+                            }"`}
+                        )}
+                        {(properties[key].type === 'integer' ||
+                            properties[key].type === 'number') && (
+                            
+                                {`${properties[key].example}`}
+                            
+                        )}
+                        {(properties[key].type === 'array' ||
+                            properties[key].type === 'object') &&
+                            JSON.stringify(properties[key].example, null, 2)}
+                        ,
+                    
    
+                ))}
+            {'}'}
+            
+
    +) + +ParameterExample.propTypes = { + properties: PropTypes.object +} + +const Parameters = ({ parameters }) => ( + <> +

    Parameters

    + + {parameters.map(parameter => { + const { name, type, required, description, schema } = parameter + + return ( +
    +
    + {name} + {required && ( + + * + + )} + {type} +
    + +

    {description}

    + + {schema && ( + + )} +
    + ) + })} + +) + +const Responses = ({ responses }) => ( + <> +

    Responses

    + {Object.keys(responses).map(key => ( +
    + {key} {responses[key].description} +
    + ))} + +) + +const Method = ({ keyName, value }) => { + const { summary, description, parameters, responses } = value + + return ( +
    +

    + {keyName} +

    + +

    {summary}

    + + {description &&

    {description}

    } + + {/* + {consumes && + consumes.map((item, i) => ( +
    + {item} +
    + ))} + */} + + {parameters && parameters.length && ( + + )} + {responses && Object.keys(responses).length !== 0 && ( + + )} +
    + ) +} + +Method.propTypes = { + keyName: PropTypes.string, + value: PropTypes.object +} + +const Paths = ({ paths }) => + Object.entries(paths).map(([key, value]) => ( +
    +

    + {cleanPathKey(key)} +

    + + {Object.entries(value).map(([key, value]) => ( + + ))} +
    + )) + +export default Paths diff --git a/src/templates/ApiSwagger.module.scss b/src/templates/Swagger/Paths.module.scss similarity index 65% rename from src/templates/ApiSwagger.module.scss rename to src/templates/Swagger/Paths.module.scss index a029bcc6..9c48a7c4 100644 --- a/src/templates/ApiSwagger.module.scss +++ b/src/templates/Swagger/Paths.module.scss @@ -1,52 +1,5 @@ @import 'variables'; -.version { - font-size: $font-size-base; - font-family: $font-family-monospace; - color: $brand-grey-light; -} - -.swaggerMeta { - margin-top: -($spacer); - padding: 0; - font-size: $font-size-small; - - li { - display: inline-block; - margin-left: $spacer; - - &:first-child { - margin-left: 0; - } - - &:before { - display: none; - } - } -} - -.basePath { - margin-top: $spacer; - - h2 { - font-size: $font-size-h3; - border-bottom: 1px solid $brand-grey-lighter; - padding-bottom: $spacer / 2; - margin-top: $spacer * 2; - margin-bottom: $spacer; - } - - span { - color: $brand-grey-light; - } - - code { - // stylelint-disable-next-line - font-size: $font-size-large !important; - font-weight: $font-weight-bold; - } -} - .pathName { font-size: $font-size-h3; border-bottom: 1px solid $brand-grey-lighter; diff --git a/src/templates/Swagger/Toc.jsx b/src/templates/Swagger/Toc.jsx new file mode 100644 index 00000000..6b4df0a3 --- /dev/null +++ b/src/templates/Swagger/Toc.jsx @@ -0,0 +1,19 @@ +import slugify from 'slugify' +import { cleanPathKey } from './utils' + +const Toc = api => { + const items = Object.keys(api.paths) + .map( + key => + `
  • + + ${cleanPathKey(key)} + +
    • ` + ) + .join('') + + return `
      ${items}
    ` +} + +export default Toc diff --git a/src/templates/Swagger/index.jsx b/src/templates/Swagger/index.jsx new file mode 100644 index 00000000..10077944 --- /dev/null +++ b/src/templates/Swagger/index.jsx @@ -0,0 +1,152 @@ +import React, { Component } from 'react' +import PropTypes from 'prop-types' +import { graphql } from 'gatsby' +import Helmet from 'react-helmet' + +import Layout from '../../components/Layout' +import Content from '../../components/Content' +import HeaderSection from '../../components/HeaderSection' +import Sidebar from '../../components/Sidebar' +import DocHeader from '../../components/DocHeader' +import DocFooter from '../../components/DocFooter' +import SEO from '../../components/Seo' + +import Toc from './Toc' +import Paths from './Paths' + +import stylesDoc from '../Doc.module.scss' +import styles from './index.module.scss' + +const SwaggerMeta = ({ contact, license }) => ( + +) + +SwaggerMeta.propTypes = { + contact: PropTypes.object, + license: PropTypes.object +} + +const BasePath = ({ host, basePath }) => ( +
    +

    Base Path

    + + {host} + {basePath} + +
    +) + +BasePath.propTypes = { + host: PropTypes.string, + basePath: PropTypes.string +} + +export default class ApiSwaggerTemplate extends Component { + static propTypes = { + data: PropTypes.object.isRequired, + location: PropTypes.object.isRequired, + pageContext: PropTypes.object.isRequired + } + + // output section title as defined in sections.yml + sectionTitle = this.props.data.allSectionsYaml.edges.map(({ node }) => { + // compare section against section title from sections.yml + if (node.title.toLowerCase().includes('references')) { + return node.title + } + }) + + render() { + const { location, pageContext } = this.props + const { api } = pageContext + const { host, basePath, info, paths } = api + const { title, description, version, license, contact } = info + + return ( + <> + + + + + + + + + + +
    + +
    + + {version} + + } + /> + + {(contact || license) && ( + + )} + + {(host || basePath) && ( + + )} + + + + +
    +
    +     +     + + ) + } +} + +export const apiSwaggerQuery = graphql` + query { + allSectionsYaml { + edges { + node { + title + description + link + } + } + } + } +` diff --git a/src/templates/Swagger/index.module.scss b/src/templates/Swagger/index.module.scss new file mode 100644 index 00000000..5b40c0d6 --- /dev/null +++ b/src/templates/Swagger/index.module.scss @@ -0,0 +1,42 @@ +@import 'variables'; + +.swaggerMeta { + margin-top: -($spacer); + padding: 0; + font-size: $font-size-small; + + li { + display: inline-block; + margin-left: $spacer; + + &:first-child { + margin-left: 0; + } + + &:before { + display: none; + } + } +} + +.basePath { + margin-top: $spacer; + + h2 { + font-size: $font-size-h3; + border-bottom: 1px solid $brand-grey-lighter; + padding-bottom: $spacer / 2; + margin-top: $spacer * 2; + margin-bottom: $spacer; + } + + span { + color: $brand-grey-light; + } + + code { + // stylelint-disable-next-line + font-size: $font-size-large !important; + font-weight: $font-weight-bold; + } +} diff --git a/src/templates/Swagger/utils.js b/src/templates/Swagger/utils.js new file mode 100644 index 00000000..5f431dd3 --- /dev/null +++ b/src/templates/Swagger/utils.js @@ -0,0 +1,13 @@ +export const cleanPathKey = key => { + let keyCleaned = key + + if (key.includes('aquarius')) { + keyCleaned = key.replace(/\/api\/v1\/aquarius/gi, '') + } + + if (key.includes('brizo')) { + keyCleaned = key.replace(/\/api\/v1\/brizo/gi, '') + } + + return keyCleaned +} diff --git a/src/templates/Typedoc.jsx b/src/templates/Typedoc/Entities.jsx similarity index 59% rename from src/templates/Typedoc.jsx rename to src/templates/Typedoc/Entities.jsx index cd30dab0..f529598f 100644 --- a/src/templates/Typedoc.jsx +++ b/src/templates/Typedoc/Entities.jsx @@ -1,50 +1,11 @@ -import React, { Component } from 'react' +import React from 'react' import PropTypes from 'prop-types' -import { graphql } from 'gatsby' -import Helmet from 'react-helmet' import slugify from 'slugify' -import Layout from '../components/Layout' -import Content from '../components/Content' -import HeaderSection from '../components/HeaderSection' -import Sidebar from '../components/Sidebar' -import DocHeader from '../components/DocHeader' -import SEO from '../components/Seo' -import stylesDoc from './Doc.module.scss' -import styles from './Typedoc.module.scss' +import styles from './Entities.module.scss' // more kinds: 'Property', 'Class' const showKindOfProperty = ['Method', 'Property'] -const toc = typedoc => { - const items = typedoc - .map(({ name, children }) => { - const parentName = name - - return ` -
  • - - ${name} - -
      - ${children - .map( - ({ name }) => - `
    • - - ${name} - -
      • ` - ) - .join('')} -
    -
    • - ` - }) - .join('') - - return `
      ${items}
    ` -} - const Type = ({ type }) => { let isArray = false if (type.type === 'array') { @@ -116,6 +77,7 @@ const MethodDetails = ({ property }) => { const { isOptional } = flags const description = comment && (comment.text || comment.shortText) + return (
    +const Entities = ({ entities, sourceUrl }) => entities.map(({ name, comment, children }) => (

    @@ -264,6 +226,9 @@ const Entity = ({ entities, sourceUrl }) => )} {children + // TODO: this filter neeeds to be added in utils.js + // cleanTypedocData function to make content and + // sidebar TOC consistent .filter(({ kindString }) => showKindOfProperty.includes(kindString) ) @@ -278,124 +243,9 @@ const Entity = ({ entities, sourceUrl }) =>

    )) -Entity.propTypes = { +Entities.propTypes = { entities: PropTypes.array.isRequired, sourceUrl: PropTypes.string } -export default class TypedocTemplate extends Component { - static propTypes = { - data: PropTypes.object.isRequired, - location: PropTypes.object.isRequired, - pageContext: PropTypes.object.isRequired - } - - componentWillMount() { - const { typedoc, classes } = this.props.pageContext - this.setState({ - typedocData: this.cleanTypedocData(typedoc, classes) - }) - } - - cleanTypedocData(data, useClasses) { - const nodes = data.children - const cleanData = nodes - .map(node => ({ - ...node, - name: node.name.replace(/"/g, ''), - child: node.children && node.children[0] - })) - .filter(({ name }) => (useClasses || []).includes(name)) - .sort( - (a, b) => - useClasses.indexOf(a.name) - useClasses.indexOf(b.name) - ) - .map(({ child }) => child) - .map(node => ({ - ...node, - children: node.children.sort((a, b) => a.id - b.id) - })) - - return cleanData - } - - render() { - const { location, data, pageContext } = this.props - const { typedocData } = this.state - const sections = data.allSectionsYaml.edges - const { typedoc } = pageContext - const { info } = typedoc - const { title, description, version, sourceUrl } = info - - // output section title as defined in sections.yml - const sectionTitle = sections.map(({ node }) => { - // compare section against section title from sections.yml - if (node.title.toLowerCase().includes('references')) { - return node.title - } - }) - - return ( - <> - - - - - - - - - - -
    - -
    - - {version} - - } - /> - - -
    -
    -     -     - - ) - } -} - -export const TypedocQuery = graphql` - query { - allSectionsYaml { - edges { - node { - title - description - link - } - } - } - } -` +export default Entities diff --git a/src/templates/Typedoc.module.scss b/src/templates/Typedoc/Entities.module.scss similarity index 96% rename from src/templates/Typedoc.module.scss rename to src/templates/Typedoc/Entities.module.scss index 9bcecf8e..6ceff5ad 100644 --- a/src/templates/Typedoc.module.scss +++ b/src/templates/Typedoc/Entities.module.scss @@ -1,11 +1,5 @@ @import 'variables'; -.version { - font-size: $font-size-base; - font-family: $font-family-monospace; - color: $brand-grey-light; -} - .entityName { font-size: $font-size-h2; border-bottom: 1px solid $brand-grey-lighter; diff --git a/src/templates/Typedoc/Toc.jsx b/src/templates/Typedoc/Toc.jsx new file mode 100644 index 00000000..97cac4c0 --- /dev/null +++ b/src/templates/Typedoc/Toc.jsx @@ -0,0 +1,33 @@ +import slugify from 'slugify' + +const Toc = typedoc => { + const subItems = (children, parentName) => + children + .map( + ({ name }) => + `
  • + + ${name} + +
    • ` + ) + .join('') + + const items = typedoc + .map( + ({ name, children }) => + `
  • + + ${name} + +
      + ${subItems(children, name)} +
    +
    • ` + ) + .join('') + + return `
      ${items}
    ` +} + +export default Toc diff --git a/src/templates/Typedoc/index.jsx b/src/templates/Typedoc/index.jsx new file mode 100644 index 00000000..a9b7ca6a --- /dev/null +++ b/src/templates/Typedoc/index.jsx @@ -0,0 +1,107 @@ +import React, { Component } from 'react' +import PropTypes from 'prop-types' +import { graphql } from 'gatsby' +import Helmet from 'react-helmet' +import Layout from '../../components/Layout' +import Content from '../../components/Content' +import HeaderSection from '../../components/HeaderSection' +import Sidebar from '../../components/Sidebar' +import DocHeader from '../../components/DocHeader' +import SEO from '../../components/Seo' +import { cleanTypedocData } from './utils' + +import Entities from './Entities' +import Toc from './Toc' + +import stylesDoc from '../Doc.module.scss' + +export default class TypedocTemplate extends Component { + static propTypes = { + data: PropTypes.object.isRequired, + location: PropTypes.object.isRequired, + pageContext: PropTypes.object.isRequired + } + + typedocCleaned = cleanTypedocData( + this.props.pageContext.typedoc, + this.props.pageContext.classes + ) + + // output section title as defined in sections.yml + sectionTitle = this.props.data.allSectionsYaml.edges.map(({ node }) => { + // compare section against section title from sections.yml + if (node.title.toLowerCase().includes('references')) { + return node.title + } + }) + + render() { + const { location, pageContext } = this.props + const { typedoc } = pageContext + const { info } = typedoc + const { title, description, version, sourceUrl } = info + + return ( + <> + + + + + + + + + + +
    + +
    + + {version} + + } + /> + + +
    +
    +     +     + + ) + } +} + +export const TypedocQuery = graphql` + query { + allSectionsYaml { + edges { + node { + title + description + link + } + } + } + } +` diff --git a/src/templates/Typedoc/utils.js b/src/templates/Typedoc/utils.js new file mode 100644 index 00000000..ec4fd515 --- /dev/null +++ b/src/templates/Typedoc/utils.js @@ -0,0 +1,19 @@ +export const cleanTypedocData = (data, useClasses) => { + const nodes = data.children + + const cleanData = nodes + .map(node => ({ + ...node, + name: node.name.replace(/"/g, ''), + child: node.children && node.children[0] + })) + .filter(({ name }) => (useClasses || []).includes(name)) + .sort((a, b) => useClasses.indexOf(a.name) - useClasses.indexOf(b.name)) + .map(({ child }) => child) + .map(node => ({ + ...node, + children: node.children.sort((a, b) => a.id - b.id) + })) + + return cleanData +}