conventional-changelog-preset-loader

conventional-changelog-preset-loader

Configuration preset loader for conventional-changelog.

Usage

Install:

# yarn
yarn add -D conventional-changelog-preset-loader
# pnpm
pnpm add -D conventional-changelog-preset-loader
# npm
npm i -D conventional-changelog-preset-loader

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

const { loadPreset } = require('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:

const { createPresetLoader } = require('conventional-changelog-preset-loader')

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:

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:

const { loadPreset } = require('conventional-changelog-preset-loader')

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

License

MIT © Steve Mao