https://github.com/gngeorgiev/lrequire
:boom: Live-require npm modules, without installing them first.
https://github.com/gngeorgiev/lrequire
live npm require
Last synced: 10 days ago
JSON representation
:boom: Live-require npm modules, without installing them first.
- Host: GitHub
- URL: https://github.com/gngeorgiev/lrequire
- Owner: gngeorgiev
- Created: 2017-06-05T14:49:03.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-07T13:13:49.000Z (almost 9 years ago)
- Last Synced: 2025-01-17T14:22:28.744Z (over 1 year ago)
- Topics: live, npm, require
- Language: JavaScript
- Homepage:
- Size: 43 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Live-require
[](https://npmjs.org/package/lrequire) [](https://travis-ci.org/gngeorgiev/lrequire) []() [](https://codeclimate.com/github/gngeorgiev/lrequire)
A module which allows you to require and try out npm modules directly without `npm install`-ing them. You can use this to quickly test out different modules in your project, inside a toy project or in the terminal.
# How it works
Modules are downloaded and prepared in a predefined directory(`/tmp` by default) and then required back to you. The modules are cached so only the first time a module is used it might take a little longer to load.
# Configuration
```javascript
const lrequire = require('lrequire');
lrequire.configure({
path: '/tmp/lrequire' //where the modules will be downloaded
})
```
# Programmatic Usage
Basic:
```javascript
const lrequire = require('lrequire');
const validUrl = lrequire('valid-url');
const latestVersion = lrequire('npmjs.org/package/latest-version');
```
Download specific version:
```javascript
const lrequire = require('lrequire');
const validUrl = lrequire('valid-url', {
version: '1.0.8'
});
const latestVersion = lrequire('npmjs.org/package/latest-version', {
version: 'latest' //this is the default
});
```
You can also make `lrequire` global and use it at will. Later, if you wish to keep a package, you can remove the `l` and everything will continue working.
```javascript
require('lrequire').global();
const validUrl = lrequire('valid-url');
const latestVersion = lrequire('npmjs.org/package/latest-version');
```
# Repl Usage
Make sure to install `lrequire` globally:
```bash
$ npm i -g lrequire
```
Execute `lrequire` in your terminal, the `lrequire` function will be available in the newly opened repl which means you can directly start requiring modules. You can also use the `require` function, it will try to require a module and fallback to `lrequire`.
```bash
$ lrequire
> const { markdown } = require('markdown');
> $ markdown.toHTML('Hello *World*!');
'
Hello World!
'
```
# What if you don't want to create files on your filesystem?
On linux consider using [tmpfs](https://wiki.archlinux.org/index.php/tmpfs). You can mount it on `/tmp/lrequire` or even `/tmp` which is a common practice. Don't forget that the directory where the files are saved can be configured.
On MacOS and Windows there are some RamDisk implementations that might work.
# Requirements
Node 8
# API Reference
## lrequire(module, config = {version: 'latest'})
Require a module synchronously.
## lrequire.async(module, config = {version: 'latest'}): Promise\
Require a module asynchronously, the result can be awaited.
## lrequire.asyncCallback(module, config, callback)
Require a module asynchronously, the result is passed as a second argument as per the node.js callback conventions.
## lrequire.config(config = {path: '/tmp/lrequire'})
Configure `lrequire`.
## lrequire.global()
Add `lrequire` to `global`.
## lrequire.config
Get the config object
## lrequire.latestVersionCache
Get the cache which holds the latest version available in npm for each package installed during the application's lifetime.
# License - MIT
The MIT License (MIT)
Copyright (c) 2017 lrequire
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.