Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clemlak/solver
🔎 Solver integrates Solhint (a Solidity linter) in Visual Studio Code.
https://github.com/clemlak/solver
ethereum extension linter solhint solidity typescript visual-studio-code visual-studio-extension
Last synced: about 1 month ago
JSON representation
🔎 Solver integrates Solhint (a Solidity linter) in Visual Studio Code.
- Host: GitHub
- URL: https://github.com/clemlak/solver
- Owner: clemlak
- License: mit
- Created: 2019-09-21T09:22:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T18:42:14.000Z (almost 2 years ago)
- Last Synced: 2023-03-03T14:16:58.337Z (almost 2 years ago)
- Topics: ethereum, extension, linter, solhint, solidity, typescript, visual-studio-code, visual-studio-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=clementlakhal.solver
- Size: 121 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔎 Solver
> Solver integrates [Solhint](https://github.com/protofire/solhint) (a [Solidity](https://solidity.readthedocs.io) linter) in [Visual Studio Code](https://code.visualstudio.com).
Learn more about Solhint [here](https://github.com/protofire/solhint).
## 🚀 Usage
*Since Solver already contains an instance of Solhint, you are not required to install it. If you are creating a new project from scratch, you can add manually a `.solhint.json` configuration file (or use Solhint to generate one).*
Once installed, the extension will start when you will open a Solidity file.
The way it works is very simple:
- **If you opened a single file:** the rules defined in the settings of the extension will be used.
- **If you opened a folder:** the extension is going to look for a `.solhint.json` file in the current workspace and use the rules defined inside this file.
*Note: If you did not defined any rule in the settings of the extension, or if the `.solhint.json` file is missing, all the rules are going to be activated by default.*
## 🔧 Extension Settings
The following settings are available:
### `solver.delay`
When the current file has been edited, this defines how much time (in millisecond) the extension will wait before triggering a new linting. Exemple:
```json=
"solver.delay": 500
```
### `solver.warningStyle`
The style applied to the warning messages. Example:
```json=
"solver.warningStyle": {
"border": "1px solid #f39c12",
"borderStyle": "dashed"
}
```
### `solver.errorStyle`
The style applied to the error messages. Example:
```json=
"solver.warningStyle": {
"border": "1px solid #c0392b",
"borderStyle": "dashed"
}
```
### `solver.config`
This defines all the rules related to Solhint. You can simply copy and paste the content of a `.solhint.json` file in here. Example:
```json=
"solver.config": {
"extends": "solhint:default",
"plugins": [],
"rules": {
"quotes": "warn",
"const-name-snakecase": "off",
"avoid-suicide": "error",
"avoid-sha3": "warn",
"avoid-tx-origin:": "warn",
"not-rely-on-time": "warn",
"not-rely-on-block-hash": "warn",
"space-after-comma": "warn",
"no-spaces-before-semicolon": "warn"
}
}
```
You can find more details about Solhint rules [here](https://github.com/protofire/solhint/blob/master/docs/rules.md).
*Note: Plugins are not supported yet.*
## 🐛 Known Issues
Here are the known issues, I'll try to fix them as soon as possible:
- When an issue has been spotted, the warning / error message may highlight more code than needed
- When the rules are updated (in the settings or in the `.solhint.json` file), the new configuration may not be used right away in the current file
- Plugins are not supported yet
- When an issue has been spotted, a solution could be proposed to fix it
- This extension does not implement Solidity syntax highlighting