crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Move react-docs into website and delete it as a standalone package

Browse Source
This commit is contained in:
fabioberger 2019-07-24 23:27:03 +02:00
parent 46384ce80d
commit cc7dec7a99
55 changed files with 148 additions and 1151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/autolabeler.yml vendored
View File

@ -22,7 +22,6 @@ contracts: ['contracts']
@0x/tslint-config: ['packages/tslint-config']
@0x/asset-buyer: ['packages/asset-buyer']
@0x/order-watcher: ['packages/order-watcher']
@0x/react-docs: ['packages/react-docs']
@0x/order-utils: ['packages/order-utils']
@0x/react-shared: ['packages/react-shared']
@0x/assert: ['packages/assert']

1
.gitignore vendored
View File

@ -77,7 +77,6 @@ TODO.md
packages/website/public/bundle*
packages/dev-tools-pages/public/bundle*
packages/react-docs/example/public/bundle*
# server cli
packages/testnet-faucets/server/

25
README.md
View File

@ -87,19 +87,18 @@ These packages are all under development. See [/contracts/README.md](/contracts/
#### Utilities
| Package | Version | Description |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| [`@0x/abi-gen`](/packages/abi-gen) | [![npm](https://img.shields.io/npm/v/@0x/abi-gen.svg)](https://www.npmjs.com/package/@0x/abi-gen) | Tool to generate TS wrappers from smart contract ABIs |
| [`@0x/tslint-config`](/packages/tslint-config) | [![npm](https://img.shields.io/npm/v/@0x/tslint-config.svg)](https://www.npmjs.com/package/@0x/tslint-config) | Custom TSLint rules used by the 0x core team |
| [`@0x/types`](/packages/types) | [![npm](https://img.shields.io/npm/v/@0x/types.svg)](https://www.npmjs.com/package/@0x/types) | Shared type declarations |
| [`@0x/typescript-typings`](/packages/typescript-typings) | [![npm](https://img.shields.io/npm/v/@0x/typescript-typings.svg)](https://www.npmjs.com/package/@0x/typescript-typings) | Repository of types for external packages |
| [`@0x/utils`](/packages/utils) | [![npm](https://img.shields.io/npm/v/@0x/utils.svg)](https://www.npmjs.com/package/@0x/utils) | Shared utilities |
| [`@0x/react-docs`](/packages/react-docs) | [![npm](https://img.shields.io/npm/v/@0x/react-docs.svg)](https://www.npmjs.com/package/@0x/react-docs) | React documentation component for rendering TypeDoc & sol-doc generated JSON |
| [`@0x/react-shared`](/packages/react-shared) | [![npm](https://img.shields.io/npm/v/@0x/react-shared.svg)](https://www.npmjs.com/package/@0x/react-shared) | 0x shared react components |
| [`@0x/assert`](/packages/assert) | [![npm](https://img.shields.io/npm/v/@0x/assert.svg)](https://www.npmjs.com/package/@0x/assert) | Type and schema assertions used by our packages |
| [`@0x/base-contract`](/packages/base-contract) | [![npm](https://img.shields.io/npm/v/@0x/base-contract.svg)](https://www.npmjs.com/package/@0x/base-contract) | BaseContract used by auto-generated `abi-gen` wrapper contracts |
| [`@0x/dev-utils`](/packages/dev-utils) | [![npm](https://img.shields.io/npm/v/@0x/dev-utils.svg)](https://www.npmjs.com/package/@0x/dev-utils) | Dev utils to be shared across 0x packages |
| [`@0x/fill-scenarios`](/packages/fill-scenarios) | [![npm](https://img.shields.io/npm/v/@0x/fill-scenarios.svg)](https://www.npmjs.com/package/@0x/fill-scenarios) | 0x order fill scenario generator |
| Package | Version | Description |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| [`@0x/abi-gen`](/packages/abi-gen) | [![npm](https://img.shields.io/npm/v/@0x/abi-gen.svg)](https://www.npmjs.com/package/@0x/abi-gen) | Tool to generate TS wrappers from smart contract ABIs |
| [`@0x/tslint-config`](/packages/tslint-config) | [![npm](https://img.shields.io/npm/v/@0x/tslint-config.svg)](https://www.npmjs.com/package/@0x/tslint-config) | Custom TSLint rules used by the 0x core team |
| [`@0x/types`](/packages/types) | [![npm](https://img.shields.io/npm/v/@0x/types.svg)](https://www.npmjs.com/package/@0x/types) | Shared type declarations |
| [`@0x/typescript-typings`](/packages/typescript-typings) | [![npm](https://img.shields.io/npm/v/@0x/typescript-typings.svg)](https://www.npmjs.com/package/@0x/typescript-typings) | Repository of types for external packages |
| [`@0x/utils`](/packages/utils) | [![npm](https://img.shields.io/npm/v/@0x/utils.svg)](https://www.npmjs.com/package/@0x/utils) | Shared utilities |
| [`@0x/react-shared`](/packages/react-shared) | [![npm](https://img.shields.io/npm/v/@0x/react-shared.svg)](https://www.npmjs.com/package/@0x/react-shared) | 0x shared react components |
| [`@0x/assert`](/packages/assert) | [![npm](https://img.shields.io/npm/v/@0x/assert.svg)](https://www.npmjs.com/package/@0x/assert) | Type and schema assertions used by our packages |
| [`@0x/base-contract`](/packages/base-contract) | [![npm](https://img.shields.io/npm/v/@0x/base-contract.svg)](https://www.npmjs.com/package/@0x/base-contract) | BaseContract used by auto-generated `abi-gen` wrapper contracts |
| [`@0x/dev-utils`](/packages/dev-utils) | [![npm](https://img.shields.io/npm/v/@0x/dev-utils.svg)](https://www.npmjs.com/package/@0x/dev-utils) | Dev utils to be shared across 0x packages |
| [`@0x/fill-scenarios`](/packages/fill-scenarios) | [![npm](https://img.shields.io/npm/v/@0x/fill-scenarios.svg)](https://www.npmjs.com/package/@0x/fill-scenarios) | 0x order fill scenario generator |
#### Private Packages

2
packages/monorepo-scripts/src/test_installation.ts
View File

@ -12,7 +12,7 @@ import { Changelog, Package } from './types';
import { utils } from './utils/utils';
// Packages might not be runnable if they are command-line tools or only run in browsers.
const UNRUNNABLE_PACKAGES = ['@0x/abi-gen', '@0x/react-shared', '@0x/react-docs'];
const UNRUNNABLE_PACKAGES = ['@0x/abi-gen', '@0x/react-shared'];
const mkdirpAsync = promisify(mkdirp);
const rimrafAsync = promisify(rimraf);

9
packages/react-docs/.npmignore
View File

@ -1,9 +0,0 @@
# Blacklist all files
.*
*
# Whitelist lib
!lib/**/*
# Blacklist tests and publish scripts
/lib/test/*
/lib/monorepo_scripts/
# Package specific ignore

543
packages/react-docs/CHANGELOG.json
View File

@ -1,543 +0,0 @@
[
{
"timestamp": 1563957393,
"version": "2.0.15",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1563047529,
"version": "2.0.14",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1563006338,
"version": "2.0.13",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1558712885,
"version": "2.0.12",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1557507213,
"version": "2.0.11",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "2.0.10",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1554997931
},
{
"timestamp": 1553183790,
"version": "2.0.9",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1553091633,
"version": "2.0.8",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1551479279,
"version": "2.0.7",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1551220833,
"version": "2.0.6",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1551130135,
"version": "2.0.5",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1549733923,
"version": "2.0.4",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "2.0.3",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1549547375
},
{
"timestamp": 1549504360,
"version": "2.0.2",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1549452781,
"version": "2.0.1",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "2.0.0",
"changes": [
{
"note": "Upgrade the bignumber.js to v8.0.2",
"pr": 1517
}
],
"timestamp": 1549373905
},
{
"timestamp": 1547561734,
"version": "1.0.25",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1547225310,
"version": "1.0.24",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1547040760,
"version": "1.0.23",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "1.0.22",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1544739608
},
{
"version": "1.0.21",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1544570656
},
{
"timestamp": 1543401373,
"version": "1.0.20",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1542821676,
"version": "1.0.19",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1542208198,
"version": "1.0.18",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1542134075,
"version": "1.0.17",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1542028948,
"version": "1.0.16",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "1.0.15",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1541740904
},
{
"timestamp": 1539871071,
"version": "1.0.14",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "1.0.13",
"changes": [
{
"note": "Dependencies updated"
}
],
"timestamp": 1538693146
},
{
"timestamp": 1538157789,
"version": "1.0.12",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1537907159,
"version": "1.0.11",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1537875740,
"version": "1.0.10",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1537541580,
"version": "1.0.9",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1536142250,
"version": "1.0.8",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1535377027,
"version": "1.0.7",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1535133899,
"version": "1.0.6",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1534210131,
"version": "1.0.5",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1532619515,
"version": "1.0.4",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1532614997,
"version": "1.0.3",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1532605697,
"version": "1.0.2",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1532357734,
"version": "1.0.1",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1532043000,
"version": "1.0.0",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1531919263,
"version": "0.0.17",
"changes": [
{
"note": "Nest MD files under versions so that you can update them for future versions",
"pr": 844
}
]
},
{
"timestamp": 1531919263,
"version": "0.0.16",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1531149657,
"version": "0.0.15",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1529397769,
"version": "0.0.14",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "0.0.13",
"changes": [
{
"note": "Incorrect publish that was unpublished"
}
],
"timestamp": 1527810075
},
{
"timestamp": 1527009133,
"version": "0.0.12",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1525477860,
"version": "0.0.11",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1525466747,
"version": "0.0.10",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1525428773,
"version": "0.0.9",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "0.0.8",
"changes": [
{
"note": "Added support for rendering default param values",
"pr": 519
},
{
"note": "Added support for rendering nested function types within interface types",
"pr": 519
},
{
"note": "Improve type comment rendering",
"pr": 535
}
],
"timestamp": 1524044013
},
{
"timestamp": 1523462196,
"version": "0.0.7",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"timestamp": 1522673609,
"version": "0.0.6",
"changes": [
{
"note": "Dependencies updated"
}
]
},
{
"version": "0.0.5",
"changes": [
{
"note": "Handle `reflection` type rendering so that anonymous function type declarations render properly",
"pr": 465
},
{
"note": "Rename `MethodSignature` to `Signature` and change it's props so that it can be used to render method and function signatures.",
"pr": 465
},
{
"note": "Rename `MethodBlock` to `SignatureBlock` since it is not used to render method and function signature blocks.",
"pr": 465
},
{
"note": "Add support for documenting exported functions.",
"pr": 465
}
],
"timestamp": 1522658513
},
{
"version": "0.0.3",
"changes": [
{
"note": "Move TS typings from devDependencies to dependencies since they are needed by the package user."
}
],
"timestamp": 1521298800
},
{
"version": "0.0.2",
"changes": [
{
"note": "Move example out into a separate sub-package"
},
{
"note": "Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package",
"pr": 452
}
],
"timestamp": 1521298800
}
]

240
packages/react-docs/CHANGELOG.md
View File

@ -1,240 +0,0 @@
<!--
changelogUtils.file is auto-generated using the monorepo-scripts package. Don't edit directly.
Edit the package's CHANGELOG.json file only.
-->
CHANGELOG
## v2.0.15 - _July 24, 2019_
* Dependencies updated
## v2.0.14 - _July 13, 2019_
* Dependencies updated
## v2.0.13 - _July 13, 2019_
* Dependencies updated
## v2.0.12 - _May 24, 2019_
* Dependencies updated
## v2.0.11 - _May 10, 2019_
* Dependencies updated
## v2.0.10 - _April 11, 2019_
* Dependencies updated
## v2.0.9 - _March 21, 2019_
* Dependencies updated
## v2.0.8 - _March 20, 2019_
* Dependencies updated
## v2.0.7 - _March 1, 2019_
* Dependencies updated
## v2.0.6 - _February 26, 2019_
* Dependencies updated
## v2.0.5 - _February 25, 2019_
* Dependencies updated
## v2.0.4 - _February 9, 2019_
* Dependencies updated
## v2.0.3 - _February 7, 2019_
* Dependencies updated
## v2.0.2 - _February 7, 2019_
* Dependencies updated
## v2.0.1 - _February 6, 2019_
* Dependencies updated
## v2.0.0 - _February 5, 2019_
* Upgrade the bignumber.js to v8.0.2 (#1517)
## v1.0.25 - _January 15, 2019_
* Dependencies updated
## v1.0.24 - _January 11, 2019_
* Dependencies updated
## v1.0.23 - _January 9, 2019_
* Dependencies updated
## v1.0.22 - _December 13, 2018_
* Dependencies updated
## v1.0.21 - _December 11, 2018_
* Dependencies updated
## v1.0.20 - _November 28, 2018_
* Dependencies updated
## v1.0.19 - _November 21, 2018_
* Dependencies updated
## v1.0.18 - _November 14, 2018_
* Dependencies updated
## v1.0.17 - _November 13, 2018_
* Dependencies updated
## v1.0.16 - _November 12, 2018_
* Dependencies updated
## v1.0.15 - _November 9, 2018_
* Dependencies updated
## v1.0.14 - _October 18, 2018_
* Dependencies updated
## v1.0.13 - _October 4, 2018_
* Dependencies updated
## v1.0.12 - _September 28, 2018_
* Dependencies updated
## v1.0.11 - _September 25, 2018_
* Dependencies updated
## v1.0.10 - _September 25, 2018_
* Dependencies updated
## v1.0.9 - _September 21, 2018_
* Dependencies updated
## v1.0.8 - _September 5, 2018_
* Dependencies updated
## v1.0.7 - _August 27, 2018_
* Dependencies updated
## v1.0.6 - _August 24, 2018_
* Dependencies updated
## v1.0.5 - _August 14, 2018_
* Dependencies updated
## v1.0.4 - _July 26, 2018_
* Dependencies updated
## v1.0.3 - _July 26, 2018_
* Dependencies updated
## v1.0.2 - _July 26, 2018_
* Dependencies updated
## v1.0.1 - _July 23, 2018_
* Dependencies updated
## v1.0.0 - _July 19, 2018_
* Dependencies updated
## v0.0.17 - _July 18, 2018_
* Nest MD files under versions so that you can update them for future versions (#844)
## v0.0.16 - _July 18, 2018_
* Dependencies updated
## v0.0.15 - _July 9, 2018_
* Dependencies updated
## v0.0.14 - _June 19, 2018_
* Dependencies updated
## v0.0.13 - _May 31, 2018_
* Incorrect publish that was unpublished
## v0.0.12 - _May 22, 2018_
* Dependencies updated
## v0.0.11 - _May 4, 2018_
* Dependencies updated
## v0.0.10 - _May 4, 2018_
* Dependencies updated
## v0.0.9 - _May 4, 2018_
* Dependencies updated
## v0.0.8 - _April 18, 2018_
* Added support for rendering default param values (#519)
* Added support for rendering nested function types within interface types (#519)
* Improve type comment rendering (#535)
## v0.0.7 - _April 11, 2018_
* Dependencies updated
## v0.0.6 - _April 2, 2018_
* Dependencies updated
## v0.0.5 - _April 2, 2018_
* Handle `reflection` type rendering so that anonymous function type declarations render properly (#465)
* Rename `MethodSignature` to `Signature` and change it's props so that it can be used to render method and function signatures. (#465)
* Rename `MethodBlock` to `SignatureBlock` since it is not used to render method and function signature blocks. (#465)
* Add support for documenting exported functions. (#465)
## v0.0.3 - _March 17, 2018_
* Move TS typings from devDependencies to dependencies since they are needed by the package user.
## v0.0.2 - _March 17, 2018_
* Move example out into a separate sub-package
* Consolidate all `console.log` calls into `logUtils` in the `@0xproject/utils` package (#452)

96
packages/react-docs/README.md
View File

@ -1,96 +0,0 @@
## @0x/react-docs
#### WARNING: Alpha software. Expect things to break when trying to use.
A full-page React component for rendering beautiful documentation for Solidity and Typescript code generated with [TypeDoc](http://typedoc.org/) or [sol-doc](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-doc).
<div style="text-align: center;">
<img src="https://s3.eu-west-2.amazonaws.com/0x-wiki-images/screenshot.png" style="padding-bottom: 20px; padding-top: 20px;" width="80%" />
<div>react-docs generating 0x's smart contract docs</div>
</div>
#### Features
- Mobile optimized
- Reads Javadoc-style comments in your code to generate class/method/argument/return/type comments.
- Syntax highlighting support for TypeScript & Solidity
- Type declaration linking
- Type declaration popovers to avoid clicking through to the definition
- Section/method/type anchors for easily pointing others to a specific part of your docs.
- Version picker
- Customizable sidebar header
- Supports custom markdown sections so you can easily add an intro or installation instructions.
## Installation
```bash
yarn add @0x/react-docs
```
## Usage
This package exposes both a single `Documentation` react component that will render a docs page, as well as all of it's sub-components in case someone wants to build their own layout.
Currently this package still has some external dependencies outside of the `Documentation` component, so please start your project off by copying the [react-docs-example](https://github.com/0xProject/0x-monorepo/tree/development/packages/react-docs-example) directory and modifying it there. If you need changes in the [react-docs](https://github.com/0xProject/0x-monorepo/tree/development/packages/react-docs) package, fork the 0x monorepo, make the required changes and submit a PR. Until we merge it, you can have your project depend on your own custom fork.
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
```json
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```
## Future improvements
Feel free to contribute to these improvements!
- Allow user to pass in styling for all major elements similar to [Material-UI](http://www.material-ui.com/).
- Allow user to define an alternative font and have it change everywhere.
- Add source links to Solidity docs (currently unsupported by solc, which underlies sol-doc).
## Contributing
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
### Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
```bash
PKG=@0x/react-docs yarn build
```
Or continuously rebuild on change:
```bash
PKG=@0x/react-docs yarn watch
```
### Clean
```bash
yarn clean
```
### Lint
```bash
yarn lint
```

62
packages/react-docs/package.json
View File

@ -1,62 +0,0 @@
{
"name": "@0x/react-docs",
"version": "2.0.15",
"engines": {
"node": ">=6.12"
},
"description": "React documentation component for rendering TypeDoc & sol-doc generated JSON",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"scripts": {
"lint": "tslint --format stylish --project .",
"fix": "tslint --fix --format stylish --project .",
"build": "tsc -b",
"build:ci": "yarn build",
"clean": "shx rm -rf lib"
},
"author": "Fabio Berger",
"license": "Apache-2.0",
"bugs": {
"url": "https://github.com/0xProject/0x-monorepo/issues"
},
"homepage": "https://github.com/0xProject/0x-monorepo/packages/react-docs/README.md",
"repository": {
"type": "git",
"url": "https://github.com/0xProject/0x-monorepo.git"
},
"devDependencies": {
"@0x/dev-utils": "^2.2.5",
"@0x/tslint-config": "^3.0.1",
"@types/compare-versions": "^3.0.0",
"@types/styled-components": "4.1.1",
"make-promises-safe": "^1.1.0",
"shx": "^0.2.2",
"tslint": "5.11.0",
"typescript": "3.0.1"
},
"dependencies": {
"@0x/react-shared": "^2.0.15",
"@0x/types": "^2.4.1",
"@0x/utils": "^4.4.1",
"@types/lodash": "4.14.104",
"@types/material-ui": "^0.20.0",
"@types/node": "*",
"@types/react": "*",
"@types/react-dom": "*",
"@types/react-scroll": "1.5.3",
"basscss": "^8.0.3",
"compare-versions": "^3.0.1",
"lodash": "^4.17.11",
"material-ui": "^0.20.0",
"react": "^16.5.2",
"react-dom": "^16.5.2",
"react-markdown": "^3.2.2",
"react-scroll": "0xproject/react-scroll#pr-330-and-replace-state",
"react-tooltip": "^3.2.7",
"semver": "5.5.0",
"styled-components": "^4.1.1"
},
"publishConfig": {
"access": "public"
}
}

6
packages/react-docs/src/globals.d.ts vendored
View File

@ -1,6 +0,0 @@
declare module '*.json' {
const json: any;
/* tslint:disable */
export default json;
/* tslint:enable */
}

23
packages/react-docs/src/index.ts
View File

@ -1,23 +0,0 @@
export { DocAgnosticFormat, GeneratedDocJson } from '@0x/types';
// Exported to give users of this library added flexibility if they want to build
// a docs page from scratch using the individual components.
export { Badge } from './components/badge';
export { Comment } from './components/comment';
export { CustomEnum } from './components/custom_enum';
export { DocReference } from './components/doc_reference';
export { Enum } from './components/enum';
export { EventDefinition } from './components/event_definition';
export { Interface } from './components/interface';
export { SignatureBlock } from './components/signature_block';
export { Signature } from './components/signature';
export { SourceLink } from './components/source_link';
export { TypeDefinition } from './components/type_definition';
export { Type } from './components/type';
export { TypeDocUtils } from './utils/typedoc_utils';
export { DocsInfo } from './docs_info';
export { DocsInfoConfig, DocsMenu, SupportedDocJson } from './types';
export { constants } from './utils/constants';

66
packages/react-docs/src/types.ts
View File

@ -1,66 +0,0 @@
export interface SectionNameToMarkdownByVersion {
[version: string]: { [sectionName: string]: string };
}
export interface DocsInfoConfig {
id: string;
packageName: string;
type: SupportedDocJson;
displayName: string;
packageUrl: string;
markdownMenu: DocsMenu;
markdownSections: SectionsMap;
sectionNameToMarkdownByVersion: SectionNameToMarkdownByVersion;
contractsByVersionByNetworkId?: ContractsByVersionByNetworkId;
}
export interface DocsMenu {
[sectionName: string]: string[];
}
export interface SectionsMap {
[sectionName: string]: string;
}
// Exception: We don't make the values uppercase because these KindString's need to
// match up those returned by TypeDoc
export enum KindString {
Constructor = 'Constructor',
Property = 'Property',
Method = 'Method',
Interface = 'Interface',
TypeAlias = 'Type alias',
ObjectLiteral = 'Object literal',
Variable = 'Variable',
Function = 'Function',
Enumeration = 'Enumeration',
Class = 'Class',
}
export enum SupportedDocJson {
SolDoc = 'SOL_DOC',
TypeDoc = 'TYPEDOC',
}
export interface ContractsByVersionByNetworkId {
[version: string]: {
[networkName: string]: {
[contractName: string]: string;
};
};
}
export interface AddressByContractName {
[contractName: string]: string;
}
export interface EnumValue {
name: string;
defaultValue?: string;
}
export enum AbiTypes {
Constructor = 'constructor',
Function = 'function',
Event = 'event',
}

10
packages/react-docs/src/utils/constants.ts
View File

@ -1,10 +0,0 @@
import { SupportedDocJson } from '../types';
export const constants = {
TYPES_SECTION_NAME: 'types',
EXTERNAL_EXPORTS_SECTION_NAME: 'external exports',
TYPE_TO_SYNTAX: {
[SupportedDocJson.SolDoc]: 'solidity',
[SupportedDocJson.TypeDoc]: 'typescript',
} as { [supportedDocType: string]: string },
};

14
packages/react-docs/tsconfig.json
View File

@ -1,14 +0,0 @@
{
"extends": "../../tsconfig",
"compilerOptions": {
"outDir": "lib",
"rootDir": "src",
"jsx": "react",
"baseUrl": ".",
"strictNullChecks": false,
"paths": {
"*": ["node_modules/@types/*", "*"]
}
},
"include": ["./src/**/*"]
}

9
packages/react-docs/tslint.json
View File

@ -1,9 +0,0 @@
{
"extends": ["@0x/tslint-config"],
"rules": {
"no-object-literal-type-assertion": false,
"completed-docs": false,
"prefer-function-over-method": false,
"custom-no-magic-numbers": false
}
}

5
packages/website/package.json
View File

@ -26,8 +26,7 @@
"@0x/contract-wrappers": "^9.1.7",
"@0x/json-schemas": "^3.0.11",
"@0x/order-utils": "^8.2.2",
"@0x/react-docs": "^2.0.14",
"@0x/react-shared": "^2.0.14",
"@0x/react-shared": "^2.0.15",
"@0x/subproviders": "^4.1.2",
"@0x/types": "^2.4.1",
"@0x/typescript-typings": "^4.2.4",
@ -78,6 +77,7 @@
"redux-devtools-extension": "^2.13.2",
"rollbar": "^2.4.7",
"semver-sort": "0.0.4",
"semver": "5.5.0",
"styled-components": "^4.1.1",
"thenby": "^1.2.3",
"truffle-contract": "2.0.1",
@ -85,6 +85,7 @@
"xml-js": "^1.6.4"
},
"devDependencies": {
"@0x/tslint-config": "^3.0.1",
"@types/accounting": "^0.4.1",
"@types/blockies": "^0.0.0",
"@types/deep-equal": "^1.0.0",

0
packages/react-docs/src/components/badge.tsx → packages/website/ts/components/documentation/reference/badge.tsx
View File

0
packages/react-docs/src/components/comment.tsx → packages/website/ts/components/documentation/reference/comment.tsx
View File

0
packages/react-docs/src/components/custom_enum.tsx → packages/website/ts/components/documentation/reference/custom_enum.tsx
View File

6
packages/react-docs/src/components/doc_reference.tsx → packages/website/ts/components/documentation/reference/doc_reference.tsx
View File

@ -23,9 +23,9 @@ import * as _ from 'lodash';
import * as React from 'react';
import * as semver from 'semver';
import { DocsInfo } from '../docs_info';
import { AddressByContractName, SupportedDocJson } from '../types';
import { constants } from '../utils/constants';
import { AddressByContractName, SupportedDocJson } from '../../../types';
import { constants } from '../../../utils/constants';
import { DocsInfo } from '../../../utils/docs_info';
import { Badge } from './badge';
import { Comment } from './comment';

2
packages/react-docs/src/components/enum.tsx → packages/website/ts/components/documentation/reference/enum.tsx
View File

@ -1,7 +1,7 @@
import * as _ from 'lodash';
import * as React from 'react';
import { EnumValue } from '../types';
import { EnumValue } from '../../../types';
export interface EnumProps {
values: EnumValue[];

2
packages/react-docs/src/components/event_definition.tsx → packages/website/ts/components/documentation/reference/event_definition.tsx
View File

@ -3,7 +3,7 @@ import { Event, EventArg } from '@0x/types';
import * as _ from 'lodash';
import * as React from 'react';
import { DocsInfo } from '../docs_info';
import { DocsInfo } from '../../../utils/docs_info';
import { Type } from './type';

2
packages/react-docs/src/components/interface.tsx → packages/website/ts/components/documentation/reference/interface.tsx
View File

@ -3,7 +3,7 @@ import * as React from 'react';
import { CustomType, TypeDefinitionByName } from '@0x/types';
import { DocsInfo } from '../docs_info';
import { DocsInfo } from '../../../utils/docs_info';
import { Signature } from './signature';
import { Type } from './type';

4
packages/react-docs/src/components/property_block.tsx → packages/website/ts/components/documentation/reference/property_block.tsx
View File

@ -2,8 +2,8 @@ import { AnchorTitle, HeaderSizes } from '@0x/react-shared';
import { Property, TypeDefinitionByName } from '@0x/types';
import * as React from 'react';
import { DocsInfo } from '../docs_info';
import { constants } from '../utils/constants';
import { constants } from '../../../utils/constants';
import { DocsInfo } from '../../../utils/docs_info';
import { Comment } from './comment';
import { SourceLink } from './source_link';

2
packages/react-docs/src/components/signature.tsx → packages/website/ts/components/documentation/reference/signature.tsx
View File

@ -3,7 +3,7 @@ import * as React from 'react';
import { Parameter, Type as TypeDef, TypeDefinitionByName, TypeParameter } from '@0x/types';
import { DocsInfo } from '../docs_info';
import { DocsInfo } from '../../../utils/docs_info';
import { Type } from './type';

4
packages/react-docs/src/components/signature_block.tsx → packages/website/ts/components/documentation/reference/signature_block.tsx
View File

@ -3,8 +3,8 @@ import { Parameter, SolidityMethod, TypeDefinitionByName, TypescriptFunction, Ty
import * as _ from 'lodash';
import * as React from 'react';
import { DocsInfo } from '../docs_info';
import { constants } from '../utils/constants';
import { constants } from '../../../utils/constants';
import { DocsInfo } from '../../../utils/docs_info';
import { Comment } from './comment';
import { Signature } from './signature';

0
packages/react-docs/src/components/source_link.tsx → packages/website/ts/components/documentation/reference/source_link.tsx
View File

2
packages/react-docs/src/components/type.tsx → packages/website/ts/components/documentation/reference/type.tsx
View File

@ -5,7 +5,7 @@ import * as _ from 'lodash';
import * as React from 'react';
import * as ReactTooltip from 'react-tooltip';
import { DocsInfo } from '../docs_info';
import { DocsInfo } from '../../../utils/docs_info';
import { Signature } from './signature';
import { TypeDefinition } from './type_definition';

6
packages/react-docs/src/components/type_definition.tsx → packages/website/ts/components/documentation/reference/type_definition.tsx
View File

@ -4,9 +4,9 @@ import { errorUtils } from '@0x/utils';
import * as _ from 'lodash';
import * as React from 'react';
import { DocsInfo } from '../docs_info';
import { KindString, SupportedDocJson } from '../types';
import { constants } from '../utils/constants';
import { KindString, SupportedDocJson } from '../../../types';
import { constants } from '../../../utils/constants';
import { DocsInfo } from '../../../utils/docs_info';
import { Comment } from './comment';
import { CustomEnum } from './custom_enum';

3
packages/website/ts/components/top_bar/top_bar.tsx
View File

@ -1,4 +1,3 @@
import { DocsInfo } from '@0x/react-docs';
import { ALink, colors, Link, Styles } from '@0x/react-shared';
import { ObjectMap } from '@0x/types';
import * as _ from 'lodash';
@ -16,6 +15,8 @@ import { Deco, Key, ProviderType, WebsitePaths } from 'ts/types';
import { constants } from 'ts/utils/constants';
import { Translate } from 'ts/utils/translate';
import { DocsInfo } from '../../utils/docs_info';
export enum TopBarDisplayType {
Default,
Expanded,

2
packages/website/ts/containers/asset_buyer_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/connect_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/contract_wrappers_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

5
packages/website/ts/containers/ethereum_types_documentation.ts
View File

@ -1,9 +1,10 @@
import { constants as docConstants, DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { constants } from '../utils/constants';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */
@ -14,7 +15,7 @@ const InstallationMarkdown = require('md/docs/ethereum_types/installation');
const markdownSections = {
introduction: 'introduction',
installation: 'installation',
types: docConstants.TYPES_SECTION_NAME,
types: constants.TYPES_SECTION_NAME,
};
const docsInfoConfig: DocsInfoConfig = {

2
packages/website/ts/containers/json_schemas_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

4
packages/website/ts/containers/migrations_documentation.ts
View File

@ -1,4 +1,3 @@
import { DocsInfo, DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { Dispatch } from 'redux';
@ -8,6 +7,9 @@ import { State } from 'ts/redux/reducer';
import { DocPackages, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { DocsInfo } from '../utils/docs_info';
/* tslint:disable:no-var-requires */
const IntroMarkdown1 = require('md/docs/migrations/1/introduction');
const InstallationMarkdown1 = require('md/docs/migrations/1/installation');

2
packages/website/ts/containers/order_utils_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/order_watcher_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/smart_contracts_documentation.ts
View File

@ -1,10 +1,10 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import { Networks } from '@0x/react-shared';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages, SmartContractDocSections as Sections } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/sol_compiler_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/sol_coverage_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/sol_profiler_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/sol_trace_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/subproviders_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/web3_wrapper_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

2
packages/website/ts/containers/zero_ex_js_documentation.ts
View File

@ -1,9 +1,9 @@
import { DocsInfoConfig, SupportedDocJson } from '@0x/react-docs';
import * as React from 'react';
import { connect } from 'react-redux';
import { DocPage as DocPageComponent, DocPageProps } from 'ts/pages/documentation/doc_page';
import { DocPackages } from 'ts/types';
import { DocsInfoConfig, SupportedDocJson } from '../types';
import { getMapStateToProps, mapDispatchToProps } from '../utils/documentation_container';
/* tslint:disable:no-var-requires */

14
packages/website/ts/pages/documentation/doc_page.tsx
View File

@ -1,11 +1,4 @@
import {
DocAgnosticFormat,
DocReference,
DocsInfo,
GeneratedDocJson,
SupportedDocJson,
TypeDocUtils,
} from '@0x/react-docs';
import { DocAgnosticFormat, GeneratedDocJson } from '@0x/types';
import findVersions from 'find-versions';
import * as _ from 'lodash';
import CircularProgress from 'material-ui/CircularProgress';
@ -22,6 +15,11 @@ import { docUtils } from 'ts/utils/doc_utils';
import { Translate } from 'ts/utils/translate';
import { utils } from 'ts/utils/utils';
import { DocReference } from '../../components/documentation/reference/doc_reference';
import { SupportedDocJson } from '../../types';
import { DocsInfo } from '../../utils/docs_info';
import { TypeDocUtils } from '../../utils/typedoc_utils';
const isDevelopmentOrStaging = utils.isDevelopment() || utils.isStaging();
const ZERO_EX_JS_VERSION_MISSING_TOPLEVEL_PATH = '0.32.4';

67
packages/website/ts/types.ts
View File

@ -776,4 +776,71 @@ export interface TallyInterface {
no?: BigNumber;
blockNumber?: string;
}
export interface SectionNameToMarkdownByVersion {
[version: string]: { [sectionName: string]: string };
}
export interface DocsInfoConfig {
id: string;
packageName: string;
type: SupportedDocJson;
displayName: string;
packageUrl: string;
markdownMenu: DocsMenu;
markdownSections: SectionsMap;
sectionNameToMarkdownByVersion: SectionNameToMarkdownByVersion;
contractsByVersionByNetworkId?: ContractsByVersionByNetworkId;
}
export interface DocsMenu {
[sectionName: string]: string[];
}
export interface SectionsMap {
[sectionName: string]: string;
}
// Exception: We don't make the values uppercase because these KindString's need to
// match up those returned by TypeDoc
export enum KindString {
Constructor = 'Constructor',
Property = 'Property',
Method = 'Method',
Interface = 'Interface',
TypeAlias = 'Type alias',
ObjectLiteral = 'Object literal',
Variable = 'Variable',
Function = 'Function',
Enumeration = 'Enumeration',
Class = 'Class',
}
export enum SupportedDocJson {
SolDoc = 'SOL_DOC',
TypeDoc = 'TYPEDOC',
}
export interface ContractsByVersionByNetworkId {
[version: string]: {
[networkName: string]: {
[contractName: string]: string;
};
};
}
export interface AddressByContractName {
[contractName: string]: string;
}
export interface EnumValue {
name: string;
defaultValue?: string;
}
export enum AbiTypes {
Constructor = 'constructor',
Function = 'function',
Event = 'event',
}
// tslint:disable:max-file-line-count

8
packages/website/ts/utils/constants.ts
View File

@ -2,6 +2,8 @@ import { ALink } from '@0x/react-shared';
import { BigNumber } from '@0x/utils';
import { Key, WebsitePaths } from 'ts/types';
import { SupportedDocJson } from '../types';
const URL_FORUM = 'https://forum.0x.org';
const URL_ZEROEX_CHAT = 'https://discord.gg/d3FTX3M';
@ -132,4 +134,10 @@ export const constants = {
shouldOpenInNewTab: true,
},
] as ALink[],
TYPES_SECTION_NAME: 'types',
EXTERNAL_EXPORTS_SECTION_NAME: 'external exports',
TYPE_TO_SYNTAX: {
[SupportedDocJson.SolDoc]: 'solidity',
[SupportedDocJson.TypeDoc]: 'typescript',
} as { [supportedDocType: string]: string },
};

2
packages/website/ts/utils/doc_utils.ts
View File

@ -1,4 +1,4 @@
import { DocAgnosticFormat, GeneratedDocJson } from '@0x/react-docs';
import { DocAgnosticFormat, GeneratedDocJson } from '@0x/types';
import { fetchAsync, logUtils } from '@0x/utils';
import * as _ from 'lodash';
import { S3FileObject, VersionToFilePath } from 'ts/types';

5
packages/react-docs/src/docs_info.ts → packages/website/ts/utils/docs_info.ts
View File

@ -9,8 +9,9 @@ import {
SectionNameToMarkdownByVersion,
SectionsMap,
SupportedDocJson,
} from './types';
import { constants } from './utils/constants';
} from '../types';
import { constants } from './constants';
export class DocsInfo {
public id: string;

5
packages/website/ts/utils/documentation_container.ts
View File

@ -1,11 +1,12 @@
import { DocsInfo, DocsInfoConfig } from '@0x/react-docs';
import { Dispatch } from 'redux';
import { DocPageProps } from 'ts/pages/documentation/doc_page';
import { Dispatcher } from 'ts/redux/dispatcher';
import { State } from 'ts/redux/reducer';
import { ScreenWidths } from 'ts/types';
import { DocsInfoConfig, ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
import { DocsInfo } from 'ts/utils/docs_info';
export interface ConnectedState {
docsVersion: string;
availableDocVersions: string[];

2
packages/react-docs/src/utils/typedoc_utils.ts → packages/website/ts/utils/typedoc_utils.ts
View File

@ -20,10 +20,10 @@ import {
import { errorUtils } from '@0x/utils';
import * as _ from 'lodash';
import { DocsInfo } from '../docs_info';
import { KindString } from '../types';
import { constants } from './constants';
import { DocsInfo } from './docs_info';
export class TypeDocUtils {
private readonly _typeDocNameOrder: string[];

1
tsconfig.json
View File

@ -50,7 +50,6 @@
{ "path": "./packages/monorepo-scripts" },
{ "path": "./packages/order-utils" },
{ "path": "./packages/order-watcher" },
{ "path": "./packages/react-docs" },
{ "path": "./packages/react-shared" },
{ "path": "./packages/sol-compiler" },
{ "path": "./packages/sol-coverage" },

13
yarn.lock
View File

@ -1726,9 +1726,12 @@
version "0.22.9"
resolved "https://registry.npmjs.org/@types/cheerio/-/cheerio-0.22.9.tgz#b5990152604c2ada749b7f88cab3476f21f39d7b"
"@types/compare-versions@^3.0.0":
version "3.0.0"
resolved "https://registry.yarnpkg.com/@types/compare-versions/-/compare-versions-3.0.0.tgz#4a45dffe0ebbc00d0f2daef8a0e96ffc66cf5955"
"@types/chokidar@^1.7.5":
version "1.7.5"
resolved "https://registry.yarnpkg.com/@types/chokidar/-/chokidar-1.7.5.tgz#1fa78c8803e035bed6d98e6949e514b133b0c9b6"
dependencies:
"@types/events" "*"
"@types/node" "*"
"@types/deep-equal@^1.0.0":
version "1.0.1"
@ -5011,10 +5014,6 @@ compare-func@^1.3.1:
array-ify "^1.0.0"
dot-prop "^3.0.0"
compare-versions@^3.0.1:
version "3.1.0"
resolved "https://registry.yarnpkg.com/compare-versions/-/compare-versions-3.1.0.tgz#43310256a5c555aaed4193c04d8f154cf9c6efd5"
component-classes@^1.2.5:
version "1.2.6"
resolved "https://registry.yarnpkg.com/component-classes/-/component-classes-1.2.6.tgz#c642394c3618a4d8b0b8919efccbbd930e5cd691"