Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bconnorwhite/lerna-npm-proxy
Serve local packages without publishing
https://github.com/bconnorwhite/lerna-npm-proxy
lerna monorepo npm yarn yarn-workspaces
Last synced: 22 days ago
JSON representation
Serve local packages without publishing
- Host: GitHub
- URL: https://github.com/bconnorwhite/lerna-npm-proxy
- Owner: bconnorwhite
- Created: 2021-07-12T01:23:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-11-30T01:44:28.000Z (about 3 years ago)
- Last Synced: 2024-03-23T16:21:41.309Z (11 months ago)
- Topics: lerna, monorepo, npm, yarn, yarn-workspaces
- Language: TypeScript
- Homepage: https://connorwhite.org/github/lerna-npm-proxy
- Size: 184 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
lerna-npm-proxy
> Serve Lerna packages without publishing to a registry.
## Installation
```sh
yarn add lerna-npm-proxy
```
```sh
npm install lerna-npm-proxy
```
## Installation
```sh
yarn add lerna-npm-proxy
```
```sh
npm install lerna-npm-proxy
```
## CLI Usage
Running the server will allow you to use `http://localhost:4873` to serve packages in your Lerna monorepo:
```sh
yarn lerna-npm-proxy
```
Then, in another terminal window:
```sh
yarn add @my-org/my-package --registry http://localhost:4873
```
This is especially useful for installing packages inside a docker container during development.
### CLI Options
```
Usage: lerna-npm-proxy [options]
Serve Lerna packages as an NPM proxy.
Options:
-v --version Output the version number
-p --port Port to listen on. Default: 4873
-r --registry Registry to proxy from
-s --silent Prevent logging. Default: false
-w --while Script to run once server starts. Server will be killed once the script exits.
-h --help Display help for command
Commands:
help [command] Display help for command
```
## Node API
```ts
import { start } from "lerna-npm-proxy";
start();
```
### Types
```ts
import { start, Options, FastifyInstance } from "lernal-npm-proxy";
function start(options?: Options): Promise<FastifyInstance>;
type Options = {
/**
* Port to listen on. Default: 4873.
*/
port?: number;
/**
* Registry to proxy from.
*/
registry?: string;
/**
* Prevent logging. Default: false.
*/
silent?: boolean;
/**
* Script to run once server starts. Server will be killed once the script exits.
* This also disables server logging.
* NOTE: this is passed directly to `child_process.spawn`.
*/
while?: string;
};
```
<br />
<h2>Dependencies<img align="right" alt="dependencies" src="https://img.shields.io/david/bconnorwhite/lerna-npm-proxy.svg"></h2>
- [@bconnorwhite/exec](https://www.npmjs.com/package/@bconnorwhite/exec): Execute commands while keeping flags easily configurable as an object
- [chalk](https://www.npmjs.com/package/chalk): Terminal string styling done right
- [commander-version](https://www.npmjs.com/package/commander-version): A wrapper for Commander that automatically sets the version based on your package.json
- [fastify](https://www.npmjs.com/package/fastify): Fast and low overhead web framework, for Node.js
- [fastify-http-proxy](https://www.npmjs.com/package/fastify-http-proxy): proxy http requests, for Fastify
- [package-run](https://www.npmjs.com/package/package-run): Node API for running package.json scripts
- [pacote](https://www.npmjs.com/package/pacote): JavaScript package downloader
- [parse-json-object](https://www.npmjs.com/package/parse-json-object): Parse a typed JSON object
- [sha](https://www.npmjs.com/package/sha): Check and get file hashes
- [which-pm-lockfile](https://www.npmjs.com/package/which-pm-lockfile): Check if a project uses yarn, npm, or pnpm
<br />
<h2>Peer Dependencies<img align="right" alt="David" src="https://img.shields.io/david/peer/bconnorwhite/lerna-npm-proxy.svg"></h2>
- [lerna](https://www.npmjs.com/package/lerna): A tool for managing JavaScript projects with multiple packages.
<br />
<h2>Dev Dependencies<img align="right" alt="David" src="https://img.shields.io/david/dev/bconnorwhite/lerna-npm-proxy.svg"></h2>
- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for TypeScript projects
- [@types/node](https://www.npmjs.com/package/@types/node): TypeScript definitions for Node.js
- [@types/pacote](https://www.npmjs.com/package/@types/pacote): TypeScript definitions for pacote
- [@types/sha](https://www.npmjs.com/package/@types/sha): TypeScript definitions for sha
<br />
<h2>License <img align="right" alt="license" src="https://img.shields.io/npm/l/lerna-npm-proxy.svg"></h2>
[MIT](https://opensource.org/licenses/MIT)