Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/contractshark/inject-solhint-ci
Solhint GitHub Action/CI Module
https://github.com/contractshark/inject-solhint-ci
ci ethereum github-actions solhint solidity workflow
Last synced: about 1 month ago
JSON representation
Solhint GitHub Action/CI Module
- Host: GitHub
- URL: https://github.com/contractshark/inject-solhint-ci
- Owner: contractshark
- License: mit
- Created: 2021-02-13T11:43:27.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-20T11:45:45.000Z (over 3 years ago)
- Last Synced: 2024-10-01T15:13:55.494Z (about 2 months ago)
- Topics: ci, ethereum, github-actions, solhint, solidity, workflow
- Language: JavaScript
- Homepage:
- Size: 171 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
SolHint-CI
# Overview
This is a stripped down version of the Solhint NPM package for CI purposes only.
Solhint Authors can be found at Protofire
## Usage
### GitHub Action
```yaml
name: solhint-ci
on: [pull_request]
jobs:
solhint:
name: runner / solhint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: solhint
uses: contractshark/inject-solhint-ci@latest
with:
github_token: ${{ secrets.github_token }}
reporter: github-pr-review # Change reporter.
solhint_input: 'contracts/*.sol'
```
### NPM
Injection via NPM module, e.g.
```bash
yarn add --dev "https://github.com/contractshark/inject-solihint-ci#$COMMIT_REF"
```
Usage
### Installation
You can install Solhint using **npm**:
```sh
yarn add --dev solhint-ci
# verify that it was installed correctly
solhint --version
```
## Usage
First initialize a configuration file, if you don't have one:
```sh
solhint --init
```
This will create a `.solhint.json` file with the default rules enabled. Then run Solhint with one or more [Globs](https://en.wikipedia.org/wiki/Glob_(programming)) as arguments. For example, to lint all files inside `contracts` directory, you can do:
```sh
solhint 'contracts/**/*.sol'
```
To lint a single file:
```sh
solhint contracts/MyToken.sol
```
Run `solhint` without arguments to get more information:
```text
Usage: solhint [options] [...other_files]
Linter for Solidity programming language
Options:
-V, --version output the version number
-f, --formatter [name] report formatter name (stylish, table, tap, unix)
-w, --max-warnings [maxWarningsNumber] number of allowed warnings
-c, --config [file_name] file to use as your .solhint.json
-q, --quiet report errors only - default: false
--ignore-path [file_name] file to use as your .solhintignore
--fix automatically fix problems
--init create configuration file for solhint
-h, --help output usage information
Commands:
stdin [options] linting of source code data provided to STDIN
```
## Configuration
You can use a `.solhint.json` file to configure Solhint for the whole project.
To generate a new sample `.solhint.json` file in current folder you can do:
```sh
solhint --init
```
This file has the following
format:
```json
{
"extends": "solhint:recommended",
"plugins": [],
"rules": {
"avoid-suicide": "error",
"avoid-sha3": "warn"
}
}
```
A full list of all supported rules can be found [here](docs/rules.md).
To ignore files that do not require validation you can use a `.solhintignore` file. It supports rules in
the `.gitignore` format.
```
node_modules/
additional-tests.sol
```
### Extendable rulesets
The default rulesets provided by solhint are the following:
+ solhint:default
+ solhint:recommended
Use one of these as the value for the "extends" property in your configuration file.
### Configure the linter with comments
You can use comments in the source code to configure solhint in a given line or file.
For example, to disable all validations in the line following a comment:
```solidity
// solhint-disable-next-line
uint[] a;
```
You can disable specific rules on a given line. For example:
```solidity
// solhint-disable-next-line not-rely-on-time, not-rely-on-block-hash
uint pseudoRand = uint(keccak256(abi.encodePacked(now, blockhash(block.number))));
```
Disable validation on current line:
```solidity
uint pseudoRand = uint(keccak256(abi.encodePacked(now, blockhash(block.number)))); // solhint-disable-line
```
Disable specific rules on current line:
```solidity
uint pseudoRand = uint(keccak256(abi.encodePacked(now, blockhash(block.number)))); // solhint-disable-line not-rely-on-time, not-rely-on-block-hash
```
You can disable a rule for a group of lines:
```solidity
/* solhint-disable avoid-tx-origin */
function transferTo(address to, uint amount) public {
require(tx.origin == owner);
to.call.value(amount)();
}
/* solhint-enable avoid-tx-origin */
```
Or disable all validations for a group of lines:
```solidity
/* solhint-disable */
function transferTo(address to, uint amount) public {
require(tx.origin == owner);
to.call.value(amount)();
}
/* solhint-enable */
```
## Rules
### Security Rules
[Full list with all supported Security Rules](docs/rules.md#security-rules)
### Style Guide Rules
[Full list with all supported Style Guide Rules](docs/rules.md#style-guide-rules)
### Best Practices Rules
[Full list with all supported Best Practices Rules](docs/rules.md#best-practise-rules)