Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethereum/remix-plugin
https://github.com/ethereum/remix-plugin
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ethereum/remix-plugin
- Owner: ethereum
- Created: 2018-03-19T12:50:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T14:36:47.000Z (about 1 month ago)
- Last Synced: 2024-06-18T12:45:29.092Z (14 days ago)
- Language: TypeScript
- Size: 7.26 MB
- Stars: 155
- Watchers: 15
- Forks: 100
- Open Issues: 76
-
Metadata Files:
- Readme: README.md
Lists
- awesome-remix - Remix plugin - Remix plugin. (Remix Repositories)
README
# Remix Plugin
Remix plugin is a universal plugin system written in Typescript.
It provides an extendable engine that simplifies communication between multiple internal or external sources.
This repository manages multiple projects related to remix plugins. It's divided into two main categories :
- Engine: A library to manage communication between plugins.
- Plugin: A library to create an external plugin.
## Engine
The core component of the engine is the `@remixproject/engine` library. It can be extended to run in different environments.
| Name | Latest Version | Next Version
| ------------------------------------------------------------------------ | :------------------: | :------------------:
| [@remixproject/engine](/packages/engine/core) | [](https://www.npmjs.com/package/@remixproject/engine) | [](https://www.npmjs.com/package/@remixproject/engine)
| [@remixproject/engine-vscode](/packages/engine/vscode) | [](https://www.npmjs.com/package/@remixproject/engine-vscode) | [](https://www.npmjs.com/package/@remixproject/engine-vscode)
| [@remixproject/engine-web](/packages/engine/web) | [](https://www.npmjs.com/package/@remixproject/engine-web) | [](https://www.npmjs.com/package/@remixproject/engine-web)
| [@remixproject/engine-node](/packages/engine/node) | [](https://www.npmjs.com/package/@remixproject/engine-node) | [](https://www.npmjs.com/package/@remixproject/engine-node)
> To create a new environment connector, check out [@remixproject/engine](/packages/engine/core).
## Plugin
The core component of the plugin is the `@remixproject/plugin` library. It can be extended to run in different environments.
| Name | Latest Version | Next Version
| ------------------------------------------------------------------------ | :------------------: | :------------------:
| [@remixproject/plugin](/packages/plugin/core) | [](https://www.npmjs.com/package/@remixproject/plugin) | [](https://www.npmjs.com/package/@remixproject/plugin)
| [@remixproject/plugin-vscode](/packages/plugin/vscode) | [](https://www.npmjs.com/package/@remixproject/plugin-vscode) | [](https://www.npmjs.com/package/@remixproject/plugin-vscode)
| [@remixproject/plugin-iframe](/packages/plugin/iframe) | [](https://www.npmjs.com/package/@remixproject/plugin-iframe) | [](https://www.npmjs.com/package/@remixproject/plugin-iframe)
| [@remixproject/plugin-webview](/packages/plugin/webview) | [](https://www.npmjs.com/package/@remixproject/plugin-webview) | [](https://www.npmjs.com/package/@remixproject/plugin-webview)
| [@remixproject/plugin-child-process](/packages/plugin/child-process) | [](https://www.npmjs.com/package/@remixproject/plugin-child-process) | [](https://www.npmjs.com/package/@remixproject/plugin-child-process)
> To create a new environment connector, check out [@remixproject/plugin](/packages/plugin/core).
## API
Remix plugin offers a set of common APIs for plugins to implement. This set of APIs is used in [remix-ide](https://remix.ethereum.org), therefore every plugin running inside remix-ide should be able to run in an engine that implements these APIs.
| Name | Latest Version | Next Version
| ---------------------------------- | :------------------: | :------------------:
| [@remixproject/plugin-api](/packages/api) | [](https://www.npmjs.com/package/@remixproject/plugin-api) | [](https://www.npmjs.com/package/@remixproject/plugin-api)
> The first goal of **remix plugin** is to enable a plugin to work in the envrionments of multiple engines. If a plugin has dependancies on other plugins, each engine must implement these dependancies.
# Contribute
## Setup
```
git clone https://github.com/ethereum/remix-plugin.git
cd remix-plugin
npm install
```
## See dependancy graph
To better understand the project structure, you can display a dependancy graph with:
```
npm run dep-graph
```
Open your browser on `http://localhost:4211/`.
## Build
This uses nx's affected:build to only update what has been changes since last build.
```
npm run build
```
## Build a specific project
```
npx nx build ${projectName} --with-deps
```
**Example for engine-vscode :**
```
npx nx build engine-vscode --with-deps
```
## Test
This uses nx's affected:test to only update what has been changes since last test.
```
npm test
```
## Publish
This uses lerna to deploy all the packages with a new version:
```
npm run deploy:latest
```
OR
```
npm run deploy:next
```