https://github.com/krakenjs/grabthar
Hot install and activation of npm modules
https://github.com/krakenjs/grabthar
Last synced: 2 months ago
JSON representation
Hot install and activation of npm modules
- Host: GitHub
- URL: https://github.com/krakenjs/grabthar
- Owner: krakenjs
- License: apache-2.0
- Archived: true
- Created: 2018-04-10T07:51:54.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-03-28T15:55:01.000Z (over 2 years ago)
- Last Synced: 2025-04-11T19:43:41.984Z (3 months ago)
- Language: JavaScript
- Size: 292 KB
- Stars: 23
- Watchers: 10
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[![build status][build-badge]][build]
[![code coverage][coverage-badge]][coverage]
[![npm version][version-badge]][package]
[![apache license][license-badge]][license]
[build-badge]: https://img.shields.io/github/actions/workflow/status/krakenjs/grabthar/main.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/krakenjs/grabthar/actions/workflows/main.yml?query=workflow:build
[coverage-badge]: https://img.shields.io/codecov/c/github/krakenjs/grabthar.svg?style=flat-square
[coverage]: https://codecov.io/github/krakenjs/grabthar
[version-badge]: https://img.shields.io/npm/v/grabthar.svg?style=flat-square
[package]: https://www.npmjs.com/package/grabthar
[license-badge]: https://img.shields.io/npm/l/grabthar.svg?style=flat-square
[license]: https://github.com/krakenjs/grabthar/blob/main/LICENSE
## Do it live
Because npm installing in production every 30 seconds is a great idea, right? ...right?
## Quick Start
```bash
npm install --save @krakenjs/grabthar
```
## Examples
Hot deploy and serve up static files:
```javascript
import { poll } from "@krakenjs/grabthar";
let watcher = poll({
name: "my-live-updating-module",
});
app.get("/foo.js", async function handleRequest(req, res) {
const { modulePath } = await watcher.get();
res.sendFile(`${modulePath}/dist/foo.js`);
});
```
Or if you're feeling _really_ brave, hot deploy and require new code:
```javascript
import { poll } from "@krakenjs/grabthar";
let watcher = poll({
name: "my-live-updating-module",
});
app.get("/api/foo", async function handleRequest(req, res) {
const { getFoo } = await watcher.import();
res.json(getFoo());
});
```
## Deploying
By default `grabthar` will use the current `latest` tag of your chosen module, from npm.
So, to deploy and activate new code, just:
```bash
npm version patch;
npm publish;
```
This will automatically set the `latest` tag to the latest version.
## Deploying and activating in different steps
To separate out the deployment and activation of new code, you can make use of different npm dist-tags:
```javascript
import { poll } from "@krakenjs/grabthar";
let watcher = poll({
name: "my-live-updating-module",
tags: ["latest", "release"],
});
app.get("/foo.js", async function handleRequest(req, res) {
const { modulePath } = await watcher.get("release");
res.sendFile(`${modulePath}/dist/foo.js`);
});
```
To deploy:
```bash
npm version patch;
npm publish;
```
To activate:
```bash
npm dist-tag add [email protected] release
```
`grabthar` will monitor and install anything passed in `tags`, but the activated version will only change when you set a new `release` dist tag.
## Rolling back to old versions
Just change the dist-tag to whatever version you want to roll back to:
```bash
npm dist-tag add [email protected] latest
```
or:
```bash
npm dist-tag add [email protected] release
```
## What else will `watcher.get()` return?
```javascript
const {
// The root directory where the module is installed, e.g.
// /Users/zippy/__live_modules__/my-live-updating-module_1.3.53
moduleRoot,
// The full path to the node_modules installed, e.g.
// /Users/zippy/__live_modules__/my-live-updating-module_1.3.53/node_modules/
nodeModulesPath,
// The full path to your module, e.g.
// /Users/zippy/__live_modules__/my-live-updating-module_1.3.53/node_modules/my-live-updating-module
modulePath,
// The semver version of your module that is currently installed and activated, e.g.
// 1.3.53
version,
// A map of the dependencies of your module, e.g.
// { foo: '1.2.3', bar: '0.45.2' }
dependencies,
} = await watcher.get();
```
## How can I cancel a watcher?
```javascript
watcher.cancel();
```
### Tests
- Run the tests:
```bash
npm test
```