https://github.com/duaraghav8/embark-solium

Ethlint (formerly Solium) plugin for Embark Framework
https://github.com/duaraghav8/embark-solium

blockchain code-quality dapp decentralized embark embark-plugin ethereum linter security smart-contracts solidity solium

Last synced: 3 months ago
JSON representation

Ethlint (formerly Solium) plugin for Embark Framework

• Host: GitHub
• URL: https://github.com/duaraghav8/embark-solium
• Owner: duaraghav8
• License: mit
• Created: 2017-12-13T16:25:26.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-06-20T22:03:31.000Z (over 5 years ago)
• Last Synced: 2024-05-01T15:21:39.905Z (9 months ago)
• Topics: blockchain, code-quality, dapp, decentralized, embark, embark-plugin, ethereum, linter, security, smart-contracts, solidity, solium
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/embark-solium
• Size: 57.6 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# embark-solium

The official [Solium](https://github.com/duaraghav8/Solium) Plugin for the [Embark Framework](https://github.com/iurimatias/embark-framework)

## Install

Make sure you have [embark](https://www.npmjs.com/package/embark) installed globally.

Traverse to your Embark Project Directory, then run `npm install --save embark-solium`.

## Use

- In your `embark.json`, add `embark-solium` to the list of plugins:

```json

"plugins": {

    "embark-solium": {}

}

```

- (Assuming `embark simulator` is already running), launch the Embark Dashboard using `embark run`.

- On the console, run `solium --init`. This will create `.soliumrc.json` & `.soliumignore` in the **root directory**.

You're all set! Now every time you make changes to any solidity file, Solium produces the lint issues in the Embark Console.

If you'd like to know which version of Solium `embark-solium` is running, simply run `solium --help`

## Roadmap

- [ ] Enable Solium's autofixing feature

- [ ] Allow user to change location of Solium config files

- [ ] Tests!

## Links

- Solium: [User Documentation](http://solium.readthedocs.io/en/latest/user-guide.html)

- Solium: List of [core](http://solium.readthedocs.io/en/latest/user-guide.html#list-of-core-rules) & [security](https://www.npmjs.com/package/solium-plugin-security#list-of-rules) rules applied

- Embark: [Plugin Documentation](http://embark.readthedocs.io/en/latest/plugins.html)