mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
Merge pull request #323 from oceanprotocol/fix/typedoc
fix typedoc cleanup
This commit is contained in:
GitHub
commit
753540b498
@ -220,22 +220,25 @@ const createTypeDocPage = async (createPage, name, downloadUrl) => {
|
||||
'ocean/OceanAccounts',
|
||||
'ocean/OceanAssets',
|
||||
'ocean/OceanAgreements',
|
||||
'ocean/OceanAgreementsConditions',
|
||||
'ocean/OceanSecretStore',
|
||||
'ocean/OceanVersions',
|
||||
'ocean/Account',
|
||||
'ocean/DID',
|
||||
'ocean/ServiceAgreements/ServiceAgreement',
|
||||
'ddo/DDO',
|
||||
'ddo/Service',
|
||||
'aquarius/AquariusProvider',
|
||||
'aquarius/Aquarius',
|
||||
'aquarius/query/SearchQuery',
|
||||
'brizo/BrizoProvider',
|
||||
'brizo/Brizo',
|
||||
'keeper/Keeper',
|
||||
'keeper/ContractHandler',
|
||||
'keeper/EventHandler',
|
||||
'keeper/Web3Provider',
|
||||
'secretstore/SecretStoreProvider',
|
||||
'models/Config',
|
||||
'models/Balance'
|
||||
'models/Balance',
|
||||
'ocean/utils/OceanUtils',
|
||||
'ocean/utils/ServiceAgreement',
|
||||
'ocean/utils/WebServiceConnector',
|
||||
'utils/Logger'
|
||||
]
|
||||
}
|
||||
})
|
||||
|
||||
@ -62,6 +62,7 @@
|
||||
"remark": "^11.0.1",
|
||||
"remark-github-plugin": "^1.3.1",
|
||||
"remark-react": "^6.0.0",
|
||||
"shortid": "^2.2.15",
|
||||
"slugify": "^1.3.4",
|
||||
"smoothscroll-polyfill": "^0.4.4",
|
||||
"swagger-client": "^3.9.5"
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
import React from 'react'
|
||||
import PropTypes from 'prop-types'
|
||||
import slugify from 'slugify'
|
||||
import shortid from 'shortid'
|
||||
import Scroll from '../../components/Scroll'
|
||||
import styles from './Entities.module.scss'
|
||||
import { filterByKindOfProperty } from './utils'
|
||||
@ -18,7 +19,11 @@ const Type = ({ type }) => {
|
||||
<div className={styles.type}>
|
||||
<span>
|
||||
{isInternal && (
|
||||
<Scroll type="id" element={`${slugify(name)}`} offset={-20}>
|
||||
<Scroll
|
||||
type="id"
|
||||
element={`${name && slugify(name)}`}
|
||||
offset={-20}
|
||||
>
|
||||
{type.name}
|
||||
</Scroll>
|
||||
)}
|
||||
@ -30,13 +35,13 @@ const Type = ({ type }) => {
|
||||
<span className={styles.typeSymbol}><</span>
|
||||
<span>
|
||||
{typeArguments.map((typeArgument, i) => (
|
||||
<span key={i}>
|
||||
<span key={shortid.generate()}>
|
||||
{i !== 0 && (
|
||||
<span className={styles.typeSymbol}>
|
||||
,{' '}
|
||||
</span>
|
||||
)}
|
||||
<Type type={typeArgument} key={i} />
|
||||
<Type type={typeArgument} />
|
||||
</span>
|
||||
))}
|
||||
</span>
|
||||
@ -84,7 +89,7 @@ const MethodDetails = ({ property }) => {
|
||||
return (
|
||||
<div
|
||||
className={styles.parameters}
|
||||
key={parameter.name}
|
||||
key={shortid.generate()}
|
||||
>
|
||||
<h5>
|
||||
<code>{name}</code>
|
||||
@ -140,7 +145,8 @@ const PropertyWrapper = ({ property, sourceUrl, parentAnchor }) => {
|
||||
let deprecatedUse, deprecatedSlug
|
||||
if (deprecation) {
|
||||
deprecatedUse = deprecation.arguments.alternative.replace(/('|")/g, '')
|
||||
deprecatedSlug = slugify(deprecatedUse.replace('.', '-'))
|
||||
deprecatedSlug =
|
||||
deprecatedUse && slugify(deprecatedUse.replace('.', '-'))
|
||||
}
|
||||
|
||||
const sourceLink = `${sourceUrl}${fileName}#L${line}`
|
||||
@ -150,7 +156,7 @@ const PropertyWrapper = ({ property, sourceUrl, parentAnchor }) => {
|
||||
className={styles.property}
|
||||
data-private={!isPublic}
|
||||
data-deprecated={!!deprecation}
|
||||
id={`${parentAnchor}-${slugify(name)}`}
|
||||
id={`${parentAnchor}-${name && slugify(name)}`}
|
||||
>
|
||||
<h3 className={styles.propertyName}>{name}</h3>
|
||||
|
||||
@ -222,7 +228,7 @@ PropertyWrapper.propTypes = {
|
||||
|
||||
const Entities = ({ entities, sourceUrl }) =>
|
||||
entities.map(({ name, comment, children }) => (
|
||||
<div key={name} id={slugify(name)}>
|
||||
<div key={shortid.generate()} id={name && slugify(name)}>
|
||||
<h2 className={styles.entityName}>
|
||||
<code>{name}</code>
|
||||
</h2>
|
||||
@ -233,14 +239,17 @@ const Entities = ({ entities, sourceUrl }) =>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{children.filter(filterByKindOfProperty).map(property => (
|
||||
<PropertyWrapper
|
||||
key={`${name}/${property.id}`}
|
||||
property={property}
|
||||
sourceUrl={sourceUrl}
|
||||
parentAnchor={slugify(name)}
|
||||
/>
|
||||
))}
|
||||
{children &&
|
||||
children
|
||||
.filter(filterByKindOfProperty)
|
||||
.map(property => (
|
||||
<PropertyWrapper
|
||||
key={shortid.generate()}
|
||||
property={property}
|
||||
sourceUrl={sourceUrl}
|
||||
parentAnchor={name && slugify(name)}
|
||||
/>
|
||||
))}
|
||||
</div>
|
||||
))
|
||||
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
import React, { PureComponent } from 'react'
|
||||
import PropTypes from 'prop-types'
|
||||
import slugify from 'slugify'
|
||||
import shortid from 'shortid'
|
||||
import Scrollspy from 'react-scrollspy'
|
||||
import Scroll from '../../components/Scroll'
|
||||
import { filterByKindOfProperty } from './utils'
|
||||
@ -12,16 +13,17 @@ export default class Toc extends PureComponent {
|
||||
}
|
||||
|
||||
subItems = (children, parentName) =>
|
||||
children &&
|
||||
children.filter(filterByKindOfProperty).map(({ name, decorators }) => {
|
||||
const deprecation = (decorators || []).filter(
|
||||
({ name }) => name === 'deprecated'
|
||||
)[0] // Assuming deprecated annotation
|
||||
|
||||
return (
|
||||
<li key={name}>
|
||||
<li key={shortid.generate()}>
|
||||
<Scroll
|
||||
type="id"
|
||||
element={`${parentName}-${slugify(name)}`}
|
||||
element={`${parentName}-${name && slugify(name)}`}
|
||||
data-deprecated={!!deprecation}
|
||||
offset={-20}
|
||||
>
|
||||
@ -36,14 +38,19 @@ export default class Toc extends PureComponent {
|
||||
const parentName = name
|
||||
|
||||
subIds.push(
|
||||
children.filter(filterByKindOfProperty).map(({ name }) => {
|
||||
return `${parentName}-${slugify(name)}`
|
||||
})
|
||||
children &&
|
||||
children.filter(filterByKindOfProperty).map(({ name }) => {
|
||||
return `${parentName}-${name && slugify(name)}`
|
||||
})
|
||||
)
|
||||
|
||||
return (
|
||||
<li key={name}>
|
||||
<Scroll type="id" element={`${slugify(name)}`} offset={-20}>
|
||||
<li key={shortid.generate()}>
|
||||
<Scroll
|
||||
type="id"
|
||||
element={`${name && slugify(name)}`}
|
||||
offset={-20}
|
||||
>
|
||||
<code>{name}</code>
|
||||
</Scroll>
|
||||
<Scrollspy
|
||||
|
||||
@ -2,23 +2,34 @@ export const cleanTypedocData = (data, useClasses) => {
|
||||
const nodes = data.children
|
||||
|
||||
const cleanData = nodes
|
||||
.map(node => ({
|
||||
...node,
|
||||
name: node.name.replace(/"/g, '').replace('src/', ''),
|
||||
child: node.children && node.children[0]
|
||||
}))
|
||||
.map(node => {
|
||||
const child =
|
||||
node.children &&
|
||||
node.children.filter(
|
||||
({ kindString }) => kindString === 'Class'
|
||||
)[0]
|
||||
|
||||
return {
|
||||
...node,
|
||||
name: node.name.replace(/"/g, '').replace('src/', ''),
|
||||
child
|
||||
}
|
||||
})
|
||||
.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)
|
||||
children:
|
||||
node &&
|
||||
node.children &&
|
||||
node.children.sort((a, b) => a.id - b.id)
|
||||
}))
|
||||
|
||||
return cleanData
|
||||
}
|
||||
|
||||
// more kinds: 'Property', 'Class'
|
||||
// more kinds: 'Property', 'Enumeration'
|
||||
const showKindOfProperty = {
|
||||
Method: { onlyPublic: true },
|
||||
Property: { onlyPublic: true }
|
||||
@ -28,6 +39,9 @@ export const filterByKindOfProperty = ({ kindString, flags }) => {
|
||||
const config = showKindOfProperty[kindString]
|
||||
if (!config) return
|
||||
|
||||
// filter out static methods by default
|
||||
if (flags.isStatic) return
|
||||
|
||||
if (config.onlyPublic && !flags.isPublic) return
|
||||
|
||||
return true
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user