https://github.com/perry-mitchell/linkmon

NPM link monitor CLI utility
https://github.com/perry-mitchell/linkmon

cli cli-utility link monitor npm npm-link symlink utility

Last synced: 3 months ago
JSON representation

NPM link monitor CLI utility

• Host: GitHub
• URL: https://github.com/perry-mitchell/linkmon
• Owner: perry-mitchell
• License: mit
• Created: 2019-10-06T19:39:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-26T14:47:32.000Z (about 4 years ago)
• Last Synced: 2024-10-08T23:41:07.852Z (4 months ago)
• Topics: cli, cli-utility, link, monitor, npm, npm-link, symlink, utility
• Language: JavaScript
• Size: 65.4 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# linkmon

> NPM link monitor CLI utility

![linkmon monitoring directories](screenshot.jpg)

## About

Monitor and display NPM-linked project dependencies in the terminal. Watches directories and displays linked projects so you can keep track of what is linked where.

Why? I frequently find that some operations result in npm stripping my linked modules and replacing them with copies from the registry, which can be very frustrating during development across multiple libraries. This project provides aid by showing you all links so you can keep track of what is linked where.

**`linkmon` can also notify you when a linked dependency becomes unlinked!**

## Installation

Install by running `npm install -g linkmon`, if you intend on using it as a CLI utility. Install it for use within a project by running `npm install linkmon --save`.

## Usage

`linkmon` id designed as a CLI utility first:

```

Usage: linkmon [options] [arguments]

    Watch a directory:

        linkmon ~/programming/projects

    Watch multiple directories, with notifications:

        linkmon /Users/lucy/git ~/temp/my-project --notify

    Custom watch interval (30 seconds):

        linkmon some-dir --interval=30

Options:

    --interval=             Watch interval, in seconds, for monitoring

                            the provided project directories. Defaults

                            to 15 seconds.

    --notify                Enable operating-system notifications. Is

                            disabled by default. Requires a GUI such

                            as Mac OS or Windows.

Arguments:

    Provide one or more directories for scanning and monitoring. A

    directory can either contain one or more further directories that

    house NodeJS projects, or can be a NodeJS project itself. A

    directory is classified as a NodeJS project if it contains a

    package.json file and a node_modules directory.

```

### NodeJS API

`linkmon` can be used as a NodeJS API as well:

```javascript

const { scanLinks } = require("linkmon");

(async function() {

    const links = await scanLinks("../");

    // links look like the following:

    // {

    //     parent: "my-lib",

    //     parentVersion: "0.3.4",

    //     linkedPackage: "@company/package",

    //     linkedPackageVersion: "5.3.12",

    //     link: "/Users/joe/work/package-dev",

    //     path: "/Users/joe/work/my-lib"

    // }

})();

```