0.0.2 • Published 1 year ago

@wr-projects/commitlint-config v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Welcome to the @wr-projects/commitlint-config

Discord Maintainer ./LICENSE Contributor Covenant Codacy Badge https://lift.sonatype.com/ npm.io

Table Of Contents

About the project

Shareable commitlint config enforcing the Angular commit convention. Use with @commitlint/cli

Setup

pnpm install --save-dev @commitlint/cli @wr-projects/commitlint-config

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

Examples

✨ feat(blog): add comment section

Format

<emoji> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Rules

Problems

The following rules are considered problems for and will yield a non-zero exit code when not met. Consult docs/rules for a list of available rules.

type-enum

  • Condition: is found in value type
  • Rule: always
  • Value
[
  "🎉 init",
  "🔖 tag",
  "✨ feat",
  "🐛 bug",
  "💥 breaking",
  "🚑 critical",
  "🩹 fix",
  "🚧 wip",
  "📝 comment",
  "🛂 permissions",
  "🛂 roles",
  "🔒 security",
  "🔐 secrets",
  "💄 design",
  "🎨 animations",
  "🎨 transitions",
  "💎 improve",
  "🐎 perf",
  "♻️ refactor",
  "♿ accessibility",
  "💻 desktop",
  "📱 mobile",
  "📱💻 responsive",
  "🏁 windows",
  "🍎 macOS",
  "🐧 linux",
  "🧪 test",
  "➕ addingtest",
  "📦 build",
  "🚀 deploy",
  "👷 ci",
  "📜 devscripts",
  "📚 docs",
  "🌐 internationalize",
  "🌐 i18n",
  "🌐 localisation",
  "📊 metadata",
  "👕 lint",
  "🏗️ architectural",
  "⚡ generalupdate",
  "⬆️ upgrade",
  "⬇️ downgrade",
  "➕ add",
  "🔥 remove",
  "🚚 move",
  "🚚 rename",
  "➕ adddep",
  "➖removedep",
  "👥 contributor",
  "🐳 docker",
  "🔧 configfile",
  "👽 api",
  "📄 licence",
  "🍱 assets",
  "✏️ gitfile",
  "📸 snapshots",
  "⚗️ experiments",
  "🔍️ seo",
  "🗃️ database",
  "🔀 merge",
  "🔄needforks",
  "⚰️ dead",
  "🗑️ bad"
]
echo "foo: some message" # fails
echo "🩹 fix: some message" # passes

type-case

  • Condition: is in case type value
  • Rule: always
  • Value
'lowercase'
echo "FIX: some message" # fails
echo "🩹 FIX: some message" # fails
echo "🩹 fix: some message" # passes

type-empty

  • Condition: is empty type
  • Rule: never
echo ": some message" # fails
echo "🩹: some message" # fails
echo "🩹 fix: some message" # passes

scope-case

  • Condition: is in case scope value
  • Rule: always
'lowercase'
echo ": some message" # fails
echo "🩹: some message" # fails
echo "🩹 fix: some message" # passes

subject-case

  • Condition: is in on of the cases subject ['sentence-case', 'start-case', 'pascale-case', 'upper-case']
  • Rule: never
echo "🩹 fix(SCOPE): Some message" # fails
echo "🩹 fix(SCOPE): Some Message" # fails
echo "🩹 fix(SCOPE): SomeMessage" # fails
echo "🩹 fix(SCOPE): SOMEMESSAGE" # fails
echo "🩹 fix(scope): some message" # passes
echo "🩹 fix(scope): some Message" # passes

subject-empty

  • Condition: is empty subject
  • Rule: never
echo "🩹 fix:" # fails
echo "🩹 fix: some message" # passes

subject-full-stop

  • Condition: ends with subject value
  • Rule: never
  • Value
'.'
echo "🩹 fix: some message." # fails
echo "🩹 fix: some message" # passes

subject-exclamation-mark

  • Condition: must not have a before the marker subject ! :
  • Rule: never

header-max-length

  • Condition: has or less characters header value
  • Rule: always
  • Value
72
echo "🩹 fix: some message that is way too long and breaks the line max-length by several characters" # fails
echo "🩹 fix: some message" # passes

body-leading-blank

  • Condition: Body should have a leading blank line
  • Rule: always
echo "🩹 fix: some message
body" # fails

echo "🩹 fix: some message

body" # passes

footer-leading-blank

  • Condition: Footer should have a leading blank line
  • Rule: always
echo "🩹 fix: some message
BREAKING CHANGE: It will be significant" # fails

echo "🩹 fix: some message

BREAKING CHANGE: It will be significant" # passes

Code Of Conduct

Please read the Code Of Conduct before interacting with the project.

How to contribute ?

In your case, to start contributing, please fork @wr-projects/utils and start working on your part. Later, feel free to contribute a Pull Request, we will be pleased to review it with you.

Contributors

Project Owner

Grégoire FAVREAU
Grégoire FAVREAU

Follow us

License

MIT LICENSE

Copyright (c) WRProjects Community

commitcommitlintcommitlint-configangularemojigitconfigurationconfiguration-shareableshareableconfigwebreadyprojectswrprojectsopensource2023
@commitlint/config-conventional@commitlint/format
@everything-registry/sub-chunk-1023
0.0.2

1 year ago

0.0.1

1 year ago