From 9ad73107da43866a831828250e67207059ecd86b Mon Sep 17 00:00:00 2001 From: Anthony Akentiev Date: Wed, 22 Aug 2018 17:09:09 +0300 Subject: [PATCH 1/4] Bump version --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index a01f971..344ba82 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@thetta/core", - "version": "1.3.3", + "version": "1.3.4", "description": "Thetta Decentralized Autonomous Organizations framework core", "main": "truffle.js", "scripts": { From b5059b1199da38de603be1df1ad7c038be79c562 Mon Sep 17 00:00:00 2001 From: Rostyslav Bortman Date: Thu, 23 Aug 2018 18:00:07 +0300 Subject: [PATCH 2/4] ENSF notation - add solidity-docgen #310 --- docs/website/sidebars.json | 91 ++++++++++++++++++++++++++++++++++++++ package.json | 21 +++++---- scripts/gen-docs.js | 2 + scripts/gen-docs.sh | 1 + 4 files changed, 107 insertions(+), 8 deletions(-) create mode 100644 docs/website/sidebars.json create mode 100755 scripts/gen-docs.js create mode 100755 scripts/gen-docs.sh diff --git a/docs/website/sidebars.json b/docs/website/sidebars.json new file mode 100644 index 0000000..039d395 --- /dev/null +++ b/docs/website/sidebars.json @@ -0,0 +1,91 @@ +{ + "docs": { + "Docusaurus": [ + "doc1" + ], + "First Category": [ + "doc2" + ], + "Second Category": [ + "doc3" + ] + }, + "docs-other": { + "First Category": [ + "doc4", + "doc5" + ] + }, + "docs-api": { + "GOVERNANCE": [ + "governance_GenericProposal", + "governance_IDelegationTable", + "governance_IProposal", + "governance_IVoting", + "governance_InformalProposal", + "governance_Voting", + "governance_VotingLib" + ], + "ICO": [ + "ICO_SimpleICO" + ], + "MOCK": [ + "mock_DaoBaseMock", + "mock_DaoBaseWithUnpackersMock" + ], + "MONEYFLOW": [ + "moneyflow_DefaultMoneyflowScheme", + "moneyflow_DefaultMoneyflowSchemeWithUnpackers", + "moneyflow_FallbackToWeiReceiver", + "moneyflow_IDestination", + "moneyflow_IErc20Receiver", + "moneyflow_IMoneyflow", + "moneyflow_IReceiver", + "moneyflow_ISplitter", + "moneyflow_IWeiReceiver", + "moneyflow_MoneflowTable_MoneyflowTable", + "moneyflow_MoneyflowAuto", + "moneyflow_Moneyflow_MoneyFlow" + ], + "MONEYFLOW / ETHER": [ + "moneyflow_ether_SplitterBase", + "moneyflow_ether_WeiAbsoluteExpense", + "moneyflow_ether_WeiAbsoluteExpenseWithPeriod", + "moneyflow_ether_WeiExpense", + "moneyflow_ether_WeiFund", + "moneyflow_ether_WeiRelativeExpense", + "moneyflow_ether_WeiRelativeExpenseWithPeriod", + "moneyflow_ether_WeiTopDownSplitter", + "moneyflow_ether_WeiUnsortedSplitter" + ], + "TASKS": [ + "tasks_TaskTable", + "tasks_WeiBounty", + "tasks_WeiGenericTask", + "tasks_WeiTask" + ], + "TOKENS": [ + "tokens_CopyOnWriteToken", + "tokens_ITokenVotingSupport", + "tokens_StdDaoToken" + ], + "UTILS": [ + "utils_GenericCaller", + "utils_GenericCallerLib", + "utils_UtilsLib" + ], + "UNCATEGORIZED": [ + "DaoBase", + "DaoBaseAuto", + "DaoBaseImpersonated", + "DaoBaseLib", + "DaoBaseWithUnpackers", + "DaoClient", + "DaoStorage", + "IDaoBase", + "IDaoObserver", + "ImpersonationCaller", + "Migrations" + ] + } +} \ No newline at end of file diff --git a/package.json b/package.json index ffe5131..08f6d64 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,8 @@ "lint:sol": "solium -d .", "lint:sol:fix": "solium -d . --fix", "lint:all": "npm run lint && npm run lint:sol", - "lint:all:fix": "npm run lint:fix && npm run lint:sol:fix" + "lint:all:fix": "npm run lint:fix && npm run lint:sol:fix", + "docs": "cd scripts && node ./gen-docs.js" }, "repository": { "type": "git", @@ -27,24 +28,28 @@ }, "homepage": "https://web.thetta.io", "dependencies": { - "babel-eslint": "^8.2.3", + "babel-eslint": "^8.2.6", "babel-polyfill": "^6.26.0", "babel-register": "^6.26.0", "chai": "4.1.2", "chai-as-promised": "7.1.1", "chai-bignumber": "2.0.2", "coveralls": "^3.0.2", - "eslint": "^5.2.0", + "docusaurus-init": "^1.0.2", + "eslint": "^5.4.0", "eslint-config-standard": "^10.2.1", - "eslint-plugin-import": "^2.13.0", + "eslint-plugin-import": "^2.14.0", "eslint-plugin-node": "^5.2.1", "eslint-plugin-promise": "^3.8.0", "eslint-plugin-standard": "^3.1.0", "eth-gas-reporter": "^0.1.10", - "ganache-cli": "^6.1.3", - "growl": "^1.10.0", - "solidity-coverage": "^0.5.5", - "solium": "^1.1.7", + "ganache-cli": "^6.1.8", + "growl": "^1.10.5", + "install": "^0.12.1", + "solc": "^0.4.24", + "solidity-coverage": "^0.5.7", + "solidity-docgen": "^0.1.0", + "solium": "^1.1.8", "truffle": "^4.1.14", "zeppelin-solidity": "^1.12.0" } diff --git a/scripts/gen-docs.js b/scripts/gen-docs.js new file mode 100755 index 0000000..e343aec --- /dev/null +++ b/scripts/gen-docs.js @@ -0,0 +1,2 @@ +const { spawn } = require('child_process'); +spawn('./gen-docs.sh', ["zeppelin-solidity=" +__dirname.slice(0, -8) + "/node_modules/zeppelin-solidity"]); diff --git a/scripts/gen-docs.sh b/scripts/gen-docs.sh new file mode 100755 index 0000000..20bbf67 --- /dev/null +++ b/scripts/gen-docs.sh @@ -0,0 +1 @@ +SOLC_ARGS=$1 solidity-docgen ../ ../contracts ../docs \ No newline at end of file From 456eee411ca2eb4e3ae88954c66247cd4508c229 Mon Sep 17 00:00:00 2001 From: Rostyslav Bortman Date: Mon, 27 Aug 2018 17:33:26 +0300 Subject: [PATCH 3/4] delete sidebars.json and docs package --- docs/website/sidebars.json | 91 -------------------------------------- package.json | 2 +- 2 files changed, 1 insertion(+), 92 deletions(-) delete mode 100644 docs/website/sidebars.json diff --git a/docs/website/sidebars.json b/docs/website/sidebars.json deleted file mode 100644 index 039d395..0000000 --- a/docs/website/sidebars.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "docs": { - "Docusaurus": [ - "doc1" - ], - "First Category": [ - "doc2" - ], - "Second Category": [ - "doc3" - ] - }, - "docs-other": { - "First Category": [ - "doc4", - "doc5" - ] - }, - "docs-api": { - "GOVERNANCE": [ - "governance_GenericProposal", - "governance_IDelegationTable", - "governance_IProposal", - "governance_IVoting", - "governance_InformalProposal", - "governance_Voting", - "governance_VotingLib" - ], - "ICO": [ - "ICO_SimpleICO" - ], - "MOCK": [ - "mock_DaoBaseMock", - "mock_DaoBaseWithUnpackersMock" - ], - "MONEYFLOW": [ - "moneyflow_DefaultMoneyflowScheme", - "moneyflow_DefaultMoneyflowSchemeWithUnpackers", - "moneyflow_FallbackToWeiReceiver", - "moneyflow_IDestination", - "moneyflow_IErc20Receiver", - "moneyflow_IMoneyflow", - "moneyflow_IReceiver", - "moneyflow_ISplitter", - "moneyflow_IWeiReceiver", - "moneyflow_MoneflowTable_MoneyflowTable", - "moneyflow_MoneyflowAuto", - "moneyflow_Moneyflow_MoneyFlow" - ], - "MONEYFLOW / ETHER": [ - "moneyflow_ether_SplitterBase", - "moneyflow_ether_WeiAbsoluteExpense", - "moneyflow_ether_WeiAbsoluteExpenseWithPeriod", - "moneyflow_ether_WeiExpense", - "moneyflow_ether_WeiFund", - "moneyflow_ether_WeiRelativeExpense", - "moneyflow_ether_WeiRelativeExpenseWithPeriod", - "moneyflow_ether_WeiTopDownSplitter", - "moneyflow_ether_WeiUnsortedSplitter" - ], - "TASKS": [ - "tasks_TaskTable", - "tasks_WeiBounty", - "tasks_WeiGenericTask", - "tasks_WeiTask" - ], - "TOKENS": [ - "tokens_CopyOnWriteToken", - "tokens_ITokenVotingSupport", - "tokens_StdDaoToken" - ], - "UTILS": [ - "utils_GenericCaller", - "utils_GenericCallerLib", - "utils_UtilsLib" - ], - "UNCATEGORIZED": [ - "DaoBase", - "DaoBaseAuto", - "DaoBaseImpersonated", - "DaoBaseLib", - "DaoBaseWithUnpackers", - "DaoClient", - "DaoStorage", - "IDaoBase", - "IDaoObserver", - "ImpersonationCaller", - "Migrations" - ] - } -} \ No newline at end of file diff --git a/package.json b/package.json index 08f6d64..fe94ae7 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "lint:sol:fix": "solium -d . --fix", "lint:all": "npm run lint && npm run lint:sol", "lint:all:fix": "npm run lint:fix && npm run lint:sol:fix", - "docs": "cd scripts && node ./gen-docs.js" + "docs": "npx docusaurus-init && mv docs-examples-from-docusaurus docs && cd docs && mkdir docs && cd .. && mv ./website ./docs && cd docs && rm -r doc1.md && rm -r doc2.md && rm -r doc3.md && rm -r exampledoc4.md && rm -r exampledoc5.md && cd .. && cd scripts && node ./gen-docs.js" }, "repository": { "type": "git", From ef2e674f55e6db10db752a400f0b4cd5469c67eb Mon Sep 17 00:00:00 2001 From: Rostyslav Bortman Date: Mon, 27 Aug 2018 18:13:32 +0300 Subject: [PATCH 4/4] change script in package.json --- package.json | 2 +- scripts/gen-docs.sh | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index fe94ae7..92aa58f 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "lint:sol:fix": "solium -d . --fix", "lint:all": "npm run lint && npm run lint:sol", "lint:all:fix": "npm run lint:fix && npm run lint:sol:fix", - "docs": "npx docusaurus-init && mv docs-examples-from-docusaurus docs && cd docs && mkdir docs && cd .. && mv ./website ./docs && cd docs && rm -r doc1.md && rm -r doc2.md && rm -r doc3.md && rm -r exampledoc4.md && rm -r exampledoc5.md && cd .. && cd scripts && node ./gen-docs.js" + "docs": "npx docusaurus-init && cd scripts && node ./gen-docs.js" }, "repository": { "type": "git", diff --git a/scripts/gen-docs.sh b/scripts/gen-docs.sh index 20bbf67..6951685 100755 --- a/scripts/gen-docs.sh +++ b/scripts/gen-docs.sh @@ -1 +1,16 @@ + +cd .. +mv docs-examples-from-docusaurus docs +cd docs +mkdir docs +cd .. +mv ./website ./docs +cd docs +rm -r doc1.md +rm -r doc2.md +rm -r doc3.md +rm -r exampledoc4.md +rm -r exampledoc5.md +cd .. +cd scripts SOLC_ARGS=$1 solidity-docgen ../ ../contracts ../docs \ No newline at end of file