\n\n \n\n# xchangelog (@-xun/changelog)\n\n\n\nThis [conventional-changelog-core][1] fork slightly tweaks the original to fix\nsome bugs and bundle type definitions that are more well-formed.\n\nAmong the bugs fixed by this fork is one where [conventional-changelog-core][1],\nwhen given a release commit with multiple tags, will only accept the first tag\nin the list as the version tag if it matches (i.e. starts with\n[`tagPrefix`][4]). Without this fix, when the _actual_ matching version tag is\nnot first in the list, strange things happen.\n\nMultiple tags on the same release commit is useful when, for instance, you\ntransmute a polyrepo into a monorepo and need to alias the original\n`v${version}`-style tags with the more monorepo-friendly\n`${package-name}@${version}`-style tags.\n\n> [!NOTE]\n>\n> The only reason to use xchangelog over [conventional-changelog-core][1] is if\n> you are using an [symbiote][2]-powered project or you need the bug fixes.\n> Otherwise, just use [conventional-changelog][1].\n\n\n\n---\n\n\n\n\n\n\n- [Install](#install)\n- [Usage](#usage)\n- [Appendix](#appendix)\n - [Published Package Details](#published-package-details)\n - [License](#license)\n- [Contributing and Support](#contributing-and-support)\n - [Contributors](#contributors)\n\n\n\n\n\n \n\n## Install\n\n\n\nTo install xchangelog:\n\n```shell\nnpm install --save-dev @-xun/changelog\n```\n\nIf you want to use a specific version of xchangelog, provide its semver:\n\n```shell\nnpm install @-xun/changelog\n```\n\n> [!NOTE]\n>\n> xchangelog installations can reuse the \"conventional-changelog-core\" name so\n> that plugins with conventional-changelog-core as a peer dependency are able to\n> recognize xchangelog's presence. For example:\n>\n> ```bash\n> npm install --save-dev conventional-changelog-core@npm:@-xun/changelog\n> ```\n\n## Usage\n\n```js\nimport conventionalChangelogCore from '@-xun/changelog';\n\nconventionalChangelogCore().pipe(process.stdout); // or any writable stream\n```\n\n\n\n## Appendix\n\n\n\nSee the [`conventionalChangelogCore`][3] upstream documentation for more\ndetails.\n\n\n\n### Published Package Details\n\nThis is an [ESM-only package][x-pkg-esm-wine] for use in Node.js versions that\nare not end-of-life. For TypeScript users, this package supports both `\"Node10\"`\nand `\"Node16\"` module resolution strategies.\n\n\n\n\nExpand details\n\nThat means ESM source will load this package via `import { ... } from ...` or\n`await import(...)` and CJS source will load this package via dynamic\n`import()`. This has several benefits, the foremost being: less code\nshipped/smaller package size, avoiding [dual package\nhazard][x-pkg-dual-package-hazard] entirely, distributables are not\npacked/bundled/uglified, and a drastically less complex build process.\n\nThe glaring downside, which may or may not be relevant, is that CJS consumers\ncannot `require()` this package and can only use `import()` in an asynchronous\ncontext. This means, in effect, CJS consumers may not be able to use this\npackage at all.\n\nEach entry point (i.e. `ENTRY`) in [`package.json`'s\n`exports[ENTRY]`][x-repo-package-json] object includes one or more [export\nconditions][x-pkg-exports-conditions]. These entries may or may not include: an\n[`exports[ENTRY].types`][x-pkg-exports-types-key] condition pointing to a type\ndeclaration file for TypeScript and IDEs, a\n[`exports[ENTRY].module`][x-pkg-exports-module-key] condition pointing to\n(usually ESM) source for Webpack/Rollup, a `exports[ENTRY].node` and/or\n`exports[ENTRY].default` condition pointing to (usually CJS2) source for Node.js\n`require`/`import` and for browsers and other environments, and [other\nconditions][x-pkg-exports-conditions] not enumerated here. Check the\n[package.json][x-repo-package-json] file to see which export conditions are\nsupported.\n\nNote that, regardless of the [`{ \"type\": \"...\" }`][x-pkg-type] specified in\n[`package.json`][x-repo-package-json], any JavaScript files written in ESM\nsyntax (including distributables) will always have the `.mjs` extension. Note\nalso that [`package.json`][x-repo-package-json] may include the\n[`sideEffects`][x-pkg-side-effects-key] key, which is almost always `false` for\noptimal [tree shaking][x-pkg-tree-shaking] where appropriate.\n\n\n\n\n\n\n### License\n\n\n\nSee [LICENSE][x-repo-license].\n\n\n\n## Contributing and Support\n\nConsider contributing to upstream [conventional-changelog][1] instead.\n\n\n\n\n### Contributors\n\n\n\n\n\n\n[](#contributors-)\n\n\n\n\nThanks goes to these wonderful people ([emoji\nkey][x-repo-all-contributors-emojis]):\n\n\n\n\n\n\n
![](\"https://raw.githubusercontent.com/Xunnamius/xchangelog/refs/heads/main/logo.png\"){kind=logo}
\n![\"Bernard\"/](\"https://avatars.githubusercontent.com/u/656017?v=4?s=100\")
![](\"https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg\"){kind=logo}
\n Add your contributions\n \n