Package Exports

@pabueco/ncl
@pabueco/ncl/src/index.ts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@pabueco/ncl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ncl

nice changelog

ncl provides a quick and easy way to view the relevant changelog entries or GitHub releases for dependencies or general GitHub repositories. The main goal was to make dependeny upgrades a bit easier, but you can also use it to explore and discover changes of any GitHub repository.

Since it's aimed at locally installed packages, it makes use of the available package manager to retrieve infos like repository URL and the installed version number of dependencies.

Currently the following package managers are supported:

npm, pnpm, yarn, bun, composer, cargo

Note, that you can work around unsupported package managers by proding the repository name/URL and version (optional) yourself.

Installation

[!NOTE]
Due to the use of built-in modules ncl only works with Bun. You cannot run it with Node.

# Run it directly (like `npx`):
bunx @pabueco/ncl <args>

# Install it globally and run it:
bun i -g @pabueco/ncl
bunx ncl <args>

Usage

# Basic fingerprint:
ncl <package> [<version-or-range>]

# Viewing the changelog entries between the locally installed and the latest available version:
ncl <pkg>

# Locally installed version up until version 4.x:
ncl <pkg> ..4.x

# Version 2 - 4
ncl <pkg> 2..4

# Only version 3.5.x
ncl <pkg> 3.5

# All versions from 4
ncl <pkg> 4..

# You can also use more complex semver ranges, but they need to be escaped in most terminals:
ncl <pkg> "\>2.3 \<=2.8"

When specifying a version range you can use between 2 and 4 dots (e.g. 2..3 or 2....4), so use what feels best for you.

Advanced usage

# View changes of any repo without needing to have the dependency installed locally:
ncl vuejs/core
ncl https://github.com/vuejs/core
ncl https://raw.githubusercontent.com/vuejs/core/main/changelogs/CHANGELOG-3.2.md

# Change the order of changes:
ncl <pkg> --order desc

# Print all changelog entries once instead of viewing them interactively:
ncl <pkg> --list

Options

There are a few options available to configure the behaviour if you want to.

Run ncl --help to see all available options.