Registry / devops / conventional-changelog-eslint

conventional-changelog-eslint

library6.1.0jsnpmunverified

ESLint preset for conventional-changelog. Generates changelogs from Git commits following the ESLint convention (Fix, Update, New, Breaking, Docs, Build, Upgrade, Chore). Current stable version 6.1.0, released as part of the conventional-changelog monorepo. ESM-only, requires Node >=18. Compared to other presets (e.g., angular, conventionalcommits), this preset enforces ESLint-specific tags and format.

devops

npm install conventional-changelog-eslint

github ↗package ↗

INSTALL

IMPORT

SIG · CONVENTIONAL-CHANG

conventional-changelog-eslint

devopsjavascriptv6.1.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createPreset

✓ import { createPreset } from 'conventional-changelog-eslint'

✗ const createPreset = require('conventional-changelog-eslint')

Package is ESM-only since v6; CommonJS require() will throw ERR_REQUIRE_ESM.

gitRawCommitsOpts

✓ import { gitRawCommitsOpts } from 'conventional-changelog-eslint'

✗ const { gitRawCommitsOpts } = require('conventional-changelog-eslint')

Named export for configuring git raw commits parsing.

whatBump

✓ import { whatBump } from 'conventional-changelog-eslint'

Function to determine the next semver bump based on commits.

Generate a changelog using the ESLint preset with conventional-changelog.

import { createPreset } from 'conventional-changelog-eslint'; import conventionalChangelog from 'conventional-changelog'; const preset = await createPreset(); const changelogStream = conventionalChangelog({ preset, releaseCount: 1, }); changelogStream.pipe(process.stdout);

Debug

Known issues

breakingv6.x dropped CommonJS support, switched to ESM-only.

fix

Use import syntax and Node >=18. Convert CJS project or use dynamic import().

affects: >=6.0.0

breakingNode.js <18 no longer supported.

fix

Upgrade Node.js to >=18.

affects: >=6.0.0

deprecatedDirect use of `conventional-changelog-eslint` as a string preset name is deprecated; use `createPreset()` function instead.

fix

Import and call `createPreset()` to get the preset object.

affects: >=6.0.0

gotchaCommit messages must follow the exact ESLint tag format (e.g., 'Fix: '). Non-conforming commits may be parsed incorrectly.

fix

Ensure commits use one of: Fix, Update, New, Breaking, Docs, Build, Upgrade, Chore.

affects: all

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module /path/node_modules/conventional-changelog-eslint/index.js from /path/project.js not supported.

Trying to require() an ESM-only package.

fix

Use import instead: `import { createPreset } from 'conventional-changelog-eslint'`

TypeError: preset is not a function

Passing the string 'eslint' as preset to conventional-changelog instead of using createPreset().

fix

Use `const preset = await createPreset();` and pass the returned object.

Upgrade

Version history

6.1.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/conventional-changelog/conventional-changelog ↗

packagehttps://www.npmjs.com/package/conventional-changelog-eslint ↗