import { constants as docConstants, DocsInfo, DocsInfoConfig, SupportedDocJson } from '@0xproject/react-docs'; import * as React from 'react'; import { connect } from 'react-redux'; import { Dispatch } from 'redux'; import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page'; import { Dispatcher } from 'ts/redux/dispatcher'; import { State } from 'ts/redux/reducer'; import { DocPackages } from 'ts/types'; import { Translate } from 'ts/utils/translate'; /* tslint:disable:no-var-requires */ const IntroMarkdown = require('md/docs/sol_cov/introduction'); const InstallationMarkdown = require('md/docs/sol_cov/installation'); const UsageMarkdown = require('md/docs/sol_cov/usage'); /* tslint:enable:no-var-requires */ const docSections = { introduction: 'introduction', installation: 'installation', usage: 'usage', coverageSubprovider: 'coverageSubprovider', abstractArtifactAdapter: 'abstractArtifactAdapter', solCompilerArtifactAdapter: 'solCompilerArtifactAdapter', truffleArtifactAdapter: 'truffleArtifactAdapter', types: docConstants.TYPES_SECTION_NAME, }; const docsInfoConfig: DocsInfoConfig = { id: DocPackages.SolCov, type: SupportedDocJson.TypeDoc, displayName: 'Sol-cov', packageUrl: 'https://github.com/0xProject/0x-monorepo', menu: { introduction: [docSections.introduction], install: [docSections.installation], usage: [docSections.usage], 'coverage-subprovider': [docSections.coverageSubprovider], 'abstract-artifact-adapter': [docSections.abstractArtifactAdapter], 'sol-compiler-artifact-adapter': [docSections.solCompilerArtifactAdapter], 'truffle-artifact-adapter': [docSections.truffleArtifactAdapter], types: [docSections.types], }, sectionNameToMarkdown: { [docSections.introduction]: IntroMarkdown, [docSections.installation]: InstallationMarkdown, [docSections.usage]: UsageMarkdown, }, sectionNameToModulePath: { [docSections.coverageSubprovider]: ['"sol-cov/src/coverage_subprovider"'], [docSections.abstractArtifactAdapter]: ['"sol-cov/src/artifact_adapters/abstract_artifact_adapter"'], [docSections.solCompilerArtifactAdapter]: ['"sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter"'], [docSections.truffleArtifactAdapter]: ['"sol-cov/src/artifact_adapters/truffle_artifact_adapter"'], [docSections.types]: ['"subproviders/src/types"', '"types/src/index"'], }, menuSubsectionToVersionWhenIntroduced: {}, sections: docSections, visibleConstructors: [ docSections.coverageSubprovider, docSections.abstractArtifactAdapter, docSections.solCompilerArtifactAdapter, docSections.truffleArtifactAdapter, ], typeConfigs: { // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is // currently no way to extract the re-exported types from index.ts via TypeDoc :( publicTypes: [ 'JSONRPCRequestPayload', 'NextCallback', 'ErrorCallback', 'AbstractArtifactAdapter', 'CoverageSubprovider', 'TruffleArtifactAdapter', 'SolCompilerArtifactAdapter', 'ContractData', ], typeNameToExternalLink: {}, typeNameToPrefix: {}, typeNameToDocSection: { AbstractArtifactAdapter: docSections.abstractArtifactAdapter, CoverageSubprovider: docSections.coverageSubprovider, TruffleArtifactAdapter: docSections.truffleArtifactAdapter, SolCompilerArtifactAdapter: docSections.solCompilerArtifactAdapter, }, }, }; const docsInfo = new DocsInfo(docsInfoConfig); interface ConnectedState { docsVersion: string; availableDocVersions: string[]; docsInfo: DocsInfo; translate: Translate; } interface ConnectedDispatch { dispatcher: Dispatcher; } const mapStateToProps = (state: State, ownProps: DocPageProps): ConnectedState => ({ docsVersion: state.docsVersion, availableDocVersions: state.availableDocVersions, translate: state.translate, docsInfo, }); const mapDispatchToProps = (dispatch: Dispatch): ConnectedDispatch => ({ dispatcher: new Dispatcher(dispatch), }); export const Documentation: React.ComponentClass = connect(mapStateToProps, mapDispatchToProps)( DocPageComponent, );