Generated on Feb 29, 2024 via pnpm

Npm

Home

@commitlint/cli 17.8.1

Lint your commit messages

conventional-changelog

commitlint

cli

Package summary

issues

licenses

Package created

10 Jul 2017

Version published

20 Oct 2023

Maintainers

Total deps

198

Direct deps

License

MIT

Issues

1 high severity issue

high

spdx-exceptions@2.5.0

Package uses an atypical license ("CC-BY-3.0")

Recommendation: Read and validate the license terms

via: @commitlint/lint@17.8.1 & others

Collapse

Expand

2 low severity issues

low

spdx-exceptions@2.5.0

Package uses a license that is not OSI approved ("CC-BY-3.0")

Recommendation: Read and validate the license terms

via: @commitlint/lint@17.8.1 & others

spdx-license-ids@3.0.17

Package uses a license that is not OSI approved ("CC0-1.0")

Recommendation: Read and validate the license terms

via: @commitlint/lint@17.8.1 & others

Collapse

Expand

Licenses

MIT License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

sublicense

private-use

Cannot

hold-liable

Must

include-copyright

include-license

162 Packages, Including:

@babel/code-frame@7.23.5

@babel/helper-validator-identifier@7.22.20

@babel/highlight@7.23.4

@commitlint/cli@17.8.1

@commitlint/config-validator@17.8.1

@commitlint/ensure@17.8.1

@commitlint/execute-rule@17.8.1

@commitlint/format@17.8.1

@commitlint/is-ignored@17.8.1

@commitlint/lint@17.8.1

@commitlint/load@17.8.1

@commitlint/message@17.8.1

@commitlint/parse@17.8.1

@commitlint/read@17.8.1

@commitlint/resolve-extends@17.8.1

@commitlint/rules@17.8.1

@commitlint/to-lines@17.8.1

@commitlint/top-level@17.8.1

@commitlint/types@17.8.1

@cspotcode/source-map-support@0.8.1

@jridgewell/resolve-uri@3.1.2

@jridgewell/sourcemap-codec@1.4.15

@jridgewell/trace-mapping@0.3.9

@tsconfig/node10@1.0.9

@tsconfig/node12@1.0.11

@tsconfig/node14@1.0.3

@tsconfig/node16@1.0.4

@types/minimist@1.2.5

@types/node@20.5.1

@types/normalize-package-data@2.4.4

acorn-walk@8.3.2

acorn@8.11.3

ajv@8.12.0

ansi-regex@5.0.1

ansi-styles@3.2.1

ansi-styles@4.3.0

arg@4.1.3

array-ify@1.0.0

arrify@1.0.1

callsites@3.1.0

camelcase-keys@6.2.2

camelcase@5.3.1

chalk@2.4.2

chalk@4.1.2

color-convert@1.9.3

color-convert@2.0.1

color-name@1.1.3

color-name@1.1.4

compare-func@2.0.0

conventional-commits-parser@4.0.0

ISC License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

Cannot

hold-liable

Must

include-copyright

include-license

21 Packages, Including:

cliui@8.0.1

conventional-changelog-angular@6.0.0

get-caller-file@2.0.5

graceful-fs@4.2.11

hosted-git-info@2.8.9

hosted-git-info@4.1.0

inherits@2.0.4

ini@1.3.8

isexe@2.0.0

lru-cache@6.0.0

make-error@1.3.6

semver@5.7.2

semver@7.5.4

semver@7.6.0

signal-exit@3.0.7

split2@3.2.2

which@2.0.2

y18n@5.0.8

yallist@4.0.0

yargs-parser@20.2.9

yargs-parser@21.1.1

Apache License 2.0

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

sublicense

private-use

use-patent-claims

place-warranty

Cannot

hold-liable

use-trademark

Must

include-copyright

include-license

state-changes

include-notice

4 Packages, Including:

human-signals@2.1.0

spdx-correct@3.2.0

typescript@5.3.3

validate-npm-package-license@3.0.4

BSD 2-Clause "Simplified" License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

place-warranty

Cannot

hold-liable

Must

include-copyright

include-license

3 Packages, Including:

normalize-package-data@2.5.0

normalize-package-data@3.0.3

uri-js@4.4.1

(MIT OR CC0-1.0)

Public Domain

3 Packages, Including:

type-fest@0.18.1

type-fest@0.6.0

type-fest@0.8.1

(MIT OR Apache-2.0)

Permissive

1 Packages, Including:

JSONStream@1.3.5

Python License 2.0

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

Cannot

use-trademark

hold-liable

Must

include-copyright

include-license

state-changes

1 Packages, Including:

argparse@2.0.1

BSD 3-Clause "New" or "Revised" License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

place-warranty

Cannot

use-trademark

hold-liable

Must

include-copyright

include-license

1 Packages, Including:

diff@4.0.2

Creative Commons Attribution 3.0 Unported

Uncategorized

Not OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

Cannot

Must

1 Packages, Including:

spdx-exceptions@2.5.0

Creative Commons Zero v1.0 Universal

Public Domain

Not OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

Cannot

Must

1 Packages, Including:

spdx-license-ids@3.0.17

Direct Dependencies

All Dependencies CSV

ⓘ This is a list of @commitlint/cli 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.

Name	Version	Size	License	Type	Vulnerabilities
@commitlint/format	17.8.1	4.42 kB	MIT	prod
@commitlint/lint	17.8.1	4.87 kB	MIT	prod	1 2
@commitlint/load	17.8.1	10.26 kB	MIT	prod
@commitlint/read	17.8.1	4.46 kB	MIT	prod	1 2
@commitlint/types	17.8.1	7.74 kB	MIT	prod
execa	5.1.1	14.15 kB	MIT	prod
lodash.isfunction	3.0.9	3.06 kB	MIT	prod
resolve-from	5.0.0	2.28 kB	MIT	prod
resolve-global	1.0.0	1.87 kB	MIT	prod
yargs	17.7.2	64.15 kB	MIT	prod

Tree

Treemap

Frequently Asked Questions

What does @commitlint/cli do?

@commitlint/cli is a valuable tool that helps developers ensure their commit messages adhere to a consistent standard. By parsing and examining historical commit messages, it identifies and promptly reports on any patterns that deviate from the predefined standards or templates. With @commitlint/cli, maintaining a clean and well-structured commit history is an easy task, benefiting overall project management and version control.

How do you use @commitlint/cli?

Using @commitlint/cli is fairly straightforward. It is designed to be integrated into your development environment and utilized directly from the command line. Here is a simple guide on how to get started:

Install the tool into your project by using npm:

npm install --save-dev @commitlint/cli @commitlint/config-angular

After successful installation, create a configuration file for commitlint called "commitlint.config.js" in the root directory of your project:

echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js

Now, @commitlint/cli is ready to lint your commit messages based on the rules specified in the config-angular. Please note that the @commitlint/config-angular is an example of a commonly used configuration, but you can extend or adjust it according to the specific needs of your project.

Where are the @commitlint/cli docs?

For a comprehensive guide on how to use @commitlint/cli, including usage examples, additional configuration options, and troubleshooting advice, refer to the official @commitlint/cli docs hosted on the Conventional Changelog website. These docs provide valuable insights and in-depth explanations, ensuring that you can fully unleash the potential of @commitlint/cli in your development workflow.