{"_id":"@bonadocs/docgen","_rev":"9-257a9bc94889291cf9c4f639db417065","name":"@bonadocs/docgen","dist-tags":{"latest":"1.0.1-alpha.6"},"versions":{"1.0.0-alpha.1":{"name":"@bonadocs/docgen","version":"1.0.0-alpha.1","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.0-alpha.1","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"567c98cc69e22f484f8ceed89d1520fe528a2307","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.0-alpha.1.tgz","fileCount":132,"integrity":"sha512-7OGSbExT3U5NP4R14rzVGgtBBswZ7EhbrX/TZ+wpxpz+g+e/E0I1J6GdcBHlivkQQiHQ5TSHsVcgLsciBOJ3bw==","signatures":[{"sig":"MEUCIQC0pq4BkU+Y2M6C1QvjboB1qr+b/a5GcXuZpkSrrAAK4QIgBHLzii5qKKFUCFV8AOv9MKr7JYLTQ2nq1tx4JVU2kQk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":690159},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/widget.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.0-alpha.1","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.0-alpha.1_1704471574265_0.6636328595802108","host":"s3://npm-registry-packages"}},"1.0.0-alpha.2":{"name":"@bonadocs/docgen","version":"1.0.0-alpha.2","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.0-alpha.2","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"a0985ec61a97ee3520aa2ebff1886de1045bd4c8","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.0-alpha.2.tgz","fileCount":132,"integrity":"sha512-dsN/pFmPckvnEhPf2H2ibAscqdQugyfHktGEtFgIcjU6rdtVD917c2QGS0cERSKJInrMVvZ8F++K5BVG9wKqvg==","signatures":[{"sig":"MEUCIB1k0oWnqd9vZOiXhyGwJds5hx9SxfLLHBsCFP2OIiMnAiEAhO9lJSwVNvV/bCoDyU5fLIU0DRrciUk7heC+nWf9dDk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":694067},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/widget.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.0-alpha.1","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.0-alpha.2_1704506045621_0.30276515471467613","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@bonadocs/docgen","version":"1.0.0","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.0","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"e41e95e8c88bd72e50a5343fa76eea57c02b69ea","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.0.tgz","fileCount":133,"integrity":"sha512-Mfhxel1fAF9/IS4cfpkGNjt2lhLv9+Zxpi3QWMBFAiIR5kYbS1ncZjI5LbAQnco1tL/oKVOu7mlmKDOglyI4Yw==","signatures":[{"sig":"MEUCIQC4sxnsCXn3Dz9XVsFZgtfP64/yfsRc0MHU1vmz/2QNCgIgLpoMuGHD9+yLTD6JVg3I4kg2O4bhjYhtcREen6B1hDY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":694995},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/widget.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.0-alpha.1","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.0_1704560563761_0.7048156308839928","host":"s3://npm-registry-packages"}},"1.0.1-alpha.1":{"name":"@bonadocs/docgen","version":"1.0.1-alpha.1","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.1-alpha.1","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"7f17ee52d6b50a609e6c61049ee835ad4c265590","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.1-alpha.1.tgz","fileCount":133,"integrity":"sha512-aUvaiey3L5i0adLEkwU3nAEhMuAxaaaREw8Fq1/o5RtYoIOloHaFhN5OmvqXx0+UTutfm0sMGSDJMrOLG9Ao1Q==","signatures":[{"sig":"MEUCIQDVk/4XIF4V1cRdVn8jdpLOOfftYaowsy/E3e+WZfKKDQIgR/8S1YLG3sgNMtYG1YTiIkheWvDwDlRTxMg5h5ZSSLw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":656833},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/widget.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.0-alpha.2","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.1-alpha.1_1704564582472_0.4014017607180216","host":"s3://npm-registry-packages"}},"1.0.1-alpha.2":{"name":"@bonadocs/docgen","version":"1.0.1-alpha.2","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.1-alpha.2","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"3c0c66bf252e36b45eeac6d56b2c82da778150ac","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.1-alpha.2.tgz","fileCount":157,"integrity":"sha512-IotFz07ro97Z5ibzF1MermZfc2WNihb1gFI/OX34kVoo4GHDjjw1xJ4Z7GhvhaH7EF3+T692N5+gV47nEqqoAA==","signatures":[{"sig":"MEUCIQCsEpwT9Y9BfuadNp29pOOAGzJL0jNWvuF3p+Olue9mzQIgfyb4nZPA3RqsQPYQhXiNsz7vHB0RupodfdAX5yGJdQg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":707932},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepublishOnly":"run-s build","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/docgen.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"cbor":"^9.0.2","shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.0","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.1-alpha.2_1711523655814_0.637630664456621","host":"s3://npm-registry-packages"}},"1.0.1-alpha.3":{"name":"@bonadocs/docgen","version":"1.0.1-alpha.3","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.1-alpha.3","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"70f96b76f8b3edc4bc2d2e1f9dc977b7b30f3bf8","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.1-alpha.3.tgz","fileCount":157,"integrity":"sha512-zC6YL1N8g7+0gi33TBDg6vr7+JXt+J/qbS9ECraIKiiPR/MMKTk2TTYn3wMThNLjEXJd1/XX/BtJU78JXaeAFA==","signatures":[{"sig":"MEUCIA9nf0Cvxmgo1uTStzIsNjeYwLgVv2Sy5kc693NNCVtOAiEAn7Hi9yeuyrdH/tC79WUa5Fq7XZIz2oWgeAz1F6Dg1KE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":708365},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepublishOnly":"run-s build","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/docgen.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"cbor":"^9.0.2","shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.0","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.1-alpha.3_1712644485565_0.3632461784393628","host":"s3://npm-registry-packages"}},"1.0.1-alpha.4":{"name":"@bonadocs/docgen","version":"1.0.1-alpha.4","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.1-alpha.4","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"68f47bd8bae5ccf06d60cf07f759f51b982c8f2e","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.1-alpha.4.tgz","fileCount":157,"integrity":"sha512-RnkckLzu73YnhpaReR7YjxMXh2GGArlIEXhfmR3UDr0UxpLF9m4wADazRahTzlDtUI9ocruFKYPutcGML0u3Pw==","signatures":[{"sig":"MEUCIQCpicM6J5g8jhJ9tdY3HQWZLMFkR9a+6PfaY4Q+WwUt/AIgPfRSIJZ9MN6wvqIW57axTKZIqIwLS41HcmhYdeXq2qU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":739825},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepublishOnly":"run-s build","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/docgen.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"cbor":"^9.0.2","shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.3-alpha.88","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.1-alpha.4_1729581330832_0.3894319317925279","host":"s3://npm-registry-packages"}},"1.0.1-alpha.5":{"name":"@bonadocs/docgen","version":"1.0.1-alpha.5","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.1-alpha.5","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"0b5e933ffe5b2b920348d54e0b3d9ea37edca6f9","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.1-alpha.5.tgz","fileCount":157,"integrity":"sha512-l9vqe7ACNJwnOJ3j6g0sgjWuyp16pb0ryJegC8zFQFVbUHX//hUFkPSl7XkWxPGvInafZOkZpmZsbBt/lNxmiA==","signatures":[{"sig":"MEQCIEn61C9koOU461FteH8r3Ah6lsSSGOUTPSc+qdFG/SykAiBfEkoRt7DAxKrcmQNw4T4zjOWDR1H5VVRmhv1fT0npTw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":739825},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepublishOnly":"run-s build","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/docgen.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"cbor":"^9.0.2","shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.3-alpha.89","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.1-alpha.5_1729582381827_0.5538996738983102","host":"s3://npm-registry-packages"}},"1.0.1-alpha.6":{"name":"@bonadocs/docgen","version":"1.0.1-alpha.6","keywords":["solidity","documentation"],"license":"MIT","_id":"@bonadocs/docgen@1.0.1-alpha.6","maintainers":[{"name":"staa99","email":"ahmadulfawwaz@gmail.com"}],"ava":{"files":["!build/module/**"],"timeout":"60s","failFast":true,"typescript":{"rewritePaths":{"src/":"build/main/"}}},"nyc":{"exclude":["**/*.spec.js"],"extends":"@istanbuljs/nyc-config-typescript"},"dist":{"shasum":"bd569823630b0436513934efbe490b9a6b0f68d8","tarball":"https://registry.npmjs.org/@bonadocs/docgen/-/docgen-1.0.1-alpha.6.tgz","fileCount":157,"integrity":"sha512-HfKUf9dgHpxaSu3xPjnw7YPhrw1LIKULeZIvXUtYo2fB6LXVRmmiHX008BWsZ082WVfj8bOK4VuyxnknpmLC4A==","signatures":[{"sig":"MEUCIQDaAqNgUV91cJ2ifRtEnu7/W244kvHqAC8hoLzAtIy2ngIgflfqIJ5eKmtWVlUxh2J6s+kKvwEhw3CdXqOsOuvES7Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":739798},"main":"build/main/index.js","config":{"commitizen":{"path":"cz-conventional-changelog"}},"module":"build/module/index.js","scripts":{"cov":"run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html","doc":"run-s doc:html && open-cli build/docs/index.html","fix":"run-s fix:*","test":"run-s build test:*","build":"run-p build:*","version":"standard-version","cov:html":"nyc report --reporter=html","cov:lcov":"nyc report --reporter=lcov","cov:send":"run-s cov:lcov && codecov","doc:html":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs","doc:json":"typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json","fix:lint":"eslint src --ext .ts --ext .tsx --fix","check-cli":"run-s test diff-integration-tests check-integration-tests","cov:check":"nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100","test:lint":"eslint src --ext .ts","test:unit":"nyc --silent ava","build:main":"tsc -p tsconfig.json && shx cp -r src/templates/markdown/*.hbs build/main/templates/markdown/","reset-hard":"git clean -dfx && git reset --hard && yarn","watch:test":"nyc --silent ava --watch","doc:publish":"gh-pages -m \"[ci skip] Updates\" -d build/docs","watch:build":"tsc -p tsconfig.json -w","build:module":"tsc -p tsconfig.module.json && shx cp -r src/templates/markdown/*.hbs build/module","fix:prettier":"prettier \"src/**/*.ts{,x}\" --write","test:prettier":"prettier \"src/**/*.ts\" --list-different","test:spelling":"cspell \"{README.md,.github/*.md,src/**/*.ts}\"","prepublishOnly":"run-s build","prepare-release":"run-s reset-hard test cov:check doc:html version doc:publish","diff-integration-tests":"mkdir -p diff && rm -rf diff/test && cp -r test diff/test && rm -rf diff/test/test-*/.git && cd diff && git init --quiet && git add -A && git commit --quiet --no-verify --allow-empty -m 'WIP' && echo '\\n\\nCommitted most recent integration test output in the \"diff\" directory. Review the changes with \"cd diff && git diff HEAD\" or your preferred git diff viewer.'","check-integration-tests":"run-s check-integration-test:*"},"typings":"build/main/index.d.ts","_npmUser":{"name":"staa99","email":"ahmadulfawwaz@gmail.com"},"prettier":{"semi":false,"singleQuote":true},"repository":{"url":"https://github.com/bonadocs/docgen.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","directories":{},"dependencies":{"cbor":"^9.0.2","shelljs":"^0.8.5","solidity-ast":"^0.4.55","@bonadocs/core":"^1.0.3-alpha.89","solidity-docgen":"^0.6.0-beta.36"},"_hasShrinkwrap":false,"devDependencies":{"ava":"^3.12.1","nyc":"^15.1.0","shx":"^0.3.4","cspell":"^4.1.0","eslint":"^7.8.0","codecov":"^3.5.0","hardhat":"^2.8.0","typedoc":"^0.25.4","gh-pages":"^6.1.0","open-cli":"^7.2.0","prettier":"^3.1.1","typescript":"^5.3.3","npm-run-all":"^4.1.5","@types/react":"^16.14.55","@types/shelljs":"^0.8.15","@ava/typescript":"^1.1.1","standard-version":"^9.5.0","eslint-plugin-import":"^2.29.1","@typescript-eslint/parser":"^6.14.0","cz-conventional-changelog":"^3.3.0","eslint-plugin-eslint-comments":"^3.2.0","@typescript-eslint/eslint-plugin":"^6.14.0","@istanbuljs/nyc-config-typescript":"^1.0.2"},"peerDependencies":{"hardhat":"^2.8.0"},"_npmOperationalInternal":{"tmp":"tmp/docgen_1.0.1-alpha.6_1729582718420_0.9309980279019561","host":"s3://npm-registry-packages"}}},"time":{"created":"2024-01-05T16:19:34.121Z","modified":"2024-12-28T17:31:53.079Z","1.0.0-alpha.1":"2024-01-05T16:19:34.452Z","1.0.0-alpha.2":"2024-01-06T01:54:05.816Z","1.0.0":"2024-01-06T17:02:44.051Z","1.0.1-alpha.1":"2024-01-06T18:09:42.728Z","1.0.1-alpha.2":"2024-03-27T07:14:16.083Z","1.0.1-alpha.3":"2024-04-09T06:34:45.838Z","1.0.1-alpha.4":"2024-10-22T07:15:31.035Z","1.0.1-alpha.5":"2024-10-22T07:33:02.069Z","1.0.1-alpha.6":"2024-10-22T07:38:38.671Z"},"license":"MIT","keywords":["solidity","documentation"],"repository":{"url":"https://github.com/bonadocs/docgen.git","type":"git"},"description":"Interactive documentation generator for solidity smart contracts","maintainers":[{"email":"ahmadulfawwaz@gmail.com","name":"staa99"},{"email":"atandadave@gmail.com","name":"davidpreneur"}],"readme":"# `@bonadocs/docgen`\n\n__docgen is a program that extracts documentation for a Solidity project and generates an\ninteractive website from it using Docusaurus.__\n\n`@bonadocs/docgen` is based on `solidity-docgen`. If you already use `solidity-docgen`, you\nalready know how to use `@bonadocs/docgen`. Hmmm, maybe 90% of it. The two main differences are:\n\n- `@bonadocs/docgen` generates a website using Docusaurus, while `solidity-docgen` only generates\n  Markdown files. You can turn off the website generation if you want to use a different static site\n  generator and only markdown files will be generated, much like `solidity-docgen`. If you would like\n  to use include widgets that make your documentation interactive, then this is a great option.\n- `@bonadocs/docgen` generates widgets for deployed contracts, so developers can interact with the\n  contracts directly from the documentation website. This is better than sending them off to Etherscan\n  or worse, having them write their own scripts to interact with the contracts.\n\nThe markdown output is fully configurable through Handlebars templates, but the default templates should\ndo a good job of displaying all of the information in the source code in Markdown format. If you don't\nwant to generate a website, the generated Markdown files can be used with a static site generator \nsuch as Docusaurus, Vuepress, MkDocs, Jekyll (GitHub Pages), etc., in order to publish a documentation\nwebsite.\n\n## Widget?\n\nThe widgets are interactive components that allow users to interact with the contracts directly from\nthe documentation website. Widgets run simulations by default and enable developers to test without\npaying gas fees. Developers love to learn by doing, and this is the perfect way to let them do just that.\nThe widgets are generated using [`@bonadocs/widget`](https://github.com/bonadocs/widget).\n\n__Note: widgets will only be generated for contracts with their deployment addresses specified.\nRefer to the configuration below__\n\n## Usage\n\nInstall `@bonadocs/docgen` from npm.\n\n### Hardhat\n\nInclude the plugin in your Hardhat configuration.\n\n```diff\n // hardhat.config.ts\n+import '@bonadocs/docgen';\n\nexport default {\n+  docgen: {\n+    projectName: 'Your Protocol Name', // optional, a placeholder name will be used if omitted\n+    projectDescription: 'An awesome web3 protocol.', // optional, a placeholder description will be used if omitted\n+    deploymentAddresses: { // optional. If you want to generate widgets for deployed contracts\n+      FirstContractName: [\n+        {\n+          chainId: 1, // mainnet\n+          address: '0x...',\n+        },\n+        {\n+          chainId: 42161, // arbitrum\n+          address: '0x...',\n+        },\n+      ],\n+      SecondContractName: [\n+        {\n+          chainId: 1, // mainnet\n+          address: '0x...',\n+        },\n+        {\n+          chainId: 42161, // arbitrum\n+          address: '0x...',\n+        },\n+      ],\n+    },\n+  }, // if necessary to customize config\n};\n```\n\nThen run with `npx hardhat docgen`.\n\n### As a library\n\n```typescript\nimport { docgen } from '@bonadocs/docgen';\n\nabis = [\n  {\n    contractName: 'MyContract',\n    abi: '...'\n  }\n]\nawait docgen([{ output: solcOutput }], config, abis);\n```\n\n`solcOutput` must be the standard JSON output of the compiler, with at least the `ast` output. There can be more than one.\n\n`config` is an optional object with the values as specified below.\n\n## Config\n\nSee [`config.ts`](./src/lib/config.ts) for the list of options and their documentation.\n\n`abis` is an optional array of objects with the following properties:\n\n- `contractName`: the name of the contract\n- `abi`: the ABI of the contract\n","readmeFilename":"README.md"}