Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(changelog_cmd): add semver v2 proposal for generating changelog
Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
- Loading branch information
1 parent
a82cd24
commit d85ad89
Showing
3 changed files
with
224 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
/// Header Msg is the method generator to generate the changelog | ||
/// from the message header like this example here | ||
/// https://github.com/invertase/melos/blob/main/packages/melos/CHANGELOG.md | ||
/// | ||
/// Where a message header contains the content of the changelog | ||
/// an example `FIX: don't use Enum.name (#PR) commit_hash` | ||
/// | ||
/// The filter keywords are: | ||
/// - `fix: message` to document a fix; | ||
/// - `feat: message ` to document a feature; | ||
/// - `docs: message ` to document a new doc addition. | ||
/// | ||
/// author: https://github.com/vincenzopalazzo | ||
import 'package:changelog_cmd/method/method_generation.dart'; | ||
import 'package:changelog_lib/changelog_lib.dart'; | ||
|
||
class SemVerV2Generator extends MethodGenerator { | ||
@override | ||
void apply( | ||
{required ChangelogGenerator generator, | ||
String? exactMatchHeader, | ||
RegExp? regexHeader, | ||
bool strictly = false}) { | ||
generator.addFilterRule( | ||
rule: FilterRule(headerExactMatch: "fix:", nameSection: "Fixed")); | ||
generator.addFilterRule( | ||
rule: | ||
FilterRule(headerExactMatch: "feat:", nameSection: "Added")); | ||
generator.addFilterRule( | ||
rule: FilterRule(headerExactMatch: "doc:", nameSection: "Docs")); | ||
|
||
generator.addFilterRule( | ||
rule: FilterRule(headerExactMatch: "deprecate:", nameSection: "Deprecated")); | ||
|
||
generator.addFilterRule( | ||
rule: FilterRule(headerExactMatch: "remove:", nameSection: "Removed")); | ||
|
||
generator.addFilterRule( | ||
rule: FilterRule( | ||
headerExactMatch: "fix(${generator.packageName}):", | ||
nameSection: "Fixed")); | ||
generator.addFilterRule( | ||
rule: FilterRule( | ||
headerExactMatch: "feat(${generator.packageName}):", | ||
nameSection: "Added")); | ||
generator.addFilterRule( | ||
rule: FilterRule( | ||
headerExactMatch: "doc(${generator.packageName}):", | ||
nameSection: "Docs")); | ||
generator.addFilterRule( | ||
rule: FilterRule( | ||
headerExactMatch: "deprecate(${generator.packageName}):", | ||
nameSection: "Deprecated")); | ||
generator.addFilterRule( | ||
rule: FilterRule( | ||
headerExactMatch: "remove(${generator.packageName}):", | ||
nameSection: "Removed")); | ||
} | ||
} |
Oops, something went wrong.