fix(constants): move constants into src and exclude from esdocs

kleros · Apr 13, 2018 · cdc1a34 · cdc1a34
1 parent 3a26eb9
commit cdc1a34
Show file tree

Hide file tree

Showing 22 changed files with 28 additions and 27 deletions.
diff --git 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 → src/constants/arbitrator.js b/constants/arbitrator.js → src/constants/arbitrator.js
diff --git a/constants/contract.js → src/constants/contract.js b/constants/contract.js → src/constants/contract.js
diff --git a/constants/dispute.js → src/constants/dispute.js b/constants/dispute.js → src/constants/dispute.js
diff --git a/constants/error.js → src/constants/error.js b/constants/error.js → src/constants/error.js
diff --git a/constants/eth.js → src/constants/eth.js b/constants/eth.js → src/constants/eth.js
diff --git a/constants/notification.js → src/constants/notification.js b/constants/notification.js → src/constants/notification.js
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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'