Skip to content

Commit

Permalink
feat: add openedx commitlint.config.js (#193)
Browse files Browse the repository at this point in the history
This adds openedx commit lintern rules.

This is inspired by the following PR:
https://github.com/eduNEXT/shipyard-infrastructure/pull/25/files

This fixes the footer long chars error.

This is mostly based on: 
https://github.com/openedx/edx-lint/blob/master/commitlint.config.js

In particular, limiting the length of a line in the commit body might be detrimental when including external links.
  • Loading branch information
johanseto authored Feb 9, 2024
1 parent 19b9172 commit 2f6fbb1
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// See: https://commitlint.js.org/#/reference-configuration for details
// on the configuration file
module.exports = {
extends: ['@commitlint/config-conventional'],

rules: {
'type-enum':
[2, 'always', [
'revert', 'feat', 'fix', 'perf', 'docs', 'test', 'build', 'refactor', 'style', 'chore', 'temp', 'ci',
]],

// Default rules we want to suppress. The available list of rules can be
// found in https://commitlint.js.org/#/reference-rules
'body-leading-blank': [0, "always"],
'body-max-line-length': [0, "always"],
'footer-max-line-length': [0, "always"],
'footer-leading-blank': [0, "always"],
'subject-case': [0, "always", []],
'subject-full-stop': [0, "never", '.'],
},

ignores: [
// Allow GitHub revert messages, like:
// Revert "introduce a bug"
// Revert "introduce a bug" (#1234)
message => /^Revert ".*"( \(#\d+\))?/.test(message),

// BTW: commitlint has a built-in list of ignores which are also applied.
// Those include the typical "Merged" messages, so those are implicitly ignored:
// https://github.com/conventional-changelog/commitlint/blob/master/%40commitlint/is-ignored/src/defaults.ts
],
};

0 comments on commit 2f6fbb1

Please sign in to comment.