remove embark folder

pull/5370/head
ryestew 2 years ago committed by Aniket
parent 2c92cae346
commit cd1bc76f61
  1. 45
      apps/remix-ide/embark/README.md
  2. 66
      apps/remix-ide/embark/index.js
  3. 16
      apps/remix-ide/embark/package.json

@ -1,45 +0,0 @@
# embark-remix
An Embark plugin that allows Remix to connect to a local DApp via [`remixd`](https://github.com/ethereum/remixd). This plugin serves a local copy of Remix IDE from the machine running the plugin or alternatively allows connection from the public [Remix IDE](https://remix.ethereum.org). The URL of the Remix IDE can be specified in the Embark plugin options, specified below.
## Options
To configure options for the `embark-remix` plugin, modify the `plugins` property of `embark.json` in the DApp.
### How to use default options
To pass no options to the plugin and use the defaults, simply use an empty object:
```
"plugins": {
"embark-remix": {}
}
```
This will provide the default options to the plugin (shown below).
### Available options
The available options for this plugin are below. Default options are shown below. This is equivalent to passing an empty object `{}`.
```
"plugins": {
"embark-remix": {
"readOnly": false,
"remixIde": {
"protocol": "http",
"host": "localhost",
"port": 8088
}
}
}
```
`readOnly` does not let Remix update the contents on the local filesystem.
- Default: `false`
`remixIde` specifies the URL that the Remix IDE will be served from. If this is a `localhost` URL, the plugin creates a server that is responsible for listening on this URL.
- Default: `(see above)`
If it is preferred to connect to the public Remix IDE at https://remix.ethereum.org, set the `remixIde` config to:
```
"remixIde": {
"protocol": "https",
"host": "remix.ethereum.org",
"port": false
}
```

@ -1,66 +0,0 @@
const httpServer = require('http-server')
const remixd = require('remixd')
const path = require('path')
const merge = require('merge')
const colors = require('colors')
const DEFAULT_OPTIONS = {
protocol: 'http',
host: 'localhost',
port: '8088'
}
module.exports = (embark) => {
// plugin options
const readOnly = embark.pluginConfig.readOnly || false
const { protocol, host, port } = merge.recursive(DEFAULT_OPTIONS, embark.pluginConfig.remixIde)
// globals
const remixIdeUrl = `${protocol}://${host}` + `${port ? `:${port}` : ''}`
const sharedFolder = path.join(__dirname, '../../')
const sharedFolderService = remixd.services.sharedFolder
let server
// setup HTTP server
if (['localhost', '127.0.0.1', '0.0.0.0'].includes(host)) {
server = httpServer.createServer({
root: path.join(__dirname, '../../node_modules/remix-ide')
})
server.listen(port, '127.0.0.1', function () {
embark.logger.info('Remix IDE (via embark-remix plugin) available at ' + colors.underline(remixIdeUrl))
})
} else {
embark.logger.info('embark-remix is set to connect to a Remix IDE at ' + colors.underline(remixIdeUrl))
}
// setup Embark service check
embark.registerServiceCheck('Remix IDE', (cb) => {
return cb({ name: `Remix IDE ${host}:${port}`, status: 'on' })
})
// setup remixd shared folder service
const sharedFolderRouter = new remixd.Router(65520, sharedFolderService, { remixIdeUrl }, (webSocket) => {
sharedFolderService.setWebSocket(webSocket)
sharedFolderService.setupNotifications(sharedFolder)
sharedFolderService.sharedFolder(sharedFolder, readOnly)
})
const killRemixD = sharedFolderRouter.start()
const kill = () => {
if (server) server.close()
embark.logger.info(colors.red('embark-remix stopped'))
process.exit()
}
if (process.platform === 'win32') {
require('readline').createInterface({
input: process.stdin,
output: process.stdout
}).on('SIGINT', function () {
process.emit('SIGINT')
})
}
process.on('SIGINT', kill) // catch ctrl-c
process.on('SIGTERM', kill) // catch kill
process.on('exit', killRemixD)
}

@ -1,16 +0,0 @@
{
"name": "embark-remix",
"version": "0.0.2",
"description": "load remix IDE from embark environment",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "MIT",
"dependencies": {
"remix-ide": "latest",
"remixd": "latest",
"http-server": "latest"
}
}
Loading…
Cancel
Save