[Remix] Solium Plugin

[yann300]

Solium Plugin

(subject to change)

• Funded $500
• See https://github.com/ethberlin-hackathon/ETHBerlin-Teambuilding/blob/master/RemixHackathon.md for more info about the Remix hackathon. Please be sure to read it before starting.
• Some infos about Remix: https://remix.readthedocs.io/en/latest/
• Online version: http://remix.ethereum.org

We've been releasing an API (available in http://remix-alpha.ethereum.org) which allows developing plugin for Remix. (See https://github.com/ethereum/remix/blob/master/docs/remix_plugin.md and https://github.com/ethereum/remix/blob/master/docs/remix_plugin_api.md) Checkout https://remix-alpha.ethereum.org / settings tab / Oraclize for a live example.

This issue is specifically about developing a Solium Plugin.

Proposal for implementation

(You don't need to strictly follow this proposal, we would like to have your feedback)

https://github.com/duaraghav8/Solium

• plugin create config files used by Solium.
• Action for starting analysis on the current file.
• "Fix" button (API to update file content yet to be added).

Functions of the Plugin

• Create default configuration files
• Run Solium on the current file when it is saved or in real-time as the user keeps writing code Decision to be taken
• Apply Solium fix either automatically (if the user selects this option) or when the Fix button is clicked. Update the solidity file(s) in-place. Decision to be taken

Links

• Solium documentation
• Solium NodeJS API docs

Team

We are the team behind Remix IDE and related libraries, using this hackathon as a kickstart for the Remix API. We've setup an extended team for helping you during this event

• Remix team - @ninabreznik @serapath @ryestew @yann300 @iurimatias
• Go team - @ligi @holiman
• Solidity team - @leonardoalt @chriseth
• C++, ewasm - @chfast @axic

Beside normal funding, we will at the end of the event select 4 teams that will receive sponsorship from the Ethereum Foundation.

Be sure to contact us at any time online or grab us directly at the event.

Skills wanted

JavaScript / Ethereum

Communication

We will be around giving advice and helping if needed. And in any case just drop your thoughts there ;)

https://gitter.im/ethereum/remix-dev-plugin

How to get started:

• Clone https://github.com/yann300/remix-plugin , go to src folder
• Serve the folder through local web server
• Go to remix-alpha.ethereum.org
• Settings tab / Plugin section
• Input Description:

  {
  “title”: “<name of plugin>”,
  “url”: “http://127.0.0.1:<port>”
  }

• Load and Start using it.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 500.0 DAI (500.0 USD @ $1.0/DAI) attached to it.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
  • Want to chip in? Add your own contribution here.
  • Questions? Checkout Gitcoin Help or the Gitcoin Slack
  • $31,130.88 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work has been started.

These users each claimed they can complete the work by 3 years, 5 months ago. Please review their action plans below:

1) subramanianv has started work.

Action plan Look at how solium can be configured through command line Look at how to use the remix plugin api Integrate solium using an iframe

Learn more on the Gitcoin Issue Details page.

[yann300]

@subramanianv please contact @duaraghav8, he can provide a browserified version of solium or tell you how to build one.

[subramanianv]

@yann300 I reached out to solium. They dont have a browserified version of solium yet. So in the meanwhile I'll go through the code and work on other parts for this issue till solium is ready

[subramanianv]

@yann300 I am trying to install remix-plugin through npm. Its says not found npm install --save remix-plugin is the command I ran

[yann300]

it is not published. You need to clone https://github.com/yann300/remix-plugin

[subramanianv]

I am waiting on the browserified version of solium. Will continue once thats ready.

[yann300]

@subramanianv this PR provides browser support for solium: https://github.com/duaraghav8/Solium/pull/241

[subramanianv]

@yann300 Thanks. I am starting work on this

[yann300]

that has been merged here https://github.com/duaraghav8/Solium/tree/browserify , npm run browserify for generating the bundle.js

[subramanianv]

@yann300 I get this error when running npm run browserify Is there a package missing ? ReferenceError: Unknown plugin "fast-async" specified in "base" at 0, attempted to resolve relative to "/Users/subramanianvenkatesan/Solium/lib" while parsing file: /Users/subramanianvenkatesan/Solium/lib/lib.js at /Users/subramanianvenkatesan/Solium/node_modules/babel-core/lib/transformation/file/options/option-manager.js:180:17 at Array.map (<anonymous>) at Function.normalisePlugins (/Users/subramanianvenkatesan/Solium/node_modules/babel-core/lib/transformation/file/options/option-manager.js:158:20) at OptionManager.mergeOptions (/Users/subramanianvenkatesan/Solium/node_modules/babel-core/lib/transformation/file/options/option-manager.js:234:36) at OptionManager.init (/Users/subramanianvenkatesan/Solium/node_modules/babel-core/lib/transformation/file/options/option-manager.js:368:12) at File.initOptions (/Users/subramanianvenkatesan/Solium/node_modules/babel-core/lib/transformation/file/index.js:212:65) at new File (/Users/subramanianvenkatesan/Solium/node_modules/babel-co

[yann300]

will push a PR. please try addin "fast-async": "6.3.1", to the devDependencies

[yann300]

@subramanianv let me know if that is working

[subramanianv]

@yann300 Works now. Thanks :)

