commitfusion/commitfusion.psm1 at main · phellams/commitfusion · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<#
* Root modules for CommitFusion
#>
using module libs\cmdlets\New-CommitFusion.psm1
using module libs\cmdlets\Get-CommitFusionModuleInstance.psm1
using module libs\cmdlets\New-Commit.psm1
using module libs\cmdlets\Get-CiSet.psm1
using module libs\cmdlets\Get-CommitTypes.psm1
using module libs\cmdlets\Get-Emoji.psm1
using module libs\cmdlets\Get-EmojiIndex.psm1
using module libs\cmdlets\Get-GitAutoVersion.psm1
using module libs\cmdlets\Format-FusionMD.psm1
using module libs\cmdlets\Update-Changelog.psm1
using module libs\cmdlets\Set-Commit.psm1
using module libs\cmdlets\Get-ReleaseNotes.psm1
using module libs\cmdlets\Enable-CommitFusionEmojis.psm1
using module libs\cmdlets\Disable-CommitFusionEmojis.psm1

$global:_commitfusion = @{
    rootpath = Split-Path -Parent -Path $MyInvocation.MyCommand.Definition
}

<#
* Exported Functions Object -> array
#>
$ModuleMembers = @{
    function = @(
        "New-CommitFusion",
        "Get-CommitFusionModuleInstance",
        "New-Commit",
        "Get-CiSet",
        "Get-CommitTypes",
        "Get-Emoji",
        "Get-EmojiIndex",
        "Get-GitAutoVersion",
        "Format-FusionMD",
        "Update-Changelog",
        "Set-Commit",
        "Get-ReleaseNotes",
        "Enable-CommitFusionEmojis",
        "Disable-CommitFusionEmojis"
    )
}

<#
* Exported Functions
#>
Export-ModuleMember @ModuleMembers


<#
---------------------------------------------------------------------------------------------------------------------------------------
!    ___                              _)  |    ____|           _)
?  |       _  \  __ `__ \   __ `__ \   |  __|  |   |   |   __|  |   _ \  __ \
? |      (    | |   |   |  |   |   |  |  |    __| |   | \__ \  |  (   | |   |
! \____| \___/ _|  _|  _| _|  _|  _| _| \__| _|  \__,_| ____/ _| \___/ _|  _|

---------------------------------------------------------------------------------------------------------------------------------------

? NOTES
@Colorful comments vscode url:
- #? https://marketplace.visualstudio.com/items?itemName=bierner.colorful-comments

& CLASS: [CommitFusion]
* DESCRIPTION:
    ^_Conventional Commits
    is a specification that defines a standard convention
    for structuring commit messages in software development. It provides a
    consistent format and semantic meaning to commit messages, making it
    easier to understand the purpose and impact of each commit. Here are the
    main properties defined by Conventional Commits:
    &VALUES
        ^- Type parameter input validation parsed from commitfusion.json allows dynamic updating of the commit types
        ^- Scope (UserDefined) - Allows for user defined scopes
        ^- Description Default(commitfusion.json > DesCription or (user defined) - Allows for user defined descriptions))
        ^- Body(Notes)
            ^- Notes(Default Body) - Change body to Notes
            ^- Breaking Changes
            ^- FeatureNotes
            ^- BugFixes
            ^- FeatureAddtions
        ^- Footer (gituser|user @ DateTime)
    ? DEPENDANCIES:
        ~ ColorTune - Embedded in this module
        ~ Write-Inexco #? Colortune Replaces this #TODO: Replace and use SimpleSpectreWrapper and ColorTune
        ? powerunicode - Embedded in this module - Not used at this time
        ! SimpleSpectreWrapper - Embedded in this module - pending implementation
    ^ BUILD ENV---: BUILD: Powershellcore 7.4.0 - Windows 11, Pester 5.5.0, PSScriptAnalyzer(LATEST) 1.21.1
    ^ SUPPORTED VERSIONS
        Powerhshell 5.1^ - Pending Test
    *   Powershell 7.^
        Powershellcore(linux) 7.^ - Pending Test
#>