feat!: add option to customize types/scopes to exclude

[tmlmt]

The current version of changelogen (great piece of work by the way <3) seems opinionated, as it hard codes the exclusion of chore(deps) from changelogs by filtering parsed commits:

changelogen/src/commands/default.ts

Lines 34 to 38 in db1c625

	const commits = parseCommits(rawCommits, config).filter(
	(c) =>
	config.types[c.type] &&
	!(c.type === "chore" && c.scope === "deps" && !c.isBreaking)
	);

I like to keep track of the history of my dependencies, so I would like to have the possibility to include those commits in the generated changelog. This is what this PR enables, with an new config option, excludeChoreDeps which defaults to true as being the current behavior.

In order to add a corresponding test (with both boolean values of the option), I've decided to export a new function, filterParsedCommits, which I can import in the test file and run tests on it.

I hope that is acceptable 😃

[pi0]

Thanks for this PR (and sorry took too long to review!). I like the idea. Only thinking to find a better option namespace so that we could include more configurations like this about changelog filtering without adding too many top level options (ideas welcome!)

[tmlmt]

Hey @pi0, thanks for reverting! Do you have any idea of such typical cases? I proposed this specific option because chore(deps) was the only one originally hard-coded.

Well in that case one could think of something like --exclude <comma-separated list of types/scopes to exclude>. For instance --exclude ci,chore(deps) defaulting (or not) to chore(deps).

We could also think about:

1. adding this as a config parameter
2. similarly propose an --include or --include-only option to only include certain types or scopes

What are your thoughts?

[codecov]

Codecov Report

Attention: Patch coverage is 75.00000% with 8 lines in your changes missing coverage. Please review.

Project coverage is 47.10%. Comparing base (0914fd7) to head (c751676).
Report is 22 commits behind head on main.

Files with missing lines	Patch %	Lines
src/commands/default.ts	0.00%	7 Missing ⚠️
src/git.ts	95.83%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             main     #103       +/-   ##
===========================================
- Coverage   69.10%   47.10%   -22.00%     
===========================================
  Files           9       12        +3     
  Lines         916     1002       +86     
  Branches       85      101       +16     
===========================================
- Hits          633      472      -161     
- Misses        283      527      +244     
- Partials        0        3        +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tmlmt]

Hey @pi0, I am back on this one with a proposal which generalizes my original PR as requested. The new option exclude, actionable both in config file and cli, enables to customize which entire types (e.g. fix, chore) or types+scopes (e.g. chore(deps)) to exclude from the changelog.

• Default: [""] ⚠️ this is what makes it a breaking change (current default is to exclude chore(deps)). We could make it non-breaking by either:
  • solving the issue with c12: overrides doesn't override but extends default arrays and objects c12#113
  • or by removing the possibility to override the default by using a cli argument
• Example in changelog.config: exclude: ["ci", "chore(deps")]
• Example in command line: `npx changelogen@latest --bump --exclude 'ci,chore(deps)'

Let me know what you think :)

[JohnCampionJr]

This would be useful!