Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fiveisprime/screpl
A pluggable command line based scraper with REPL support.
https://github.com/fiveisprime/screpl
Last synced: about 2 months ago
JSON representation
A pluggable command line based scraper with REPL support.
- Host: GitHub
- URL: https://github.com/fiveisprime/screpl
- Owner: fiveisprime
- License: isc
- Created: 2014-01-31T03:55:18.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-09-29T22:19:38.000Z (almost 10 years ago)
- Last Synced: 2024-07-19T07:37:10.561Z (2 months ago)
- Language: JavaScript
- Homepage: http://npm.im/screpl
- Size: 1.52 MB
- Stars: 30
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SCREPL [](https://travis-ci.org/fiveisprime/screpl) [](http://badge.fury.io/js/screpl)
======
A pluggable command line based scraper with REPL support.
# Installation
```
> npm install screpl -g
```
# Usage
Pass a URL to SCREPL then use the `$` variable as a jQuery object.
```shell
Usage: screpl
Options:
-h, --help output usage information
-V, --version output the version number
-r, --require require a plugin module
```
# Plugins
Check out the plugin example in the examples directory.
Plugins are node modules that expose a function which accepts the REPL context.
Attach variables and functions to the context to make them accessible at
run-time.
```javascript
module.exports = function(context) {
context.getText = function() {
//
// Access the jQuery object from within the plugin.
//
context.$('p').each(function() {
out.push(this.text());
});
//
// The return value will be written to standard out.
//
return out.join(' ');
};
};
```
Require your plugin using the `--require` option.
```shell
$ screpl http://example.com --require plugin.js
request loaded with 200
use the variable `$` to access the result
> getText()
'\nWelcome to exmaple.com.\nChances...'
```
### Plugins Already Available
```
writeFile($("body").html(), 'index.html')
postHttp($("body").html(), 'http://yourserver.com')
```
**Variables and functions exposed through plugins will autocomplete.**
# License
Copyright (c) 2014, Matt Hernandez
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.