From cdc1a347a56dc4432af67133cdb5702a356e29a1 Mon Sep 17 00:00:00 2001 From: satello Date: Thu, 12 Apr 2018 19:40:59 -0700 Subject: [PATCH] fix(constants): move constants into src and exclude from esdocs --- .esdoc.js | 1 + {constants => src/constants}/arbitrator.js | 0 {constants => src/constants}/contract.js | 0 {constants => src/constants}/dispute.js | 0 {constants => src/constants}/error.js | 0 {constants => src/constants}/eth.js | 0 {constants => src/constants}/notification.js | 0 src/contracts/ContractImplementation.js | 2 +- src/contracts/abstractions/Arbitrator.js | 2 +- src/contracts/implementations/PNK/PinakionPOC.js | 4 ++-- src/contracts/implementations/RNG/BlockHashRNG.js | 2 +- .../implementations/arbitrable/ArbitrableTransaction.js | 6 +++--- src/contracts/implementations/arbitrator/KlerosPOC.js | 6 +++--- src/resources/Disputes.js | 4 ++-- src/resources/Notifications.js | 8 ++++---- src/utils/EventListener.js | 2 +- src/utils/StoreProviderWrapper.js | 2 +- src/utils/deployContractAsync.js | 4 ++-- src/utils/isRequired.js | 2 +- tests/integration/EventListener.test.js | 2 +- tests/integration/contracts.test.js | 4 ++-- tests/integration/disputeResolution.test.js | 4 ++-- 22 files changed, 28 insertions(+), 27 deletions(-) rename {constants => src/constants}/arbitrator.js (100%) rename {constants => src/constants}/contract.js (100%) rename {constants => src/constants}/dispute.js (100%) rename {constants => src/constants}/error.js (100%) rename {constants => src/constants}/eth.js (100%) rename {constants => src/constants}/notification.js (100%) diff --git a/.esdoc.js b/.esdoc.js index 543af0f..33f3b67 100644 --- a/.esdoc.js +++ b/.esdoc.js @@ -1,6 +1,7 @@ module.exports = { source: './src', destination: './docs', + excludes: ['constants/'], plugins: [ { name: 'esdoc-standard-plugin' }, { name: 'esdoc-ecmascript-proposal-plugin', option: { all: true } } diff --git a/constants/arbitrator.js b/src/constants/arbitrator.js similarity index 100% rename from constants/arbitrator.js rename to src/constants/arbitrator.js diff --git a/constants/contract.js b/src/constants/contract.js similarity index 100% rename from constants/contract.js rename to src/constants/contract.js diff --git a/constants/dispute.js b/src/constants/dispute.js similarity index 100% rename from constants/dispute.js rename to src/constants/dispute.js diff --git a/constants/error.js b/src/constants/error.js similarity index 100% rename from constants/error.js rename to src/constants/error.js diff --git a/constants/eth.js b/src/constants/eth.js similarity index 100% rename from constants/eth.js rename to src/constants/eth.js diff --git a/constants/notification.js b/src/constants/notification.js similarity index 100% rename from constants/notification.js rename to src/constants/notification.js diff --git a/src/contracts/ContractImplementation.js b/src/contracts/ContractImplementation.js index 02d303d..4dba676 100644 --- a/src/contracts/ContractImplementation.js +++ b/src/contracts/ContractImplementation.js @@ -2,7 +2,7 @@ import contract from 'truffle-contract' import _ from 'lodash' import isRequired from '../utils/isRequired' -import * as errorConstants from '../../constants/error' +import * as errorConstants from '../constants/error' import Web3Wrapper from '../utils/Web3Wrapper' /** diff --git a/src/contracts/abstractions/Arbitrator.js b/src/contracts/abstractions/Arbitrator.js index ae38277..1fefd8d 100644 --- a/src/contracts/abstractions/Arbitrator.js +++ b/src/contracts/abstractions/Arbitrator.js @@ -1,6 +1,6 @@ import _ from 'lodash' -import * as arbitratorConstants from '../../../constants/arbitrator' +import * as arbitratorConstants from '../../constants/arbitrator' import AbstractContract from '../AbstractContract' /** diff --git a/src/contracts/implementations/PNK/PinakionPOC.js b/src/contracts/implementations/PNK/PinakionPOC.js index eb66599..97d709d 100644 --- a/src/contracts/implementations/PNK/PinakionPOC.js +++ b/src/contracts/implementations/PNK/PinakionPOC.js @@ -1,8 +1,8 @@ import PinakionPOCArtifact from 'kleros/build/contracts/PinakionPOC' // FIXME: mock import _ from 'lodash' -import * as ethConstants from '../../../../constants/eth' -import * as errorConstants from '../../../../constants/error' +import * as ethConstants from '../../../constants/eth' +import * as errorConstants from '../../../constants/error' import ContractImplementation from '../../ContractImplementation' import deployContractAsync from '../../../utils/deployContractAsync' diff --git a/src/contracts/implementations/RNG/BlockHashRNG.js b/src/contracts/implementations/RNG/BlockHashRNG.js index fe289c9..de71fb5 100644 --- a/src/contracts/implementations/RNG/BlockHashRNG.js +++ b/src/contracts/implementations/RNG/BlockHashRNG.js @@ -1,7 +1,7 @@ import BlockHashRNGArtifact from 'kleros-interaction/build/contracts/BlockHashRNG' import _ from 'lodash' -import * as ethConstants from '../../../../constants/eth' +import * as ethConstants from '../../../constants/eth' import ContractImplementation from '../../ContractImplementation' import deployContractAsync from '../../../utils/deployContractAsync' diff --git a/src/contracts/implementations/arbitrable/ArbitrableTransaction.js b/src/contracts/implementations/arbitrable/ArbitrableTransaction.js index 7772689..9661ec1 100644 --- a/src/contracts/implementations/arbitrable/ArbitrableTransaction.js +++ b/src/contracts/implementations/arbitrable/ArbitrableTransaction.js @@ -1,9 +1,9 @@ import arbitrableTransactionArtifact from 'kleros-interaction/build/contracts/ArbitrableTransaction' import _ from 'lodash' -import * as ethConstants from '../../../../constants/eth' -import * as contractConstants from '../../../../constants/contract' -import * as errorConstants from '../../../../constants/error' +import * as ethConstants from '../../../constants/eth' +import * as contractConstants from '../../../constants/contract' +import * as errorConstants from '../../../constants/error' import ContractImplementation from '../../ContractImplementation' import deployContractAsync from '../../../utils/deployContractAsync' diff --git a/src/contracts/implementations/arbitrator/KlerosPOC.js b/src/contracts/implementations/arbitrator/KlerosPOC.js index 8975934..d5fad89 100644 --- a/src/contracts/implementations/arbitrator/KlerosPOC.js +++ b/src/contracts/implementations/arbitrator/KlerosPOC.js @@ -1,9 +1,9 @@ import klerosArtifact from 'kleros/build/contracts/KlerosPOC' import _ from 'lodash' -import * as ethConstants from '../../../../constants/eth' -import * as errorConstants from '../../../../constants/error' -import * as arbitratorConstants from '../../../../constants/arbitrator' +import * as ethConstants from '../../../constants/eth' +import * as errorConstants from '../../../constants/error' +import * as arbitratorConstants from '../../../constants/arbitrator' import ContractImplementation from '../../ContractImplementation' import deployContractAsync from '../../../utils/deployContractAsync' diff --git a/src/resources/Disputes.js b/src/resources/Disputes.js index 7fa18c8..27631a4 100644 --- a/src/resources/Disputes.js +++ b/src/resources/Disputes.js @@ -1,7 +1,7 @@ import _ from 'lodash' -import * as arbitratorConstants from '../../constants/arbitrator' -import * as disputeConstants from '../../constants/dispute' +import * as arbitratorConstants from '../constants/arbitrator' +import * as disputeConstants from '../constants/dispute' import isRequired from '../utils/isRequired' /** diff --git a/src/resources/Notifications.js b/src/resources/Notifications.js index 9f8cc79..1547e97 100644 --- a/src/resources/Notifications.js +++ b/src/resources/Notifications.js @@ -1,9 +1,9 @@ import _ from 'lodash' -import * as arbitratorConstants from '../../constants/arbitrator' -import * as notificationConstants from '../../constants/notification' -import * as disputeConstants from '../../constants/dispute' -import { MISSING_STORE_PROVIDER } from '../../constants/error' +import * as arbitratorConstants from '../constants/arbitrator' +import * as notificationConstants from '../constants/notification' +import * as disputeConstants from '../constants/dispute' +import { MISSING_STORE_PROVIDER } from '../constants/error' import isRequired from '../utils/isRequired' /** diff --git a/src/utils/EventListener.js b/src/utils/EventListener.js index ad98745..7000130 100644 --- a/src/utils/EventListener.js +++ b/src/utils/EventListener.js @@ -2,7 +2,7 @@ import _ from 'lodash' import PromiseQueue from '../utils/PromiseQueue' import isRequired from '../utils/isRequired' -import * as errorConstants from '../../constants/error' +import * as errorConstants from '../constants/error' /** * EventListener is used to watch events on the blockchain for a set of contracts. diff --git a/src/utils/StoreProviderWrapper.js b/src/utils/StoreProviderWrapper.js index e386e0e..f3579da 100644 --- a/src/utils/StoreProviderWrapper.js +++ b/src/utils/StoreProviderWrapper.js @@ -1,6 +1,6 @@ import _ from 'lodash' -import * as errorConstants from '../../constants/error' +import * as errorConstants from '../constants/error' import PromiseQueue from './PromiseQueue' diff --git a/src/utils/deployContractAsync.js b/src/utils/deployContractAsync.js index 82f66f3..875de05 100644 --- a/src/utils/deployContractAsync.js +++ b/src/utils/deployContractAsync.js @@ -1,7 +1,7 @@ import contract from 'truffle-contract' -import * as ethConstants from '../../constants/eth' -import { UNABLE_TO_DEPLOY_CONTRACT } from '../../constants/error' +import * as ethConstants from '../constants/eth' +import { UNABLE_TO_DEPLOY_CONTRACT } from '../constants/error' import isRequired from './isRequired' diff --git a/src/utils/isRequired.js b/src/utils/isRequired.js index 51c083e..733abb7 100644 --- a/src/utils/isRequired.js +++ b/src/utils/isRequired.js @@ -1,4 +1,4 @@ -import { MISSING_PARAMETERS } from '../../constants/error' +import { MISSING_PARAMETERS } from '../constants/error' /** * Used as the default parameter for an arguemnt that is considered required. It will diff --git a/tests/integration/EventListener.test.js b/tests/integration/EventListener.test.js index 7433e86..590dd23 100644 --- a/tests/integration/EventListener.test.js +++ b/tests/integration/EventListener.test.js @@ -2,7 +2,7 @@ import Web3 from 'web3' import KlerosPOC from '../../src/contracts/implementations/arbitrator/KlerosPOC' import EventListener from '../../src/utils/EventListener' -import * as ethConstants from '../../constants/eth' +import * as ethConstants from '../../src/constants/eth' import setUpContracts from '../helpers/setUpContracts' import waitNotifications from '../helpers/waitNotifications' import delaySecond from '../helpers/delaySecond' diff --git a/tests/integration/contracts.test.js b/tests/integration/contracts.test.js index 3e9b340..f83b66c 100644 --- a/tests/integration/contracts.test.js +++ b/tests/integration/contracts.test.js @@ -2,8 +2,8 @@ import Web3 from 'web3' import KlerosPOC from '../../src/contracts/implementations/arbitrator/KlerosPOC' import ArbitrableTransaction from '../../src/contracts/implementations/arbitrable/ArbitrableTransaction' -import * as ethConstants from '../../constants/eth' -import * as errorConstants from '../../constants/error' +import * as ethConstants from '../../src/constants/eth' +import * as errorConstants from '../../src/constants/error' import setUpContracts from '../helpers/setUpContracts' import delaySecond from '../helpers/delaySecond' diff --git a/tests/integration/disputeResolution.test.js b/tests/integration/disputeResolution.test.js index a836d18..fc19127 100644 --- a/tests/integration/disputeResolution.test.js +++ b/tests/integration/disputeResolution.test.js @@ -3,8 +3,8 @@ import Web3 from 'web3' import KlerosPOC from '../../src/contracts/implementations/arbitrator/KlerosPOC' import ArbitrableTransaction from '../../src/contracts/implementations/arbitrable/ArbitrableTransaction' import Notifications from '../../src/resources/Notifications' -import * as ethConstants from '../../constants/eth' -import * as notificationConstants from '../../constants/notification' +import * as ethConstants from '../../src/constants/eth' +import * as notificationConstants from '../../src/constants/notification' import setUpContracts from '../helpers/setUpContracts' import delaySecond from '../helpers/delaySecond'