feat(rules): add header-trim rule

[marcalexiei]

Description

Followup of #3199 (comment):

Currently when having a leading space, the error message says that the subject is empty.
I suggest that the error message instead says that there is leading whitespace.
This is due to identifying extra unwanted leading whitespace is hard in a commit message.

I have added a rule to check that header do not start or end with whitespace characters: header-trim
The rule logs a different status message for each scenario (start / end / mixed).

I added the new rule to @commitlint/config-conventional config.
Let me know if you prefer that the user manually opt-it or it I have to add it to other configurations.

Motivation and Context

#3199

Usage examples

// commitlint.config.js
module.exports = {
  rules: {
    'header-trim': [2, 'always'],
  }
};

# fails
echo " feat: test commit" | yarn run commitlint
echo "feat: test commit " | yarn run commitlint
echo " feat: test commit " | yarn run commitlint

# passes
echo "feat: test commit " | yarn run commitlint

How Has This Been Tested?

yarn test

The new rule has been tested in @commitlint/rules/src/header-trim.test.ts

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[escapedcat]

Thanks for taking care of this!

[UkonnRa]

Same as wagoid/commitlint-github-action#755, we met the invalid rule names error as well:

RangeError: Found invalid rule names: header-trim. Supported rule names are: body-case, body-empty, body-full-stop, body-leading-blank, body-max-length, body-max-line-length, body-min-length, footer-empty, footer-leading-blank, footer-max-length, footer-max-line-length, footer-min-length, header-case, header-full-stop, header-max-length, header-min-length, references-empty, scope-case, scope-empty, scope-enum, scope-max-length, scope-min-length, signed-off-by, subject-case, subject-empty, subject-full-stop, subject-max-length, subject-min-length, subject-exclamation-mark, trailer-exists, type-case, type-empty, type-enum, type-max-length, type-min-length
    at lint (/usr/lib/node_modules/@commitlint/cli/node_modules/@commitlint/lint/lib/lint.js:53:15)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

Any idea how to fix it?

[marcalexiei]

The error is thrown here:

commitlint/@commitlint/lint/src/lint.ts

Lines 78 to 86 in daa8b1b

	if (missing.length > 0) {
	const names = [...allRules.keys()];
	throw new RangeError(
	`Found invalid rule names: ${missing.join(
	', '
	)}. Supported rule names are: ${names.join(', ')}`
	);
	}

all rules is declared reading the content of baseRules:

commitlint/@commitlint/lint/src/lint.ts

Lines 59 to 62 in daa8b1b

	const allRules: Map<string, BaseRule<never, RuleType>> = new Map(
	Object.entries(defaultRules)
	);

baseRules are imported from @commitlint-rules:

commitlint/@commitlint/lint/src/lint.ts

Line 4 in daa8b1b

import defaultRules from '@commitlint/rules';

in version 14.6.0 header-trim definition has been added

commitlint/@commitlint/rules/src/index.ts

Line 55 in daa8b1b

'header-trim': headerTrim,

---

Running command line from CLI doesn't throw any error.
If I have to make a guess not all required packages have updated to version 18.6.0.

Could you please provide a minimal reproduction example in a separate issue?

[marcalexiei]

I have setup a small repo and I'm unable to reproduce the issue:

Repository: https://github.com/marcalexiei/commlitlint-github-action-playground

Action run ✅: https://github.com/marcalexiei/commlitlint-github-action-playground/actions/runs/7663989581/job/20887651012

Log

Action run ❌: https://github.com/marcalexiei/commlitlint-github-action-playground/actions/runs/7664059035/job/20887826397

Log

[UkonnRa]

You are right, in my case, /usr/bin/node_modules is not the right node_modules dir. For some reason, my commitlint command in husky just use the wrong commitlint command.

We should always use node_modules/.bin/commitlint and make sure the commitlint points to the correct one.
I am OK now.

[kddsultan]

This is a Breaking change, right? It is not backwards compatible

[escapedcat]

This is a Breaking change, right? It is not backwards compatible

You might be right. Let's see how many people will be affected.

[tada5hi]

im also affected by this...

[davidwinter]

Reading the comments, I can't see a fix that I can do for this, as I'm experiencing it too. Of course, other than to rollback to the previous version...

[escapedcat]

@marcalexiei wdyt? Should we revert and and push a fix and add this again as breaking?

