diff options
Diffstat (limited to 'packages/react-docs-example')
-rw-r--r-- | packages/react-docs-example/README.md | 14 | ||||
-rw-r--r-- | packages/react-docs-example/package.json | 5 | ||||
-rw-r--r-- | packages/react-docs-example/ts/docs.tsx | 6 |
3 files changed, 18 insertions, 7 deletions
diff --git a/packages/react-docs-example/README.md b/packages/react-docs-example/README.md index ff821dba8..c7dfcd3aa 100644 --- a/packages/react-docs-example/README.md +++ b/packages/react-docs-example/README.md @@ -25,7 +25,7 @@ yarn install The **first** time you work with this package, you must build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory: ```bash -yarn lerna:rebuild +PKG=0x.js yarn build ``` Note: If you move this package out of the monorepo, it will work without this step. Make sure you copy it out on the `master` branch since the `development` version might rely on not-yet published changes to other packages. @@ -35,7 +35,7 @@ Note: If you move this package out of the monorepo, it will work without this st The the `react-docs-example` root directory, run: ```bash -yarn dev +PKG=0x.js yarn watch ``` ### Deploy Example to S3 bucket @@ -50,8 +50,16 @@ yarn deploy_example ### Build +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=@0xproject/react-docs-example yarn build +``` + +Or continuously rebuild on change: + ```bash -yarn build +PKG=@0xproject/react-docs-example yarn watch ``` ### Clean diff --git a/packages/react-docs-example/package.json b/packages/react-docs-example/package.json index b6b6c6c7d..4c26dd3bd 100644 --- a/packages/react-docs-example/package.json +++ b/packages/react-docs-example/package.json @@ -2,12 +2,15 @@ "private": true, "name": "@0xproject/react-docs-example", "version": "0.0.11", + "engines": { + "node" : ">=6.12" + }, "description": "An example app using react-docs", "scripts": { "lint": "tslint --project .", "build": "tsc", "build:example": "NODE_ENV=production webpack", - "build:watch": "tsc -w", + "watch": "tsc -w", "clean": "shx rm -rf lib; shx rm -f public/bundle*", "dev": "webpack-dev-server --open", "deploy_example": "npm run build:example; aws s3 sync ./public/. s3://react-docs-example --profile 0xproject --region us-east-1 --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers" diff --git a/packages/react-docs-example/ts/docs.tsx b/packages/react-docs-example/ts/docs.tsx index eef331813..b35e9a629 100644 --- a/packages/react-docs-example/ts/docs.tsx +++ b/packages/react-docs-example/ts/docs.tsx @@ -94,7 +94,7 @@ export class Docs extends React.Component<DocsProps, DocsState> { docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(v2TypeDocJson), }; } - public render() { + public render(): React.ReactNode { const menuSubsectionsBySection = _.isUndefined(this.state.docAgnosticFormat) ? {} : docsInfo.getMenuSubsectionsBySection(this.state.docAgnosticFormat); @@ -109,14 +109,14 @@ export class Docs extends React.Component<DocsProps, DocsState> { /> ); } - private _onVersionSelected(semver: string) { + private _onVersionSelected(semver: string): void { const selectedDocJSON = versionToDocJSON[semver]; this.setState({ selectedVersion: semver, docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(selectedDocJSON as TypeDocNode), }); } - private _getSourceUrl() { + private _getSourceUrl(): string { const sourceUrl = `${docsInfoConfig.packageUrl}/blob/@0xproject/web3-wrapper@${ this.state.selectedVersion }/packages`; |