@-xun/changelog NPM

xchangelog (@-xun/changelog)

This conventional-changelog-core fork slightly tweaks the original to fix some bugs and bundle type definitions that are more well-formed.

Among the bugs fixed by this fork is one where conventional-changelog-core, when given a release commit with multiple tags, will only accept the first tag in the list as the version tag if it matches (i.e. starts with tagPrefix). Without this fix, when the actual matching version tag is not first in the list, strange things happen.

Multiple tags on the same release commit is useful when, for instance, you transmute a polyrepo into a monorepo and need to alias the original v${version}-style tags with the more monorepo-friendly ${package-name}@${version}-style tags.

!NOTE
The only reason to use xchangelog over conventional-changelog-core is if you are using an symbiote-powered project or you need the bug fixes. Otherwise, just use conventional-changelog.

Install

To install xchangelog:

npm install --save-dev @-xun/changelog

If you want to use a specific version of xchangelog, provide its semver:

npm install @-xun/changelog

!NOTE
xchangelog installations can reuse the "conventional-changelog-core" name so that plugins with conventional-changelog-core as a peer dependency are able to recognize xchangelog's presence. For example:
npm install --save-dev conventional-changelog-core@npm:@-xun/changelog

Usage

import conventionalChangelogCore from '@-xun/changelog';

conventionalChangelogCore().pipe(process.stdout); // or any writable stream

Appendix

See the conventionalChangelogCore upstream documentation for more details.

Published Package Details

This is an ESM-only package for use in Node.js versions that are not end-of-life. For TypeScript users, this package supports both "Node10" and "Node16" module resolution strategies.

That means ESM source will load this package via import { ... } from ... or await import(...) and CJS source will load this package via dynamic import(). This has several benefits, the foremost being: less code shipped/smaller package size, avoiding dual package hazard entirely, distributables are not packed/bundled/uglified, and a drastically less complex build process.

The glaring downside, which may or may not be relevant, is that CJS consumers cannot require() this package and can only use import() in an asynchronous context. This means, in effect, CJS consumers may not be able to use this package at all.

Each entry point (i.e. ENTRY) in package.json's exports[ENTRY] object includes one or more export conditions. These entries may or may not include: an exports[ENTRY].types condition pointing to a type declaration file for TypeScript and IDEs, a exports[ENTRY].module condition pointing to (usually ESM) source for Webpack/Rollup, a exports[ENTRY].node and/or exports[ENTRY].default condition pointing to (usually CJS2) source for Node.js require/import and for browsers and other environments, and other conditions not enumerated here. Check the package.json file to see which export conditions are supported.

Note that, regardless of the { "type": "..." } specified in package.json, any JavaScript files written in ESM syntax (including distributables) will always have the .mjs extension. Note also that package.json may include the sideEffects key, which is almost always false for optimal tree shaking where appropriate.