superlint/lib/README.md

19 lines
583 B
Markdown
Raw Normal View History

2020-06-29 12:17:25 -04:00
# Super-Linter Library
## Main script
2020-07-21 13:08:05 -04:00
2020-06-29 12:17:25 -04:00
The file `linter.sh` is the main script that is called for the process and loads all other scripts as functions.
## Functions
2020-07-21 13:08:05 -04:00
2020-06-29 12:17:25 -04:00
The additional files in the folder are functions to help streamline the main build process and allow for easier maintenance.
2020-07-21 13:08:05 -04:00
2020-06-29 12:17:25 -04:00
- `possum.sh`
- Official mascot of the **Super-Linter**
- `buildFileList.sh`
- Functions to help find files that were modified, or need to be scanned
- `validation.sh`
- Logic to see what linters are enabled
- `worker.sh`
- Calls to the various linters and the test cases for each