From f4a2e227e1a7224fbbe9c99d9aa033d176a9c4de Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Sun, 29 Jul 2018 21:58:39 +0200 Subject: Remove all in-package monorepo-scripts by adding doc gen/upload and aggregate release note publishing to publish script --- packages/sol-cov/src/monorepo_scripts/postpublish.ts | 8 -------- packages/sol-cov/src/monorepo_scripts/stage_docs.ts | 8 -------- 2 files changed, 16 deletions(-) delete mode 100644 packages/sol-cov/src/monorepo_scripts/postpublish.ts delete mode 100644 packages/sol-cov/src/monorepo_scripts/stage_docs.ts (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/monorepo_scripts/postpublish.ts b/packages/sol-cov/src/monorepo_scripts/postpublish.ts deleted file mode 100644 index dcb99d0f7..000000000 --- a/packages/sol-cov/src/monorepo_scripts/postpublish.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { postpublishUtils } from '@0xproject/monorepo-scripts'; - -import * as packageJSON from '../package.json'; -import * as tsConfigJSON from '../tsconfig.json'; - -const cwd = `${__dirname}/..`; -// tslint:disable-next-line:no-floating-promises -postpublishUtils.runAsync(packageJSON, tsConfigJSON, cwd); diff --git a/packages/sol-cov/src/monorepo_scripts/stage_docs.ts b/packages/sol-cov/src/monorepo_scripts/stage_docs.ts deleted file mode 100644 index e732ac8eb..000000000 --- a/packages/sol-cov/src/monorepo_scripts/stage_docs.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { postpublishUtils } from '@0xproject/monorepo-scripts'; - -import * as packageJSON from '../package.json'; -import * as tsConfigJSON from '../tsconfig.json'; - -const cwd = `${__dirname}/..`; -// tslint:disable-next-line:no-floating-promises -postpublishUtils.publishDocsToStagingAsync(packageJSON, tsConfigJSON, cwd); -- cgit v1.2.3 From 4579e1637d9f4d0d7badb23336af6785330c6ecc Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Sun, 29 Jul 2018 21:59:09 +0200 Subject: Add missing exports discovered by generating compact typedoc JSON --- packages/sol-cov/src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/index.ts b/packages/sol-cov/src/index.ts index 003a27374..0e70878ad 100644 --- a/packages/sol-cov/src/index.ts +++ b/packages/sol-cov/src/index.ts @@ -5,4 +5,4 @@ export { RevertTraceSubprovider } from './revert_trace_subprovider'; export { SolCompilerArtifactAdapter } from './artifact_adapters/sol_compiler_artifact_adapter'; export { TruffleArtifactAdapter } from './artifact_adapters/truffle_artifact_adapter'; export { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_adapter'; -export { ContractData } from './types'; +export { ContractData, TraceInfo, Subtrace, SourceRange, Coverage } from './types'; -- cgit v1.2.3 From 13520dbd94831cd93e419d000e933bfb75c99e84 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 3 Aug 2018 13:02:29 +0200 Subject: Add missing types to sol-cov index.ts --- packages/sol-cov/src/index.ts | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/index.ts b/packages/sol-cov/src/index.ts index 0e70878ad..35135c295 100644 --- a/packages/sol-cov/src/index.ts +++ b/packages/sol-cov/src/index.ts @@ -5,4 +5,15 @@ export { RevertTraceSubprovider } from './revert_trace_subprovider'; export { SolCompilerArtifactAdapter } from './artifact_adapters/sol_compiler_artifact_adapter'; export { TruffleArtifactAdapter } from './artifact_adapters/truffle_artifact_adapter'; export { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_adapter'; -export { ContractData, TraceInfo, Subtrace, SourceRange, Coverage } from './types'; +export { + ContractData, + TraceInfo, + Subtrace, + SourceRange, + Coverage, + TraceInfoNewContract, + TraceInfoExistingContract, + SingleFileSourceRange, +} from './types'; +export { StructLog, JSONRPCRequestPayload, Provider } from 'ethereum-types'; +export { ErrorCallback, NextCallback } from '@0xproject/subproviders'; -- cgit v1.2.3 From 3ee3fc2fb35b5ecc8237363d6307b7135ed4f927 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 3 Aug 2018 17:13:10 +0200 Subject: Add missing doc comments --- packages/sol-cov/src/trace_collection_subprovider.ts | 1 + 1 file changed, 1 insertion(+) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/trace_collection_subprovider.ts b/packages/sol-cov/src/trace_collection_subprovider.ts index b530b59db..5a101dfeb 100644 --- a/packages/sol-cov/src/trace_collection_subprovider.ts +++ b/packages/sol-cov/src/trace_collection_subprovider.ts @@ -109,6 +109,7 @@ export abstract class TraceCollectionSubprovider extends Subprovider { * Set's the subprovider's engine to the ProviderEngine it is added to. * This is only called within the ProviderEngine source code, do not call * directly. + * @param engine The ProviderEngine this subprovider is added to */ public setEngine(engine: Provider): void { super.setEngine(engine); -- cgit v1.2.3 From c68e1839535e0eeb7c66e8712d1ce786d0f964df Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 3 Aug 2018 22:36:44 +0200 Subject: Add missing sol-cov comments --- .../sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts | 5 +++++ packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts | 5 +++++ packages/sol-cov/src/trace_collection_subprovider.ts | 2 +- 3 files changed, 11 insertions(+), 1 deletion(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts b/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts index 8e03bf7fd..0601c5729 100644 --- a/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts +++ b/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts @@ -14,6 +14,11 @@ const CONFIG_FILE = 'compiler.json'; export class SolCompilerArtifactAdapter extends AbstractArtifactAdapter { private readonly _artifactsPath: string; private readonly _sourcesPath: string; + /** + * Instantiates a SolCompilerArtifactAdapter + * @param artifactsPath Path to your artifacts directory + * @param sourcesPath Path to your contract sources directory + */ constructor(artifactsPath?: string, sourcesPath?: string) { super(); const config: CompilerOptions = fs.existsSync(CONFIG_FILE) diff --git a/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts b/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts index 53b77aed5..2f76f730a 100644 --- a/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts +++ b/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts @@ -9,6 +9,11 @@ import { SolCompilerArtifactAdapter } from './sol_compiler_artifact_adapter'; export class TruffleArtifactAdapter extends AbstractArtifactAdapter { private readonly _solcVersion: string; private readonly _sourcesPath: string; + /** + * Instantiates a TruffleArtifactAdapter + * @param artifactsPath Path to the truffle project's artifacts directory + * @param sourcesPath Path to the truffle project's contract sources directory + */ constructor(sourcesPath: string, solcVersion: string) { super(); this._solcVersion = solcVersion; diff --git a/packages/sol-cov/src/trace_collection_subprovider.ts b/packages/sol-cov/src/trace_collection_subprovider.ts index 5a101dfeb..91c21fe94 100644 --- a/packages/sol-cov/src/trace_collection_subprovider.ts +++ b/packages/sol-cov/src/trace_collection_subprovider.ts @@ -63,7 +63,7 @@ export abstract class TraceCollectionSubprovider extends Subprovider { * turn to handle a JSON RPC request. * @param payload JSON RPC payload * @param next Callback to call if this subprovider decides not to handle the request - * @param end Callback to call if subprovider handled the request and wants to pass back the request. + * @param _end Callback to call if subprovider handled the request and wants to pass back the request. */ // tslint:disable-next-line:prefer-function-over-method async-suffix public async handleRequest(payload: JSONRPCRequestPayload, next: NextCallback, _end: ErrorCallback): Promise { -- cgit v1.2.3 From 6df874687150be40d5e93d7d8c0e3e191ea08982 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 3 Aug 2018 22:37:02 +0200 Subject: Omit certain exports and re-org index.ts --- packages/sol-cov/src/index.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/index.ts b/packages/sol-cov/src/index.ts index 35135c295..dd102a13b 100644 --- a/packages/sol-cov/src/index.ts +++ b/packages/sol-cov/src/index.ts @@ -1,10 +1,12 @@ export { CoverageSubprovider } from './coverage_subprovider'; -// HACK: ProfilerSubprovider is a hacky way to do profiling using coverage tools. Not production ready -export { ProfilerSubprovider } from './profiler_subprovider'; -export { RevertTraceSubprovider } from './revert_trace_subprovider'; export { SolCompilerArtifactAdapter } from './artifact_adapters/sol_compiler_artifact_adapter'; export { TruffleArtifactAdapter } from './artifact_adapters/truffle_artifact_adapter'; export { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_adapter'; + +// HACK: ProfilerSubprovider is a hacky way to do profiling using coverage tools. Not production ready +export { ProfilerSubprovider } from './profiler_subprovider'; +export { RevertTraceSubprovider } from './revert_trace_subprovider'; + export { ContractData, TraceInfo, -- cgit v1.2.3 From 4d75689790075f734df9a2e3b80443c85e1ddc95 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Fri, 3 Aug 2018 22:42:17 +0200 Subject: Fix commebt --- packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts b/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts index 2f76f730a..dc6807cd6 100644 --- a/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts +++ b/packages/sol-cov/src/artifact_adapters/truffle_artifact_adapter.ts @@ -12,7 +12,7 @@ export class TruffleArtifactAdapter extends AbstractArtifactAdapter { /** * Instantiates a TruffleArtifactAdapter * @param artifactsPath Path to the truffle project's artifacts directory - * @param sourcesPath Path to the truffle project's contract sources directory + * @param solcVersion Solidity version with which to compile all the contracts */ constructor(sourcesPath: string, solcVersion: string) { super(); -- cgit v1.2.3 From cc90c806b09a83330c20816d1e7756f5c74e33d0 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Tue, 21 Aug 2018 17:16:42 +0100 Subject: Fix sol-cov index.ts --- packages/sol-cov/src/index.ts | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/index.ts b/packages/sol-cov/src/index.ts index dd102a13b..cb9e108fb 100644 --- a/packages/sol-cov/src/index.ts +++ b/packages/sol-cov/src/index.ts @@ -7,15 +7,14 @@ export { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_a export { ProfilerSubprovider } from './profiler_subprovider'; export { RevertTraceSubprovider } from './revert_trace_subprovider'; +export { ContractData, TraceInfo, Subtrace, TraceInfoNewContract, TraceInfoExistingContract } from './types'; export { - ContractData, - TraceInfo, - Subtrace, - SourceRange, - Coverage, - TraceInfoNewContract, - TraceInfoExistingContract, - SingleFileSourceRange, -} from './types'; -export { StructLog, JSONRPCRequestPayload, Provider } from 'ethereum-types'; -export { ErrorCallback, NextCallback } from '@0xproject/subproviders'; + StructLog, + JSONRPCRequestPayload, + Provider, + JSONRPCErrorCallback, + OpCode, + JSONRPCResponsePayload, +} from 'ethereum-types'; + +export { JSONRPCRequestPayloadWithMethod } from '@0xproject/subproviders'; -- cgit v1.2.3 From 301cb296ec77e8af5c1722679e04cb983c848153 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Tue, 21 Aug 2018 23:58:06 +0100 Subject: Move types from sol-compiler to types so they can be used in other places without requiring sol-compiler as a dep --- packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts b/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts index 0601c5729..8a74022bf 100644 --- a/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts +++ b/packages/sol-cov/src/artifact_adapters/sol_compiler_artifact_adapter.ts @@ -1,5 +1,5 @@ -import { CompilerOptions, ContractArtifact } from '@0xproject/sol-compiler'; import { logUtils } from '@0xproject/utils'; +import { CompilerOptions, ContractArtifact } from 'ethereum-types'; import * as fs from 'fs'; import * as glob from 'glob'; import * as _ from 'lodash'; -- cgit v1.2.3 From 22de88035c35731f0a93fc0acb87c185c1e2730c Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Wed, 22 Aug 2018 11:28:31 +0100 Subject: Fix index.ts given fix in doc generation --- packages/sol-cov/src/index.ts | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) (limited to 'packages/sol-cov/src') diff --git a/packages/sol-cov/src/index.ts b/packages/sol-cov/src/index.ts index cb9e108fb..15be86a9d 100644 --- a/packages/sol-cov/src/index.ts +++ b/packages/sol-cov/src/index.ts @@ -7,14 +7,13 @@ export { AbstractArtifactAdapter } from './artifact_adapters/abstract_artifact_a export { ProfilerSubprovider } from './profiler_subprovider'; export { RevertTraceSubprovider } from './revert_trace_subprovider'; -export { ContractData, TraceInfo, Subtrace, TraceInfoNewContract, TraceInfoExistingContract } from './types'; -export { - StructLog, - JSONRPCRequestPayload, - Provider, - JSONRPCErrorCallback, - OpCode, - JSONRPCResponsePayload, -} from 'ethereum-types'; +export { ContractData } from './types'; +export { JSONRPCRequestPayload, Provider, JSONRPCErrorCallback, JSONRPCResponsePayload } from 'ethereum-types'; -export { JSONRPCRequestPayloadWithMethod } from '@0xproject/subproviders'; +export { + JSONRPCRequestPayloadWithMethod, + NextCallback, + ErrorCallback, + OnNextCompleted, + Callback, +} from '@0xproject/subproviders'; -- cgit v1.2.3