[marcalexiei]

• 3 days ago I asked for a reproduction example and so far no one has provided one configuration or one repository where I can see this issue.
• I created a minimal reproduction example and I was unable to reproduce the issue:

  I have setup a small repo and I'm unable to reproduce the issue:
  Repository: https://github.com/marcalexiei/commlitlint-github-action-playground

• I tried to reproduce the issue using github action

---

Warning

The source of this error is likely a mismatch of version between @commitlint packages in node_modules

Detailed explanation can be found in a comment above.

If someone is relying on a config which depends on an earlier version of @commitlint/config-conventional be sure to update it:

npm update @commitlint/config-conventional

---

I'm more than willing to find a fix for this issue.
I kindly ask to provide a minimal reproduction example by opening a new issue.

[davidwinter]

My project has Dependabot setup which was proposing a PR to just update @commitlint/config-conventional to 18.6.0. However, @commitlint/cli was still set to 18.4.4, which as mentioned, the mismatch in versions causes the issue.

Updating both at the same time, there is no issue.

Should both of the above packages set a minimum version number for each of the other packages if there is that hard dependency between them both? Or some other mitigation to prevent this?

[maninak]

A CI job for my PR started suddenly failing with the error:

Run JulienKode/pull-request-name-linter-action@v0.5.0
Error: RangeError: Found invalid rule names: header-trim. Supported rule names are: body-case, body-empty, body-full-stop, body-leading-blank, body-max-length, body-max-line-length, body-min-length, footer-empty, footer-leading-blank, footer-max-length, footer-max-line-length, footer-min-length, header-case, header-full-stop, header-max-length, header-min-length, references-empty, scope-case, scope-empty, scope-enum, scope-max-length, scope-min-length, signed-off-by, subject-case, subject-empty, subject-full-stop, subject-max-length, subject-min-length, subject-exclamation-mark, trailer-exists, type-case, type-empty, type-enum, type-max-length, type-min-length
Error: Found invalid rule names: header-trim. Supported rule names are: body-case, body-empty, body-full-stop, body-leading-blank, body-max-length, body-max-line-length, body-min-length, footer-empty, footer-leading-blank, footer-max-length, footer-max-line-length, footer-min-length, header-case, header-full-stop, header-max-length, header-min-length, references-empty, scope-case, scope-empty, scope-enum, scope-max-length, scope-min-length, signed-off-by, subject-case, subject-empty, subject-full-stop, subject-max-length, subject-min-length, subject-exclamation-mark, trailer-exists, type-case, type-empty, type-enum, type-max-length, type-min-length

I hadn't changed my PR's title before and it's been passing for weeks. Then it started failing for no apparent reason. (I at first tried to shorten my PR title thinking that that was the issue but after reading the error better I realized there's more to it...)

here's my pr-linting.yaml

name: PR linting
on:
  pull_request:
    types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  lint-pr-title:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Install Dependencies
      run: npm install @commitlint/config-conventional
    - uses: JulienKode/pull-request-name-linter-action@v0.5.0

and my PR title is

feat(patch-detail): implement new view with in-depth patch info

[marcalexiei]

1. I kindly ask to provide a minimal reproduction example by opening a new issue.

2. Could you please provide a minimal reproduction example in a separate issue?

For the third time, if you having issue open a separate issue providing a MINIMAL REPRODUCTION EXAMPLE

---

@escapedcat could you please lock the conversation so people might open separate issue instead of reporting them here?

---

@maninak for what I'm seeing the action you are referring to seems to use commitlint 17:

https://github.com/JulienKode/pull-request-name-linter-action/blob/900e046a8f2d6d0ba79bef8b6c731e4fe9f5fa8a/package.json#L48-L49

Please be sure to use consistent versions bettnwe @commitlint/{lint, rules,config} packages.
You are probably installing @commitlint/config-conventional@18.6.0 and running it with v17 packages.
Try installing a fixed version for @commitlint/config-conventional or update the action commitlint packages.

[escapedcat]

A CI job for my PR started suddenly failing with the error:

This looks like an issue from https://github.com/JulienKode/pull-request-name-linter-action

@escapedcat could you please lock the conversation so people might open separate issue instead of reporting them here?

Let me have a look

[escapedcat]

Please open a separate issue for further discussions, thanks