feat: how to mitigate errors when adding a new rule and not updating all relevant packages

### Expected Behavior

See context

### Current Behavior

See context

### Affected packages

- [ ] cli
- [X] core
- [ ] prompt
- [ ] config-angular

### Possible Solution

1. Adding a "troubleshooting" section in the docs explaining the reason of the issue and how to resolve it.
2. Integrate ` RangeError: Found invalid rule names` with an additional description providing the user a clue that some `@commitlint/packages` should be updated (a link to the new documentation section could do the trick).

What do you think? If you agree I can work on a PR.

### Context

After adding `header-trim` rule (https://github.com/conventional-changelog/commitlint/pull/3871), 
a certain amount of user has reported issues when updating commitlint:

1. https://github.com/conventional-changelog/commitlint/pull/3871#issuecomment-1911312089
2. https://github.com/conventional-changelog/commitlint/pull/3871#issuecomment-1916336429
3. https://github.com/conventional-changelog/commitlint/pull/3871#issuecomment-1917735604

----

For reference:



<details>
<summary>
Explanation of the cause of the error
</summary>

The error is thrown here:

https://github.com/conventional-changelog/commitlint/blob/daa8b1baa8732b3f1f937d2453608d47b4952bff/%40commitlint/lint/src/lint.ts#L78-L86


all rules is declared reading the content of baseRules:

https://github.com/conventional-changelog/commitlint/blob/daa8b1baa8732b3f1f937d2453608d47b4952bff/%40commitlint/lint/src/lint.ts#L59-L62

`baseRules` are imported from `@commitlint-rules`:

https://github.com/conventional-changelog/commitlint/blob/daa8b1baa8732b3f1f937d2453608d47b4952bff/%40commitlint/lint/src/lint.ts#L4


in version `14.6.0` `header-trim` definition has been added

https://github.com/conventional-changelog/commitlint/blob/daa8b1baa8732b3f1f937d2453608d47b4952bff/%40commitlint/rules/src/index.ts#L55


---

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`.

</details>

_Originally posted by @marcalexiei in https://github.com/conventional-changelog/commitlint/issues/3871#issuecomment-1911455325_

<details>
<summary> Solution </summary>

> [!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](https://github.com/conventional-changelog/commitlint/pull/3871#issuecomment-1911455325).

If someone is relying on a config which depends on an earlier version of  `@commitlint/config-conventional` be sure to update it:

```sh
npm update @commitlint/config-conventional
```

---

</details>


_Originally posted by @marcalexiei in https://github.com/conventional-changelog/commitlint/issues/3871#issuecomment-1914327791_




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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: how to mitigate errors when adding a new rule and not updating all relevant packages #3894

Expected Behavior

Current Behavior

Affected packages

Possible Solution

Context

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

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

feat: how to mitigate errors when adding a new rule and not updating all relevant packages #3894

Description

Expected Behavior

Current Behavior

Affected packages

Possible Solution

Context

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions