@commitlint/ensure

What is @commitlint/ensure?

@commitlint/ensure is a utility package that provides functions to validate and ensure certain conditions on strings, such as checking if a string is a valid URL, if it matches a specific pattern, or if it adheres to a certain length. It is commonly used in conjunction with commitlint to enforce commit message conventions.

What are @commitlint/ensure's main functionalities?

isUrl

The `isUrl` function checks if a given string is a valid URL. In this example, it returns `true` for a valid URL.

const { isUrl } = require('@commitlint/ensure');

const result = isUrl('https://example.com');
console.log(result); // true

isLongerThan

The `isLongerThan` function checks if a given string is longer than a specified length. In this example, it returns `true` because 'hello' is longer than 3 characters.

const { isLongerThan } = require('@commitlint/ensure');

const result = isLongerThan('hello', 3);
console.log(result); // true

matches

The `matches` function checks if a given string matches a specified regular expression pattern. In this example, it returns `true` because 'hello' starts with 'h'.

const { matches } = require('@commitlint/ensure');

const result = matches('hello', /^h/);
console.log(result); // true

Other packages similar to @commitlint/ensure

validator

The `validator` package provides a comprehensive set of string validation and sanitization functions. It offers similar functionalities to @commitlint/ensure, such as URL validation, string length checks, and pattern matching, but with a broader range of validation options.

joi

The `joi` package is a powerful schema description language and data validator for JavaScript. While it is more complex and feature-rich compared to @commitlint/ensure, it can be used to validate strings, including checking for patterns, lengths, and formats like URLs.

yup

The `yup` package is a JavaScript schema builder for value parsing and validation. Similar to `joi`, it provides extensive validation capabilities, including string validation, pattern matching, and length checks, making it a more versatile but also more complex alternative to @commitlint/ensure.

README

The README file is missing

Changelog

17.4.0 (2023-01-04)

Bug Fixes

• stop truncating the body in presence of dashes (#3476) (02a61be)
• update dependency ajv to v8.11.2 (#3440) (7829151)
• update dependency ajv to v8.12.0 (#3482) (0a53d97)
• update dependency cosmiconfig to v8 (#3459) (ee732fe)
• update dependency cosmiconfig-typescript-loader to v4.3.0 (#3448) (86b632e)
• update dependency fs-extra to v11 (#3460) (a437923)
• update dependency semver to v7.3.8 (#3441) (7599ad6)
• update dependency typescript to v4.9.4 (#3449) (bf86c7d)
• update dependency yargs to v17.6.2 (#3450) (8a43a05)

Features

• support config .cts extension (#3461) (85ad18b)