diff options
Diffstat (limited to 'packages/dev-tools-pages/ts/pages/Cov.tsx')
| -rw-r--r-- | packages/dev-tools-pages/ts/pages/Cov.tsx | 186 |
1 files changed, 94 insertions, 92 deletions
diff --git a/packages/dev-tools-pages/ts/pages/Cov.tsx b/packages/dev-tools-pages/ts/pages/Cov.tsx index 1a7abbbb1..3ffa6077d 100644 --- a/packages/dev-tools-pages/ts/pages/Cov.tsx +++ b/packages/dev-tools-pages/ts/pages/Cov.tsx @@ -1,52 +1,56 @@ import * as React from 'react'; -import { render, hydrate } from 'react-dom'; +import { hydrate, render } from 'react-dom'; import * as Loadable from 'react-loadable'; -import context from 'ts/context/cov'; -import Base from 'ts/components/Base'; -import Content from 'ts/components/Content'; -import ContentBlock from 'ts/components/ContentBlock'; -import { Tabs, TabBlock } from 'ts/components/Tabs'; -import Code from 'ts/components/Code'; -import InlineCode from 'ts/components/InlineCode'; +import { context } from 'ts/context/cov'; + +import { Base } from 'ts/components/Base'; +import { Breakout } from 'ts/components/Breakout'; +import { Code } from 'ts/components/Code'; +import { Content } from 'ts/components/Content'; +import { ContentBlock } from 'ts/components/ContentBlock'; +import { Hero } from 'ts/components/Hero'; +import { InlineCode } from 'ts/components/InlineCode'; +import { Intro, IntroAside, IntroLead } from 'ts/components/Intro'; import { List, ListItem } from 'ts/components/List'; -import Breakout from 'ts/components/Breakout'; -import { Intro, IntroLead, IntroAside } from 'ts/components/Intro'; -import Hero from 'ts/components/Hero'; +import { TabBlock, Tabs } from 'ts/components/Tabs'; const Animation = Loadable({ loader: () => System.import(/* webpackChunkName: 'cov-animation' */ 'ts/components/Animations/Cov'), loading: () => <div />, delay: 1000, + render(loadable: { Animation: any }): React.ReactNode { + const Component = loadable.Animation; + return <Component />; + }, }); -function Cov() { - return ( - <Base context={context}> - <Hero> - <Animation /> - </Hero> - <Intro> - <IntroLead title="Measure your tests"> - <p> - When it comes to writing smart contracts, testing is one of the most important steps of the - process. In order to quantify the robustness of your Solidity testing suite, you need to measure - its code coverage. - </p> - </IntroLead> - <IntroAside> - <Code - language="javascript" - diff - gutterLength={2} - gutter={[4, undefined, 4, 4, 4, undefined, 4, 2, 2, 2]} - > - {`+function executeTransaction(uint transactionId) +const Cov: React.StatelessComponent<{}> = () => ( + <Base context={context}> + <Hero> + <Animation /> + </Hero> + <Intro> + <IntroLead title="Measure your tests"> + <p> + When it comes to writing smart contracts, testing is one of the most important steps of the process. + In order to quantify the robustness of your Solidity testing suite, you need to measure its code + coverage. + </p> + </IntroLead> + <IntroAside> + <Code + language="javascript" + isDiff={true} + gutterLength={2} + gutter={[4, undefined, 4, 4, 4, undefined, 4, 2, 2, 2]} + > + {`+function executeTransaction(uint transactionId) public + notExecuted(transactionId) + fullyConfirmed(transactionId) + pastTimeLock(transactionId) -{ +{ + Transaction storage tx = transactions[transactionId] + tx.executed = true + if (tx.destination.call.value(tx.value)(tx.data)) @@ -56,71 +60,70 @@ function Cov() { - tx.executed = false } }`} - </Code> - </IntroAside> - </Intro> + </Code> + </IntroAside> + </Intro> - <Content> - <ContentBlock main title="Get started" /> - <ContentBlock title="Prerequisites"> - <List> - <ListItem> - Use <a href="#">ganache-cli</a> as a backing node. - </ListItem> - <ListItem> - Understand and use <a href="#">web3-provider-engine</a>. - </ListItem> - </List> - </ContentBlock> - <ContentBlock title="Installation"> - <Breakout> - <Code>npm install @0x/sol-cov --save</Code> - </Breakout> + <Content> + <ContentBlock main={true} title="Get started" /> + <ContentBlock title="Prerequisites"> + <List> + <ListItem> + Use <a href="#">ganache-cli</a> as a backing node. + </ListItem> + <ListItem> + Understand and use <a href="#">web3-provider-engine</a>. + </ListItem> + </List> + </ContentBlock> + <ContentBlock title="Installation"> + <Breakout> + <Code>npm install @0x/sol-cov --save</Code> + </Breakout> - <p> - Sol-cov is a subprovider that needs to be prepended to your <a href="#">provider engine</a>. - Depending on your project setup, you will need to use a specific ArtifactAdapter. Sol-cov ships - with the <InlineCode>SolCompilerArtifactAdapter</InlineCode> for use with{' '} - <a href="#">Sol-compiler</a> and <InlineCode>TruffleArtifactAdapter</InlineCode> for use with - the <a href="#">Truffle framework</a>. You can also write your own and support any artifact - format. - </p> + <p> + Sol-cov is a subprovider that needs to be prepended to your <a href="#">provider engine</a>. + Depending on your project setup, you will need to use a specific ArtifactAdapter. Sol-cov ships with + the <InlineCode>SolCompilerArtifactAdapter</InlineCode> for use with <a href="#">Sol-compiler</a>{' '} + and <InlineCode>TruffleArtifactAdapter</InlineCode> for use with the{' '} + <a href="#">Truffle framework</a>. You can also write your own and support any artifact format. + </p> - <Tabs> - <TabBlock title="Sol-compiler"> - <Code language="javascript"> - {`import { SolCompilerArtifactAdapter } from '@0x/sol-trace'; + <Tabs> + <TabBlock title="Sol-compiler"> + <Code language="javascript"> + {`import { SolCompilerArtifactAdapter } from '@0x/sol-trace'; // Both artifactsDir and contractsDir are optional and will be fetched from compiler.json if not passed in const artifactAdapter = new SolCompilerArtifactAdapter(artifactsDir, contractsDir);`} - </Code> - </TabBlock> - <TabBlock title="Truffle"> - <Code language="javascript"> - {`import { TruffleArtifactAdapter } from '@0x/sol-trace'; + </Code> + </TabBlock> + <TabBlock title="Truffle"> + <Code language="javascript"> + {`import { TruffleArtifactAdapter } from '@0x/sol-trace'; const projectRoot = '.'; const solcVersion = '0.4.24'; const artifactAdapter = new TruffleArtifactAdapter(projectRoot, solcVersion);`} - </Code> - </TabBlock> - <TabBlock title="Custom"> - <Code language="javascript"> - {`import { AbstractArtifactAdapter } from '@0x/sol-trace'; + </Code> + </TabBlock> + <TabBlock title="Custom"> + <Code language="javascript"> + {`import { AbstractArtifactAdapter } from '@0x/sol-trace'; class YourCustomArtifactsAdapter extends AbstractArtifactAdapter {...}; const artifactAdapter = new YourCustomArtifactsAdapter(...);`} - </Code> - </TabBlock> - </Tabs> - <p> - Now that we have an <InlineCode>artifactAdapter</InlineCode>, we can create a{' '} - <InlineCode>RevertTraceSubprovider</InlineCode> and append it to our provider engine. - </p> + </Code> + </TabBlock> + </Tabs> + <p> + Now that we have an <InlineCode>artifactAdapter</InlineCode>, we can create a{' '} + <InlineCode>RevertTraceSubprovider</InlineCode> and append it to our provider engine. + </p> - <Breakout> - <Code language="javascript"> - {`import { ProviderEngine, RpcSubprovider } from 'web3-provider-engine'; + <Breakout> + <Code language="javascript"> + {`import { ProviderEngine, RpcSubprovider } from 'web3-provider-engine'; import { RevertTraceSubprovider } from '@0x/sol-cov'; const defaultFromAddress = "..."; // Some ethereum address with test funds @@ -130,13 +133,12 @@ const providerEngine = new ProviderEngine(); providerEngine.addProvider(revertTraceSubprovider); providerEngine.addProvider(new RpcSubprovider({rpcUrl: 'http://localhost:8545'})); providerEngine.start();`} - </Code> - </Breakout> - </ContentBlock> - </Content> - </Base> - ); -} + </Code> + </Breakout> + </ContentBlock> + </Content> + </Base> +); const root = document.getElementById('app'); |