Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tkdn/chroco
[experimental] Chroco operates `puppeteer` with commandable, pluggable settings.
https://github.com/tkdn/chroco
chrome cli experimental headless puppeteer scenario
Last synced: about 1 month ago
JSON representation
[experimental] Chroco operates `puppeteer` with commandable, pluggable settings.
- Host: GitHub
- URL: https://github.com/tkdn/chroco
- Owner: tkdn
- License: mit
- Created: 2017-09-13T14:49:12.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-12T06:54:42.000Z (about 7 years ago)
- Last Synced: 2024-10-12T09:11:46.038Z (about 1 month ago)
- Topics: chrome, cli, experimental, headless, puppeteer, scenario
- Language: JavaScript
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chroco
> `Chroco` operates \`[puppeteer](https://github.com/GoogleChrome/puppeteer/)\` with commandable, pluggable settings.
> `Chroco` [pronounced as _"kuroko"_] means _"black person"/"black clothes"_ in Japanese. [Wikipedia: 黒子](https://en.wikipedia.org/wiki/Kuroko)
> **[Work in Progress] It's a experimental package. Help us.**
## Installation and Usage
### Installation
```bash
$ yarn add chroco
# or
$ npm i chroco
```
### Programmable Usage
```js
const { excecuter } = require('chroco')
executor({
// your options, settings and scenarios
})
```
### CLI Usage
```bash
$ chroco # default, detect `.chrocorc`
# or
$ chroco --config ./path/to/.chrocorc
# or (if you want, you can use yaml file.)
$ chroco --config .chroco.yml
```
Default value is `.chrocorc`.
refs: [.chrocorc](./sample/.chrocorc) or [.chrocorc.yml](./sample/.chrocorc.yml)
### Chroco Configure
Configure should be `Object`.
|parms|detail|type|val|required|
|-----|------|----|---|--------|
|`options`|refs: [puppeteer launch options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#puppeteerlaunchoptions)|Object| - |none|
|`options.logLevel`|Chroco original options| Array.\\|string | `['info', 'warn', 'error']`|none|
|emulateOptions|refs: [puppeteer emulate options](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pageemulateoptions)|Object| - |none|
|receivers|Your Customized Receiver, [sample](./sample/search.js)| Array.\ | - | none |
|scenarios|Your commandable, iterable `Array`| Array.\.\| - |required|
#### Scenarios \
- `scenarios[n].` is puppeteer's "`class: Page`" method.
- `scenarios[n]..` is `params` for above method.
```js
{
scenarios: [
goto: [
'https://www.google.com',
{ waitUntil: 'load' }
],
screenshot: {
path: 'temp/screenshot.png',
fullPage: true
}
]
}
```
This commands executes ...
```js
/**
* Before commands executed,
* Chroco executes launching Chrome instance and
* delivering `puppeteer's page: class` to commands as internal param.
*/
// const chrome = await puppeteer.launc()
// const page = await chrome.newPage()
await page.goto(
'https://www.google.com',
{ waitUntil: 'load' }
)
await page.screenshot({
path: 'temp/screenshot.png',
fullPage: true
})
```
Each Scenario's key is mapped to [`class: Page`](https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#class-page) method with `puppeteer`.