conventional-changelog-preset-loader

[![ESM-only package][package]][package-url]
[![NPM version][npm]][npm-url]
[![Node version][node]][node-url]
[![Dependencies status][deps]][deps-url]
[![Install size][size]][size-url]
[![Build status][build]][build-url]
[![Coverage status][coverage]][coverage-url]

[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
[package-url]: https://nodejs.org/api/esm.html

[npm]: https://img.shields.io/npm/v/conventional-changelog-preset-loader.svg
[npm-url]: https://npmjs.com/package/conventional-changelog-preset-loader

[node]: https://img.shields.io/node/v/conventional-changelog-preset-loader.svg
[node-url]: https://nodejs.org

[deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-preset-loader
[deps-url]: https://libraries.io/npm/conventional-changelog-preset-loader/tree

[size]: https://packagephobia.com/badge?p=conventional-changelog-preset-loader
[size-url]: https://packagephobia.com/result?p=conventional-changelog-preset-loader

[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions

[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master

Configuration preset loader for conventional-changelog.

---

Install
  •  
Usage
  •  
Preset package resolution
  •  
Preset exports
  •  
Preset options

---

Install

``bash


pnpm

pnpm add conventional-changelog-preset-loader

yarn

yarn add conventional-changelog-preset-loader

npm

npm i conventional-changelog-preset-loader
`

Usage

Import loadPreset function from the package and use it to load the preset:

`js
import { loadPreset } from 'conventional-changelog-preset-loader'

loadPreset('angular').then((config) => {
// do something with config object
})
`

By default it uses import to load preset. If you want to use require instead, you can create own loader with createPresetLoader function:

`js
import { createRequire } from 'node:module'
import { createPresetLoader } from 'conventional-changelog-preset-loader'

const require = createRequire(import.meta.url)
const loadPreset = createPresetLoader(require)
`

Preset package resolution

Firstly, loader will try prepend conventional-changelog to the preset name and load it.

For example:
- angular => conventional-changelog-angular
- angular/preset/path => conventional-changelog-angular/preset/path
- @scope/angular => @scope/conventional-changelog-angular
- @scope/angular/preset/path => @scope/conventional-changelog-angular/preset/path

If it fails, it will try to load preset using name as is.

Preset exports

Preset package should have default export which is a async (returns Promise) or sync function that accepts optional options object and returns the config object:

`js
export default function createPreset(options) {
return {
// config
}
}
`

Preset options

To pass options to the preset, loadPreset function accepts object with name property as first argument:

`js
import { loadPreset } from 'conventional-changelog-preset-loader'

loadPreset({
name: 'angular',
...presetOptions
}).then((config) => {
// do something with config object
})
``

License

MIT © Steve Mao