Package Health Score

66 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
1.0.1	\|	03/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1)

GitHub Stars: 16.65K
Forks: 892
Contributors: 240

Direct Usage Popularity

The npm package commitlint-config-apollus receives a total of 1 downloads a week. As such, we scored commitlint-config-apollus popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package commitlint-config-apollus, we found that it has been starred 16,649 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 240
Funding: No

A good and healthy external contribution signal for commitlint-config-apollus project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 154
Open PR: 20
Last Release: 5 years ago
Last Commit: 2 months ago

Further analysis of the maintenance status of commitlint-config-apollus based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for commitlint-config-apollus is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=8

Age: 5 years
Dependencies: 0 Direct
Versions: 2
Install Size: 610 kB
Dist-tags: 1
# of Files: 177
Maintainers: 1
TS Typings: Yes

commitlint-config-apollus has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Get Started | Let's chat | Website

> Lint commit messages

> Demo generated with svg-term-cli > > cat docs/assets/commitlint.json | svg-term --out docs/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

🚓 Be a good commitizen
📦 Share configuration via npm
🤖 Tap into conventional-changelog

What is commitlint

commitlint checks if your commit messages meet the conventional commit format.

In general the pattern mostly looks like this:

type(scope?): subject  #scope is optional

Real world examples can look like this:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Common types according to commitlint-config-conventional (based on the the Angular convention) can be:

build
ci
chore
docs
feat
fix
perf
refactor
revert
style
test

These can be modified by your own configuration.

Benefits using commitlint

Getting started

# Install commitlint cli and conventional config
npm install --save-dev @commitlint/{config-conventional,cli}
# For Windows:
npm install --save-dev @commitlint/config-conventional @commitlint/cli

# Configure commitlint to use conventional config
echo "module.exports = {extends: ['@commitlint/config-conventional']}" &gt; commitlint.config.js

To lint commits before they are created you can use Husky's 'commit-msg' hook:

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

Detailed Setup instructions

Local setup - Lint messages on commit with husky
CI setup - Lint messages during CI builds

CLI

Primary way to interact with commitlint.
npm install --save-dev @commitlint/cli
Packages: cli

Config

Configuration is picked up from commitlint.config.js, .commitlintrc.js, .commitlintrc.json, or .commitlintrc.yml file or a commitlint field in package.json
Packages: cli, core
See Rules for a complete list of possible rules
An example configuration can be found at @commitlint/config-conventional

Shared configuration

A number of shared configurations are available to install and use with commitlint:

> ⚠️ If you want to publish your own shareable config then make sure it has a name aligning with the pattern commitlint-config-emoji-log or commitlint-config-your-config-name — then in extend all you have to write is emoji-log or your-config-name.

API

Alternative, programmatic way to interact with commitlint
Packages:
- format - Format commitlint reports
- lint - Lint a string against commitlint rules
- load - Load shared commitlint configuration
- read - Read commit messages from a specified range or last edit
See API for a complete list of methods and examples

Tools

Roadmap

> Ideas: conventional-changelog/commitlint#94

commitlint is considered stable and is used in various projects as development tool.

We identify ease of adoption and developer experience as fields where there is room and need for improvement. The items on the roadmap should enhance commitlint regarding those aspects.

[x] Adoption: Provide reusable Travis CI integration: @commitlint/travis-cli (https://github.com/conventional-changelog/commitlint/releases/tag/v5.1.0)
[ ] DX: Support PR squash scenario via ahmed-taj/commitlint-bot and @commitlint/travis-cli
[ ] Adoption: Make ahmed-taj/commitlint-bot configurable via commitlint configuration
[ ] Adoption: Create commitlint init
[ ] DX: Extend the configuration schema to allow for additional fields (descriptions, examples, fixes) on both the rule and value level
[ ] DX: Incorporate an extended version of lennym/commit-template deducing a template from commitlint configuration
[ ] DX: Rewrite @commitlint/prompt for better usability (might involve a lot of yak-shaving)

Version Support

Node.js LTS >= 8
git >= 2.13.2

Related projects

conventional-changelog – Generate a changelog from conventional commit history
commitizen – Simple commit conventions for internet citizens
create-semantic-module – CLI for quickly integrating commitizen and commitlint in new or existing projects
commitlint.io - helps your project to ensures nice and tidy commit messages without needing any download or installation

License

Development

commitlint is developed in a mono repository.

Install and run

git clone git@github.com:conventional-changelog/commitlint.git
cd commitlint
yarn
yarn run build # run build tasks
yarn start # run tests, again on change

For more information on how to contribute please take a look at our contribution guide.

Publishing a release

yarn clean
yarn install
yarn run build
yarn test
yarn run publish

commitlint-config-apollus development dependencies

@lerna/project @types/jest @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser docsify-cli eslint eslint-config-prettier eslint-plugin-import eslint-plugin-jest husky jest lerna lerna-v2 lerna-v3 lint-staged prettier ts-jest typescript

FAQs

What is commitlint-config-apollus?

Lint commit messages. Visit Snyk Advisor to see a full health score report for commitlint-config-apollus, including popularity, security, maintenance & community analysis.

Is commitlint-config-apollus popular?

The npm package commitlint-config-apollus receives a total of 1 weekly downloads. As such, commitlint-config-apollus popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is commitlint-config-apollus well maintained?

We found indications that commitlint-config-apollus is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is commitlint-config-apollus safe to use?

The npm package commitlint-config-apollus was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 8 November-2024, at 12:55 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Get Started | Let's chat | Website

Contents

What is commitlint

Benefits using commitlint

Getting started

CLI

Config

Shared configuration

API

Tools

Roadmap

Version Support

Related projects

License

Development

Install and run

Publishing a release

commitlint-config-apollus development dependencies

FAQs

What is commitlint-config-apollus?

Is commitlint-config-apollus popular?

Is commitlint-config-apollus well maintained?

Is commitlint-config-apollus safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues