diff options
| author | F. Eugene Aumson <feuGeneA@users.noreply.github.com> | 2018-09-26 22:15:53 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-26 22:15:53 +0800 |
| commit | 30525d15f468dc084f923b280b265cb8d5fd4975 (patch) | |
| tree | 35d941998132e83e5f5b830bbe59167f404d6e42 /packages/sol-doc/package.json | |
| parent | c429409ed7a77a67368850f2e736126da0d213dd (diff) | |
| parent | 2bdaa58d71fb1e62fd07e6bf1be56d841446090b (diff) | |
| download | dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.gz dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.bz2 dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.lz dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.xz dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.tar.zst dexon-sol-tools-30525d15f468dc084f923b280b265cb8d5fd4975.zip | |
Merge pull request #1004 from feuGeneA/sol-doc
[ethereum-types, react-docs, sol-compiler, sol-doc, types, typescript-typings, website] Add new Solidity documentation generation utility
Diffstat (limited to 'packages/sol-doc/package.json')
| -rw-r--r-- | packages/sol-doc/package.json | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/packages/sol-doc/package.json b/packages/sol-doc/package.json new file mode 100644 index 000000000..618cb7ef7 --- /dev/null +++ b/packages/sol-doc/package.json @@ -0,0 +1,49 @@ +{ + "name": "@0xproject/sol-doc", + "version": "1.0.0", + "description": "Solidity documentation generator", + "main": "lib/src/index.js", + "types": "lib/src/index.d.js", + "scripts": { + "build": "tsc", + "test": "mocha --require source-map-support/register --require make-promises-safe lib/test/**/*_test.js --timeout 6000 --exit", + "test:circleci": "yarn test:coverage", + "test:coverage": "nyc npm run test --all && yarn coverage:report:lcov", + "coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info", + "lint": "tslint --project . --format stylish", + "clean": "shx rm -rf lib", + "generate-v1-protocol-docs": "(cd ../contracts/src/1.0.0; node ../../../../node_modules/.bin/sol-doc --contracts-dir . --contracts Exchange/Exchange_v1.sol TokenRegistry/TokenRegistry.sol TokenTransferProxy/TokenTransferProxy_v1.sol) > v1.0.0.json", + "generate-v2-protocol-docs": "(cd ../contracts/src/2.0.0; node ../../../../node_modules/.bin/sol-doc --contracts-dir . --contracts $(cd protocol; ls -C1 */*.sol */interfaces/*.sol) ) > v2.0.0.json", + "deploy-v2-protocol-docs": "aws --profile 0xproject s3 cp --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json v2.0.0.json s3://staging-doc-jsons/contracts/", + "deploy-v1-protocol-docs": "aws --profile 0xproject s3 cp --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json v1.0.0.json s3://staging-doc-jsons/contracts/" + }, + "bin": { + "sol-doc": "bin/sol-doc.js" + }, + "repository": "https://github.com/0xProject/0x-monorepo.git", + "author": "F. Eugene Aumson", + "license": "Apache-2.0", + "dependencies": { + "@0xproject/sol-compiler": "^1.1.5", + "@0xproject/types": "^1.1.1", + "@0xproject/utils": "^1.0.11", + "ethereum-types": "^1.0.4", + "lodash": "^4.17.10", + "yargs": "^12.0.2" + }, + "devDependencies": { + "@0xproject/tslint-config": "^1.0.7", + "chai": "^4.1.2", + "chai-as-promised": "^7.1.0", + "chai-bignumber": "^2.0.2", + "dirty-chai": "^2.0.1", + "make-promises-safe": "^1.1.0", + "mocha": "^5.2.0", + "shx": "^0.2.2", + "source-map-support": "^0.5.0", + "tslint": "5.11.0" + }, + "publishConfig": { + "access": "public" + } +} |