Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vladimirlogachev/elm-package-insights
Detects broken Elm packages
https://github.com/vladimirlogachev/elm-package-insights
elm elm-lang elmlang
Last synced: 3 months ago
JSON representation
Detects broken Elm packages
- Host: GitHub
- URL: https://github.com/vladimirlogachev/elm-package-insights
- Owner: vladimirlogachev
- Created: 2024-05-16T16:21:28.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-07-27T22:37:20.000Z (6 months ago)
- Last Synced: 2024-09-30T10:04:28.958Z (4 months ago)
- Topics: elm, elm-lang, elmlang
- Language: Haskell
- Homepage:
- Size: 71.3 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ccamel - vladimirlogachev/elm-package-insights - Detects broken Elm packages (Haskell)
README
# elm-package-insights
Detects broken Elm packages.
Example output:
```
Done!
Total packages: 1887
Broken packages: 165
Broken package list: [workdir]/.package-test/.outputs/broken-packages.txt
Details: [workdir]/.package-test/.outputs/broken-packages.json
```
Note: If the package registry problems become more complex, this tool will be transformed to a webapp and will run the scans periodically. Contact me if you think this needs to be done, I am open for discussions. For now it looks like running it manually is enough.
## Prerequisites
- Node.js (e.g. via [NVM](https://github.com/nvm-sh/nvm))
- elm (e.g. `npm install -g elm`)
- elm-json (e.g. `npm install -g elm-json`)
- Haskell Stack (e.g. via [GHCup](https://www.haskell.org/ghcup/))
## Usage
Checking all packages may take about 30m to complete.
For quick local re-run:
```sh
cd scanner
stack run scanner-exe
```
For longer, more comprehensive check:
```sh
cd scanner
stack run scanner-exe -- --reset-elm-packages-cache --reset-test-directories
```
### Flags
- `--reset-elm-packages-cache`
Reset local elm packages cache (required for reliable test, will slow down the test a lot).
- `--reset-test-directories`
Remove test directories before running tests (shouldn't affect the test much, and will slow down the test).