dev
/
providers
mirror of https://github.com/sussy-code/providers.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated README to mention the test script and arguments

This commit is contained in:
Jonathan Barrow 2023-09-26 14:21:18 -04:00
parent b70a27a0c8
commit 404c48f3b3
No known key found for this signature in database
GPG Key ID: E86E9FE9049C741F
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -9,5 +9,30 @@ features:
> **This package is still WIP**
## Development
To make testing scrapers easier during development a CLI tool is available to run specific sources. To run the CLI testing tool, use `npm run test:dev`. The script supports 2 execution modes
- CLI Mode, for passing in arguments directly to the script
- Question Mode, where the script asks you questions about which source you wish to test
The following CLI Mode arguments are available
| Argument | Alias | Description | Default |
|---------------|--------|-------------------------------------------------------------------------|--------------|
| `--fetcher` | `-f` | Fetcher type. Either `node-fetch` or `native` | `node-fetch` |
| `--source-id` | `-sid` | Source ID for the source to be tested | |
| `--tmdb-id` | `-tid` | TMDB ID for the media to scrape. Only used if source is a provider | |
| `--type` | `-t` | Media type. Either `movie` or `show`. Only used if source is a provider | `movie` |
| `--season` | `-s` | Season number. Only used if type is `show` | `0` |
| `--episode` | `-e` | Episode number. Only used if type is `show` | `0` |
| `--url` | `-u` | URL to a video embed. Only used if source is an embed | |
| `--help` | `-h` | Shows help for the command arguments | |
Example testing the FlixHQ source on the movie "Spirited Away"
```bash
npm run test:dev -- -sid flixhq -tid 129 -t movie
```
Todos:
- make default fetcher maker thing work with both undici and node-fetch