@abancu/explorer-core-plugins 中文文档教程
explorer-core-plugins
Alethio Explorer
Project structure
的核心插件该项目包含 3 个核心插件，它们提供基本的资源管理器功能并且共享相同的代码库、依赖项和构建过程。 每个插件在 packages/ 中都有一个文件夹，从中创建一个单独的 npm 包：
- eth-common - common pages and modules that should be available regardless of what data source is used
- eth-extended - pages, modules and data sources specific to the "full" explorer. This plugin uses the Alethio explorer API endpoints and a Deepstream connection
- eth-lite - a "lite" explorer plugin, using
web3as a data source. It only offers what can be directly fetched from an eth node, without the aggregations provided by the Alethio API.
Development
Install (Linux, MacOS)
npm install
Install (Windows)
npm --add-python-to- path='true' --debug install --global windows-build-tools npm install 与 Linux
Build
npm run watch 或 npm run build-dev 一样。
Link to an explorer installation
您可以acp link 任何插件文件夹到您的区块浏览器安装中。
$ npm i -g @alethio/cms-plugin-tool $ cd
$ acp link ../explorer-core-plugins/packages/eth-common \
../explorer-core-plugins/packages/eth-extended \
../explorer-core-plugins/packages/eth-lite
Running the tests
npm test（或 npm run test-coverage 以生成代码覆盖率）。
测试覆盖率以 HTML 和 LCOV 格式写入 ./coverage。
Release process
- Changes are proposed via pull requests and merged into master after they obtain approval.
- Releases are made from master, by a maintainer, collecting changes that were made since the previous release.
- A new independent version is chosen for plugins that were affected, according to semver.
- Changes are documented in CHANGELOG files, found in each package folder, committed and pushed to master.
- Publish to npm, with implicit git tags and corresponding release (see below).
Publishing to npm
这个 repo 使用 lerna。 因为源代码在包之间共享，所以 lerna 不会自动检测更改了哪些包。 需要执行以下命令：
npx lerna version --force-publish=<explicitly_changed_package_names>
例如 npx lerna version --force-publish=@alethio/explorer-plugin-eth-common,@alethio/explorer-plugin-eth-lite
npx lerna publish from-git
explorer-core-plugins
Core plugins for Alethio Explorer
Project structure
The project contains 3 core plugins that provide basic explorer functionality and which share the same codebase, dependencies and build process. Each plugin has a folder in packages/<pluginName>, from which a separate npm package is created:
- eth-common - common pages and modules that should be available regardless of what data source is used
- eth-extended - pages, modules and data sources specific to the "full" explorer. This plugin uses the Alethio explorer API endpoints and a Deepstream connection
- eth-lite - a "lite" explorer plugin, using
web3as a data source. It only offers what can be directly fetched from an eth node, without the aggregations provided by the Alethio API.
Development
Install (Linux, MacOS)
npm install
Install (Windows)
npm --add-python-to-path='true' --debug install --global windows-build-tools npm install just as with Linux
Build
npm run watch or npm run build-dev.
Link to an explorer installation
You can acp link any plugin folder into your block explorer installation.
$ npm i -g @alethio/cms-plugin-tool $ cd <explorer-checkout-folder>
$ acp link ../explorer-core-plugins/packages/eth-common \
../explorer-core-plugins/packages/eth-extended \
../explorer-core-plugins/packages/eth-lite
Running the tests
npm test (or npm run test-coverage to generate code coverage as well).
Test coverage is written to ./coverage in HTML and LCOV formats.
Release process
- Changes are proposed via pull requests and merged into master after they obtain approval.
- Releases are made from master, by a maintainer, collecting changes that were made since the previous release.
- A new independent version is chosen for plugins that were affected, according to semver.
- Changes are documented in CHANGELOG files, found in each package folder, committed and pushed to master.
- Publish to npm, with implicit git tags and corresponding release (see below).
Publishing to npm
This repo uses lerna. Because the source code is shared between packages, lerna will not automatically detect which packages were changed. The following commands need to be executed:
npx lerna version --force-publish=<explicitly_changed_package_names>
e.g. npx lerna version --force-publish=@alethio/explorer-plugin-eth-common,@alethio/explorer-plugin-eth-lite
npx lerna publish from-git
