Registry / devops / commitlint-azure-pipelines-cli

commitlint-azure-pipelines-cli

library1.0.5jsnpmunverified

CLI tool to lint commits in Azure Pipelines using commitlint. Current stable version is 1.0.5 (last updated December 2022, sporadically maintained). Requires @commitlint/cli >=7.0.0 as a peer dependency. Key differentiator: zero configuration needed for Azure Pipelines CI — automatically detects the correct commit range for pull requests and branches, simplifying setup compared to manually specifying commit ranges with commitlint directly.

devops testing

npm install commitlint-azure-pipelines-cli

github ↗package ↗

INSTALL

IMPORT

SIG · COMMITLINT-AZURE-P

commitlint-azure-pipelines-cli

devopsjavascriptv1.0.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

bin/commitlint-azure-pipelines

✓ ./node_modules/.bin/commitlint-azure-pipelines

✗ npx commitlint-azure-pipelines

The package provides a CLI binary, not a JavaScript API. Use the path or run via npx.

commitlintAzurePipelines (if imported as module)

✓ import commitlintAzurePipelines from 'commitlint-azure-pipelines-cli'

✗ const commitlintAzurePipelines = require('commitlint-azure-pipelines-cli')

Though types are shipped, the package is primarily a CLI. The module export is undocumented and may be unstable.

run function (if used programmatically)

✓ const { run } = require('commitlint-azure-pipelines-cli'); run();

✗ import { run } from 'commitlint-azure-pipelines-cli';

The package provides a CommonJS entry; named export 'run' is available, but not a default export. ESM usage may require bundler interop.

Installs and runs commitlint for Azure Pipelines with zero config. Detects commit range based on PR or branch.

# Install dependencies npm install --save-dev @commitlint/cli commitlint-azure-pipelines-cli # Add to azure-pipelines.yml: # steps: # - script: ./node_modules/.bin/commitlint-azure-pipelines

commitlint-azure-pipelines-cli --version

Debug

Known issues

gotchaRequires @commitlint/cli >=7.0.0 as a peer dependency; commitlint older than 7 will not work.

fix

Ensure @commitlint/cli is installed and meets the minimum version: npm install @commitlint/cli@latest

affects: >=1.0.0

gotchaThe CLI binary must be run from the project root directory (where node_modules/.bin is accessible). Running from subdirectories will fail.

fix

Run the script from the repository root or use a full path.

affects: >=1.0.0

gotchaOnly tested against Node.js 10.x and up; may fail on older versions.

fix

Upgrade Node.js to version 10 or higher.

affects: >=1.0.0

Errors

Common errors & fixes

Error: config is not valid JSON: /home/vsts/work/1/s/.commitlintrc.json

commitlint configuration file is malformed or missing.

fix

Create a valid .commitlintrc.json (or .commitlintrc.js) at the repository root. Example: { "extends": ["@commitlint/config-conventional"] }

/usr/local/bin/commitlint-azure-pipelines: line 1: ./node_modules/.bin/commitlint: No such file or directory

commitlint is not installed (missing peer dependency).

fix

Run npm install --save-dev @commitlint/cli to install commitlint.

Cannot find module '@commitlint/format'

Missing commitlint dependency or incorrect version.

fix

Install the full commitlint package: npm install --save-dev @commitlint/cli @commitlint/core

Upgrade

Version history

1.0.5latest on npm

Audit

Dependencies

@commitlint/clirequiredPeer dependency; provides the commitlint engine that performs the actual linting

Agent activity

13 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/princjef/commitlint-azure-pipelines-cli ↗

packagehttps://www.npmjs.com/package/commitlint-azure-pipelines-cli ↗