On Tue, Oct 2, 2018 at 9:51 PM yann300 notifications@github.com wrote:

@subramanianv https://github.com/subramanianv let me know if that is working

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/ethberlin-hackathon/ETHBerlin-Bounties/issues/19#issuecomment-426337779, or mute the thread https://github.com/notifications/unsubscribe-auth/ACqZ8WGP7RAVkMHQIOwaTfUV7-12fZmWks5ug5KmgaJpZM4WbFzr .

-- Thanks, Subramanian Venkatesan.

[subramanianv]

@yann300 I am trying to import the build file var Solium = require('./build/solium-browser-bundle.js')

I get the following error Cannot find module './decode' from '/Users/subramanianvenkatesan/Solium/build' at /Users/subramanianvenkatesan/.nvm/versions/node/v8.11.3/lib/node_modules/browserify/node_modules/browser-resolve/node_modules/resolve/lib/async.js:55:21 at load (/Users/subramanianvenkatesan/.nvm/versions/node/v8.11.3/lib/node_modules/browserify/node_modules/browser-resolve/node_modules/resolve/lib/async.js:69:43) at onex (/Users/subramanianvenkatesan/.nvm/versions/node/v8.11.3/lib/node_modules/browserify/node_modules/browser-resolve/node_modules/resolve/lib/async.js:92:31) at /Users/subramanianvenkatesan/.nvm/versions/node/v8.11.3/lib/node_modules/browserify/node_modules/browser-resolve/node_modules/resolve/lib/async.js:22:47 at FSReqWrap.oncomplete (fs.js:152:21)

Is there a file missing ? What version of browserify do you ?

[yann300]

solium-browser-bundle.js can't be loaded using require I think. (but can direclty be used in a script tag <script></script>

[yann300]

if you want to import in your project like this, we might just do require('<soliumpath>/lib/lib.js')

[subramanianv]

Ah ok. I got it. Now importing the build on the html page through a script tag.

[yann300]

then you can access it with window.solium see https://github.com/duaraghav8/Solium/blob/browserify/lib/lib.js for the interface

[subramanianv]

@yann300 I am trying to use the remix's hightlight api.

window.parent.postMessage(JSON.stringify({ action: 'request', key: 'editor', type: 'hightlight', value: [{line:1,column:1}, filename, '#FF9F33'], id: _9 }),'*')

I get back Unexpected token o in JSON at position 1 The JSON seems to be well formed though. Can you paste an example of how to use the hightlight api ?

[yann300]

try something like {"start": { "line": 5, "column": 5 }, "end": { "line": 6, "column": 5 }}

[yann300]

perhaps would be more convenient to use the remix-api.js lib from https://github.com/yann300/remix-plugin/tree/master/src instead of using postMessage directly

[subramanianv]

@yann300 I made a basic version of the plugin. http://industrious-bomb.surge.sh/ Use it on a non-https version of remix. Let me know what you think.

[yann300]

that looks nice ;) would it be possible to : 1) add a lintAndFix button 2) put the configuration file in the config explorer (for that you can easily use setConfig, getConfig. Basically the plugin automatically add the file if not present.

[subramanianv]

Is Solium.lintAndFix function exposed in the browser version of Solium ? I get Solium.lintAndFix is not a function

[yann300]

see in https://github.com/duaraghav8/Solium/blob/browserify/lib/lib.js you can specify autoFix in the config or directly as a param

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

Work for 500.0 DAI (500.0 USD @ $1.0/DAI) has been submitted by:

1. @subramanianv

@ceresstation please take a look at the submitted work:

• PR by @subramanianv

---

• Learn more on the Gitcoin Issue Details page
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $37,842.32 more funded OSS Work available on the Gitcoin Issue Explorer

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

The funding of 500.0 DAI (500.0 USD @ $1.0/DAI) attached to this issue has been approved & issued to @subramanianv.

• Learn more on the Gitcoin Issue Details page
  • Questions? Checkout Gitcoin Help or the Gitcoin Slack
  • $41,008.85 more funded OSS Work available on the Gitcoin Issue Explorer