Crytic-compile

This release adds two new flags to improve truffle support, and improves etherlime, waffle and buidler support. Additionally, slither now runs GitHub [super-linter](https://github.com/github/super-linter) (see [CONTRIBUTING.md#linters](https://github.com/crytic/crytic-compile/blob/845c57854782529ae277f91cd22fff109971d945/CONTRIBUTING.md#linters)).

We also want to thanks alphastorm and tomlinton for their contributions.

Added
- `--truffle-overwrite-config` and `--truffle-overwrite-version` to ease the compilation on complex setup (https://github.com/crytic/crytic-compile/pull/88)
Changed
- Remove case sensitivity in `--compile-force-framework` (https://github.com/crytic/crytic-compile/pull/100)
- Improve waffle and etherlime support (https://github.com/crytic/crytic-compile/pull/101
- Github super linter (https://github.com/crytic/crytic-compile/pull/107)

Fixed
- Improve buidler detection (https://github.com/crytic/crytic-compile/pull/97)
- Fix natspec parsing in buidler (https://github.com/crytic/crytic-compile/pull/105)
- All pylint issues (https://github.com/crytic/crytic-compile/pull/107)

This release adds the support for [buidler](https://github.com/nomiclabs/buidler), the events information, and improves the zip export.

Added
- Support for [buidler](https://github.com/nomiclabs/buidler) (https://github.com/crytic/crytic-compile/pull/82)
- Parsing of events topics (https://github.com/crytic/crytic-compile/pull/81)
- `-export-zip-type` flag (https://github.com/crytic/crytic-compile/pull/84)

Changed
- Zip export will now use lzma for compression (https://github.com/crytic/crytic-compile/pull/84)

Fixed
- Archive platform support (https://github.com/crytic/crytic-compile/pull/80)

This release includes a large refactor of the platforms leading to a simpler and cleaner API, the documentation is now on [readthedocs](https://crytic-compile.readthedocs.io/en/latest/). `crytic-compile` will try to guess the unit-tests command according to the platform. Additionally, this release allows third-parties tools to get the natpsec documentation.

Added
- Guessing of the unit test commands (https://github.com/crytic/crytic-compile/pull/69)
- Natpsec parsing (https://github.com/crytic/crytic-compile/pull/66)
- Add documentation to https://crytic-compile.readthedocs.io/en/latest/ (https://github.com/crytic/crytic-compile/pull/77)
- `--etherscan-apikey` flag (https://github.com/crytic/crytic-compile/pull/64)
- Use npx for embark/etherlime (https://github.com/crytic/crytic-compile/pull/74)

Changed
- The platform architecture was refactored. All the platforms inherit from `AbstractPlatform`. As a result, it will be easier to interact with a custom platform from a script, and the code was cleaned. (https://github.com/crytic/crytic-compile/pull/68)
- Truffle: get the compiler version from the json objects. This will speed up all truffle usage by avoiding one call to the platform (https://github.com/crytic/crytic-compile/pull/67)
- Import the output in case of errors (https://github.com/crytic/crytic-compile/issues/45)
- The default filename is now `crytic_compile.config.json` (https://github.com/crytic/crytic-compile/pull/76) [BREAKING CHANGE]
- Use `deleteCompiledFiles` for etherlime (https://github.com/crytic/crytic-compile/pull/75)

This release improves the overall code quality through the use of python type annotation, and a significant increase in the documentation coverage. Additionally, a new flag was added `--ignore-compile` and we moved from travis to GitHub actions.

Thanks to our external contributor:
- karansinghgit

Added
- Python type annotation (https://github.com/crytic/crytic-compile/pull/54)
- `--ignore-compile` flag, which disables the compilation for any platform (shortcut for `--truffle-ignore-compile --embark-ignore-compile ....`) (https://github.com/crytic/crytic-compile/pull/55)

Changed
- Increase documentation coverage (https://github.com/crytic/crytic-compile/pull/54)
- `cryticparser.defaults_flag_in_config` is renamed `DEFAULTS_FLAG_IN_CONFIG` (https://github.com/crytic/crytic-compile/pull/54, breaking change)
- Use GitHub action instead of travis (https://github.com/crytic/crytic-compile/pull/57, https://github.com/crytic/crytic-compile/pull/58)


Fixed
- Many pylint issues (https://github.com/crytic/crytic-compile/pull/54)

This release adds support for Waffle and bytecode-only contracts from Etherscan. It also fixes minor bugs.

Thanks to our external contributor:
- NicsTr

Added
- [Waffle](https://ethereum-waffle.readthedocs.io/en/latest/index.html) support (https://github.com/crytic/crytic-compile/pull/44)
- Support for bytecode-only contracts from Etherscan (https://github.com/crytic/crytic-compile/pull/52)

Fixed
- Minor standard export bug (https://github.com/crytic/crytic-compile/pull/46)
- Node version in the regression tests (https://github.com/crytic/crytic-compile/pull/48)

This release adds the support for [Brownie](https://github.com/iamdefinitelyahuman/brownie), integrates minor improvements and fixes several bugs.

Thanks to our external contributor:
- arcz


Added
- Brownie support (https://github.com/crytic/crytic-compile/pull/41)
- Solc standard json support (https://github.com/crytic/crytic-compile/pull/29)
- `--npx-disable` flag (https://github.com/crytic/crytic-compile/issues/35)

Changed
- Truffle: naive solc version deduction form the config file (https://github.com/crytic/crytic-compile/pull/38) (speed up truffle platform)
- Dapp: use cache for travis test (https://github.com/crytic/crytic-compile/pull/42)

Fixed
- Allow self-referencing package (https://github.com/crytic/crytic-compile/issues/30)
- Embark: incorrect compiler version (https://github.com/crytic/crytic-compile/commit/c130376eb66b58a4dc876054f33487353604c47a)
- Standard: Incorrect dependencies (https://github.com/crytic/crytic-compile/pull/33)
- Truffle: prevent crash if incorrect json artifacts are present (https://github.com/crytic/crytic-compile/pull/36)