@@ -95,6 +100,4 @@ $version = "v_$((Get-GitAutoVersion).Version)"
### Default avaliable commit types
-> Types are found at`$moduleroot/libs/commitfusion.types.json
-
-# ๐ Changelog
+> Types are found at`$moduleroot/libs/commitfusion.types.json
\ No newline at end of file
diff --git a/build/bt2-ci-create-packages.ps1 b/build/bt2-ci-create-packages.ps1
index e9a195d..a038bc3 100644
--- a/build/bt2-ci-create-packages.ps1
+++ b/build/bt2-ci-create-packages.ps1
@@ -7,22 +7,63 @@ $ModuleManifest = Test-ModuleManifest -path .\dist\$modulename\$modulename.psd1
#----Special Config Choco --------------------------------
# Choco supports markdown nuget and psgallary done
-$Additional_descriptions = @"
-*CommitFusion* is a PowerShell module crafted to streamline the creation of well-organized and uniform commit messages in adherence to the [๐งทConventional Commits specification](https://www.onventionalcommits.org/en/v1.0.0/) for your `git` repository.
-
-A custom version of the [๐งทcarloscuesta gitmojis Schema](/~https://github.com/carloscuesta/gitmoji/blob/master/packages/gitmojis/src/gitmojis.json) (accessible at [๐งทgitmoji.dev](https://gitmoji.dev)) is used to define the emojis, scope, and default description of the commit string.
+$Additional_descriptions = @'
+***CommitFusion*** is a **PowerShell** module designed to streamline the process of generating *Conventional Commits Messages* in `git`. Commit messages are constructed using the [๐งทConventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) standard, and uses [๐งทgitmojis Schema](/~https://github.com/carloscuesta/gitmoji/blob/master/packages/gitmojis/src/gitmojis.json) see [๐งทgitmoji.dev](https://gitmoji.dev), The module allows the construction of a custimized commit message with a number of options.
### Features
-- Conventional Commit specification.
-- Custom commit Types.
-- Customizable Commit Messages.
-- Changelog auto-updater.
-- Semver(*Semantic Versioning specification*).
-- Emoji parser.
-- Gitmoji parser.
-- Auto Commit
-"@
+๐ชถ Conventional Commits Standard
+๐ชถ Customizable Commit Message
+๐ชถ Semver Versioning Generator
+๐ชถ Changelog Auto-update with Markdown Auto-format
+๐ชถ Gitmoji Custom Schema
+
+## ๐พ Using Commitfusion
+
+Retrive list of available commit types
+
+``````powershell
+Get-CommitTypes
+``````
+
+Retrive list of available commit types.
+
+``````powershell
+Get-CommitTypes -Semver patch
+Get-CommitTypes -Semver minor
+Get-CommitTypes -Semver major
+Get-CommitTypes -Semver nosemver
+``````
+
+Creating a new feature` commit.
+
+``````powershell
+# Default Returns ]string]
+``````
+
+Assuming you have staged files, you can use the following to commit the changes:
+
+``````powershell
+# Apply Commit
+New-Commit @params | Set-Commit -Confirm
+# Apply Commit and write to changelog file
+New-Commit @params | Format-FusionMD | Update-Changelog -logfile path\to\file | Set-Commit -Confirm
+``````
+
+Generate Semver version base on you commits
+
+``````powershell
+# generate SemVer Version returns psobject
+Get-GitAutoVersion | select version
+# only string
+(Get-GitAutoVersion).Version
+``````
+
+### Default avaliable commit types
+
+> Types are found at $moduleroot/libs/commitfusion.types.json
+'@
+
#----Special Config Choco --------------------------------
$NuSpecParams = @{
path=".\dist\$ModuleName"
@@ -31,6 +72,7 @@ $NuSpecParams = @{
Author = $ModuleManifest.Author
Description = "$($ModuleManifest.Description)"
ProjectUrl = $ModuleManifest.PrivateData.PSData.ProjectUri
+ IconUrl = 'https://raw.githubusercontent.com/sgkens/resources/main/modules/CommitFusion/dist/v2/commitfusion-icon-x128.png'
License = "MIT"
company = $ModuleManifest.CompanyName
Tags = $ModuleManifest.Tags
@@ -42,8 +84,9 @@ $NuSpecParamsChoco = @{
ModuleName = $ModuleName
ModuleVersion = $ModuleManifest.Version -replace "\.\d+$",""
Author = $ModuleManifest.Author
- Description = "$($ModuleManifest.Description)"
+ Description = "$($ModuleManifest.Description) `n`n $Additional_descriptions"
ProjectUrl = $ModuleManifest.PrivateData.PSData.ProjectUri
+ IconUrl = 'https://raw.githubusercontent.com/sgkens/resources/main/modules/CommitFusion/dist/v2/commitfusion-icon-x128.png'
License = "MIT"
company = $ModuleManifest.CompanyName
Tags = $ModuleManifest.Tags
diff --git a/build/bt5-ci-deploy-pushtochoco.ps1 b/build/bt5-ci-deploy-pushtochoco.ps1
index ae3b617..8cbd364 100644
--- a/build/bt5-ci-deploy-pushtochoco.ps1
+++ b/build/bt5-ci-deploy-pushtochoco.ps1
@@ -10,8 +10,7 @@ $SemVerVersion = $ModuleManifest.Version -replace "\.\d+$",""
if(Get-command choco.exe){
write-host "Chocolatey is installed, skipping install"
write-host "Pushing to chocolatey https://community.chocolatey.org/"
- choco apikey --key $CHOCO_API_KEY --source https://push.chocolatey.org/
- choco.exe push .\dist\$ModuleName.$SemVerVersion.nupkg --source 'https://community.chocolatey.org/'
+ choco push .\dist\choco\$($ModuleManifest.CompanyName).$ModuleName.$SemVerVersion.nupkg --source 'https://community.chocolatey.org/' --api-key $CHOCO_API_KEY --source https://push.chocolatey.org/
write-host "Pushed to chocolatey - Complete"
}else{
write-host "Chocolatey is not installed, please install chocolatey https://community.chocolatey.org/"
diff --git a/build/bt6-ci-deploy-psgallary.ps1 b/build/bt6-ci-deploy-psgallary.ps1
index fb38ab4..c2bcb04 100644
--- a/build/bt6-ci-deploy-psgallary.ps1
+++ b/build/bt6-ci-deploy-psgallary.ps1
@@ -5,11 +5,10 @@ $ModuleManifest = Test-ModuleManifest -path ".\dist\$ModuleName\$ModuleName`.psd
#---CONFIG----------------------------
-
#------------------------------------
publish-Module `
-path ".\dist\$modulename" `
- -Repository 'psgallary' `
+ -Repository 'psgallery' `
-NuGetApiKey $PSGAL_API_KEY `
-projecturi $ModuleManifest.ProjectUri `
-licenseuri $ModuleManifest.LicenseUri `
diff --git a/coverage.xml b/coverage.xml
deleted file mode 100644
index 1094fbb..0000000
--- a/coverage.xml
+++ /dev/null
@@ -1,675 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/assets/js/main.js b/docs/assets/js/main.js
index 849681d..bc99af5 100644
--- a/docs/assets/js/main.js
+++ b/docs/assets/js/main.js
@@ -449,7 +449,7 @@ window.onload = function() {
document.getElementById("features").classList.add("button-page-active");
break;
- case "/installation":
+ case "/install":
console.log("Nav to Installation");
document
.getElementById("installation")
@@ -472,29 +472,29 @@ window.onload = function() {
}
else{
switch (document.location.pathname) {
- case "/commitfusion":
+ case "/":
console.log("Nav to Index");
document.getElementById("about").classList.add("button-page-active");
break;
- case "/commitfusion/features":
+ case "/features":
console.log("Nav to features");
document.getElementById("features").classList.add("button-page-active");
break;
- case "/commitfusion/installation":
+ case "/install":
console.log("Nav to Installation");
document
- .getElementById("installation")
+ .getElementById("install")
.classList.add("button-page-active");
break;
- case "/commitfusion/cmdlets":
+ case "/cmdlets":
console.log("Nav to cmdlets");
document.getElementById("cmdlets").classList.add("button-page-active");
break;
- case "/commitfusion/examples":
+ case "/examples":
console.log("Nav to examples");
document.getElementById("examples").classList.add("button-page-active");
break;
diff --git a/icon.png b/icon.png
index a328411..536e97f 100644
Binary files a/icon.png and b/icon.png differ
diff --git a/libs/CommitFusion_class.psm1 b/libs/CommitFusion_class.psm1
index a8f38f7..51dd990 100644
--- a/libs/CommitFusion_class.psm1
+++ b/libs/CommitFusion_class.psm1
@@ -5,7 +5,7 @@ class CommitFusion{
[string[]] $Notes
[String] $Styledbody
[String] $Footer
- [string[]] $FeatureAddtions
+ [string[]] $FeatureAdditions
[string[]] $Bugfixes
[string[]] $Breakingchanges
[string[]] $Featurenotes
@@ -88,7 +88,7 @@ class CommitFusion{
[Bool] $Footer = $false,
[String] $GitUser = $Null,
[String] $GitGroup = $null,
- [string[]] $FeatureAddtions = $null,
+ [string[]] $FeatureAdditions = $null,
[string[]] $bugfixes = $null,
[string[]] $FeatureNotes = $null,
[string[]] $BreakingChanges = $null
@@ -103,7 +103,7 @@ class CommitFusion{
$this.featurenotes = $featurenotes
$this.gituser = $gituser
$this.gitgroup = $gitgroup
- $this.FeatureAddtions = $FeatureAddtions
+ $this.FeatureAdditions = $FeatureAdditions
$this.bugfixes = $bugfixes
if($Description.length -eq 0){# char count seems to work better than $null, i dont really like null
@@ -139,25 +139,25 @@ class CommitFusion{
hidden [void] ConstructMessage(){
<#- Feature Addtions-#>
- if($null -ne $this.FeatureAddtions){
+ if($null -ne $this.FeatureAdditions){
# Add if branch is not null
- $FeatureAddtionsVar = "$($this.GetEmoji("miscmojis","glowing_star")) FEATURE ADDTIONS: `n"
- $FeatureAddtionsVar += "`n"
+ $FeatureAdditionsVar = "$($this.GetEmoji("miscmojis","glowing_star")) FEATURE ADDTIONS: `n"
+ $FeatureAdditionsVar += "`n"
[int]$index = 1
- foreach ($faddtion in $this.FeatureAddtions) {
- if($this.FeatureAddtions.count -ne $index -and $this.FeatureAddtions.count -ne 1){
- $FeatureAddtionsVar += "$($this.GetEmoji("miscmojis","roasted_sweet_potato")) $faddtion \`n"
+ foreach ($faddtion in $this.FeatureAdditions) {
+ if($this.FeatureAdditions.count -ne $index -and $this.FeatureAdditions.count -ne 1){
+ $FeatureAdditionsVar += "$($this.GetEmoji("miscmojis","roasted_sweet_potato")) $faddtion \`n"
}
else{
- $FeatureAddtionsVar += "$($this.GetEmoji("miscmojis","roasted_sweet_potato")) $faddtion ..๐"
+ $FeatureAdditionsVar += "$($this.GetEmoji("miscmojis","roasted_sweet_potato")) $faddtion ..๐"
}
$index++
}
$index = $null
- $FeatureAddtionsVar += "`n"
- $this.FeatureAddtions = "$FeatureAddtionsVar`n`n"
+ $FeatureAdditionsVar += "`n"
+ $this.FeatureAdditions = "$FeatureAdditionsVar`n`n"
}
- else{ $this.FeatureAddtions = "" }
+ else{ $this.FeatureAdditions = "" }
<# BUGFIXES #>
if($null -ne $this.bugfixes){
@@ -267,7 +267,7 @@ class CommitFusion{
Description = " $($this.Description)"
Body = "$($this.styledbody)"
Footer = "$($this.footer)"
- BreakingChanges = "`n$($this.FeatureAddtions)$($this.BugFixes)$($this.FeatureNotes)$($this.BreakingChanges)`n"
+ BreakingChanges = "`n$($this.FeatureAdditions)$($this.BugFixes)$($this.FeatureNotes)$($this.BreakingChanges)`n"
}
$this.ConstructMessageObject = $StringParts
diff --git a/libs/CommitFustion.types.json b/libs/CommitFustion.types.json
index 23971e4..1277ddc 100644
--- a/libs/CommitFustion.types.json
+++ b/libs/CommitFustion.types.json
@@ -120,7 +120,7 @@
"emoji": "๐ท",
"entity": "👷",
"code": ":construction_worker:",
- "description": "Continuous integration.",
+ "description": "Add / Update Continuous integration.",
"name": "construction_worker",
"semver": null,
"cfa": [
@@ -134,7 +134,7 @@
"emoji": "๐ง",
"entity": "🔧",
"code": ":wrench:",
- "description": "Tooling, Generic commit",
+ "description": "Add / Update Tooling, Generic commit",
"name": "wrench",
"semver": null,
"cfa": [
@@ -148,7 +148,7 @@
"emoji": "โช",
"entity": "⏪",
"code": ":rewind:",
- "description": "Revert changes.",
+ "description": "Revert changes to previous commit",
"name": "rewind",
"semver": "patch",
"cfa": [
@@ -190,7 +190,21 @@
"emoji": "๐",
"entity": "bdfe7;",
"code": ":see_no_evil:",
- "description": "Add or update a .gitignore file.",
+ "description": "Add / Update a .gitignore file.",
+ "name": "see-no-evil",
+ "semver": null,
+ "cfa": [
+ {
+ "action": ""
+ }
+ ]
+ },
+ {
+ "type": "gitsubmodule",
+ "emoji": "๐งฎ",
+ "entity": "",
+ "code": ":abacus:",
+ "description": "Add / Update git submodules",
"name": "see-no-evil",
"semver": null,
"cfa": [
@@ -437,6 +451,90 @@
"action": ""
}
]
+ },
+ {
+ "type": "compiler",
+ "emoji": "๐จ",
+ "entity": "🚨",
+ "code": ":rotating_light:",
+ "description": "Fix compiler / linter warnings.",
+ "name": "rotating-light",
+ "semver": null,
+ "cfa": [
+ {
+ "action": ""
+ }
+ ]
+ },
+ {
+ "type": "cifix",
+ "emoji": "๐",
+ "entity": "💚",
+ "code": ":green_heart:",
+ "description": "Fix CI Build.",
+ "name": "green-heart",
+ "semver": null,
+ "cfa": [
+ {
+ "action": ""
+ }
+ ]
+ },
+ {
+ "type": "depdown",
+ "emoji": "โฌ๏ธ",
+ "entity": "โฌ๏ธ",
+ "code": ":arrow_down:",
+ "description": "Downgrade dependencies.",
+ "name": "arrow-down",
+ "semver": "patch",
+ "cfa": [
+ {
+ "action": ""
+ }
+ ]
+ },
+ {
+ "type": "depup",
+ "emoji": "โฌ๏ธ",
+ "entity": "โฌ๏ธ",
+ "code": ":arrow_up:",
+ "description": "Upgrade dependencies.",
+ "name": "arrow-up",
+ "semver": "patch",
+ "cfa": [
+ {
+ "action": ""
+ }
+ ]
+ },
+ {
+ "type": "depfix",
+ "emoji": "๐",
+ "entity": "📌",
+ "code": ":pushpin:",
+ "description": "Pin dependencies to specific versions.",
+ "name": "pushpin",
+ "semver": "patch",
+ "cfa": [
+ {
+ "action": ""
+ }
+ ]
+ },
+ {
+ "type": "globloc",
+ "emoji": "๐",
+ "entity": "🌐",
+ "code": ":globe_with_meridians:",
+ "description": "Internationalization and localization.",
+ "name": "globe-with-meridians",
+ "semver": "patch",
+ "cfa": [
+ {
+ "action": ""
+ }
+ ]
}
]
}
\ No newline at end of file
diff --git a/libs/cmdlets/New-Commit.psm1 b/libs/cmdlets/New-Commit.psm1
index fbcf16e..64c9510 100644
--- a/libs/cmdlets/New-Commit.psm1
+++ b/libs/cmdlets/New-Commit.psm1
@@ -9,13 +9,13 @@ New-Commit -Type feat -Description "CommitFusion PowerShell class library"
New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer
New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx"
New-Commit -Type build -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell"
-New-Commit -Type bookmark -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAddtions @("featurenotes 1", "another feature note")
-New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAddtions @("featurenotes 1", "another feature note") -Scope "UserAdmin"
-New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAddtions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random")
-New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAddtions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note")
-New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAddtions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note") -BreakingChanges @("breakingchanges 1", "another breaking change note")
-New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAddtions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note") -BreakingChanges @("breakingchanges 1", "another breaking change note")
-New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAddtions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note") -BreakingChanges @("breakingchanges 1", "another breaking change note")
+New-Commit -Type bookmark -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAdditions @("featurenotes 1", "another feature note")
+New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAdditions @("featurenotes 1", "another feature note") -Scope "UserAdmin"
+New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAdditions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random")
+New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAdditions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note")
+New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAdditions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note") -BreakingChanges @("breakingchanges 1", "another breaking change note")
+New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAdditions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note") -BreakingChanges @("breakingchanges 1", "another breaking change note")
+New-Commit -Type feat -Description "CommitFusion PowerShell class library" -Footer -GitUser "snoonx" -GitGroup "Powershell" -FeatureAdditions @("featurenotes 1", "another feature note") -Scope "UserAdmin" -Body @("Generate Conventionl Commit messages, with the ability to add custom messages", "Return string with or without markdown tags", "Return object commit string with commit components", "Write commit message to template file", "Prepend commit message to changelog file", "Append Changelog contents inbetween costom markers in the readme.md file", "Return Emoji Index as object array", "Return Gitmoji Index as object array", "Search gitMoji index for emoji by name return EmojiCon Icon", "Random feature note: create a random string of characters to use as a filename", "Random") -BugFixes @("bugfixnotes 1", "another bugfix note") -BreakingChanges @("breakingchanges 1", "another breaking change note")
.INPUTS
- Type
@@ -70,7 +70,7 @@ Function New-Commit {
[string]$GitGroup,
[Parameter(Mandatory = $false)]
- [string[]]$FeatureAddtions,
+ [string[]]$FeatureAdditions,
[Parameter(Mandatory = $false)]
[string[]]$BugFixes,
@@ -92,8 +92,8 @@ Function New-Commit {
if ($null -eq $Notes) {
$Notes = $null
}
- if ($null -eq $FeatureAddtions) {
- $FeatureAddtions = $null
+ if ($null -eq $FeatureAdditions) {
+ $FeatureAdditions = $null
}
if ($null -eq $BugFixes) {
$BugFixes = $null
@@ -128,7 +128,7 @@ Function New-Commit {
$Footer,
$GitUser,
$GitGroup,
- $FeatureAddtions,
+ $FeatureAdditions,
$BugFixes,
$FeatureNotes,
$BreakingChanges);
diff --git a/libs/template.md b/libs/template.md
index d3f5a12..e69de29 100644
--- a/libs/template.md
+++ b/libs/template.md
@@ -1 +0,0 @@
-
diff --git a/notes.txt b/notes.txt
deleted file mode 100644
index 7cf3b13..0000000
--- a/notes.txt
+++ /dev/null
@@ -1,2 +0,0 @@
-o- /~https://github.com/github/gemoji/blob/master/db/emoji.json used for emoi codex
-o- used for git mojis
\ No newline at end of file
diff --git a/test/Test-Unit-Pester.ps1 b/test/Test-Unit-Pester.ps1
index 6ef5e4f..97c447d 100644
--- a/test/Test-Unit-Pester.ps1
+++ b/test/Test-Unit-Pester.ps1
@@ -1,15 +1,14 @@
import-module -name .\commitfusion.psd1
import-module -name .\tools\GLIPParagraph\Write-GLIPParagraph.psm1
-
BeforeAll {
$Notes = @()
for ($x = -1; $x -lt $randomNotes; $x++) {
$Notes += Write-GLIPParagraph -Length (get-random -minimum 10 -maximum 20)
}
- $FeatureAddtions = @()
+ $FeatureAdditions = @()
for ($x = -1; $x -lt $randomNotes; $x++) {
- $FeatureAddtions += Write-GLIPParagraph -Length (get-random -minimum 10 -maximum 20)
+ $FeatureAdditions += Write-GLIPParagraph -Length (get-random -minimum 10 -maximum 20)
}
$BugFixes = @()
for ($x = -1; $x -lt $randomNotes; $x++) {
@@ -28,7 +27,7 @@ BeforeAll {
Scope = "test"
Description = "test"
Notes = "test"
- FeatureAddtions = $FeatureAddtions
+ FeatureAdditions = $FeatureAdditions
BugFixes = $BugFixes
FeatureNotes = $FeatureNotes
BreakingChanges = $BreakingChanges
diff --git a/tools/CHANGELOG-Test.md b/tools/CHANGELOG-Test.md
index e69de29..881fb6c 100644
--- a/tools/CHANGELOG-Test.md
+++ b/tools/CHANGELOG-Test.md
@@ -0,0 +1,152 @@
+
+## ๐ฏ-โจ feat(test): test
+
+
+> [๐งฐ]ยป MINOR
+
+๐ NOTES:
+
+โ test ..๐
+
+๐ FEATURE ADDTIONS: |
+|-|
+
+๐ faucibus. tristique, finibus neque. quis fringilla. quam eleifend. Phasellus Ut elit. odio nec semper, euismod vitae lectus varius. lectus ..๐
+
+
+๐ BUG FIXES: |
+|-|
+
+๐ฆ mi vitae dignissim consectetur. Fusce metus tortor libero Mauris Nam fringilla. iaculis tristique, a Vestibulum felis, pulvinar nec ligula ..๐
+
+
+๐งช FEATURE UPDATES: |
+|-|
+
+๐จ lacus ipsum vitae sed risus. consequat et odio consectetur fringilla metus ..๐
+
+
+๐ข BREAKING CHANGES: |
+|-|
+
+๐งจ vitae non, congue dolor id a ligula aliquet nibh elit a non vestibulum elit, congue, convallis iaculis. Vestibulum nec ..๐
+
+
+
+
+
+## ๐ฏ-โจ feat(test): test
+
+
+> [๐งฐ]ยป MINOR
+
+๐ NOTES:
+
+โ test ..๐
+
+๐ FEATURE ADDTIONS: |
+|-|
+
+๐ Ut scelerisque vitae metus sed nunc volutpat sem varius. rutrum ..๐
+
+
+๐ BUG FIXES: |
+|-|
+
+๐ฆ congue. Etiam sagittis Phasellus non magna efficitur at rutrum scelerisque feugiat ..๐
+
+
+๐งช FEATURE UPDATES: |
+|-|
+
+๐จ Fusce ut varius. sapien eu felis non, risus. sed Nunc a ..๐
+
+
+๐ข BREAKING CHANGES: |
+|-|
+
+๐งจ elit, nec tempus, eu libero dolor Morbi semper pulvinar. fringilla. dolor nec ..๐
+
+
+
+
+
+## ๐ฏ-โจ feat(test): test
+
+
+> [๐งฐ]ยป MINOR
+
+๐ NOTES:
+
+โ test ..๐
+
+๐ FEATURE ADDTIONS: |
+|-|
+
+๐ eleifend ligula Mauris ante, vitae vel felis nunc. Vivamus semper metus dignissim ..๐
+
+
+๐ BUG FIXES: |
+|-|
+
+๐ฆ sapien aliquam laoreet sed dolor nec tristique, rhoncus id lectus Proin ..๐
+
+
+๐งช FEATURE UPDATES: |
+|-|
+
+๐จ nisl dolor Sed odio Phasellus vestibulum nec congue nisl suscipit ..๐
+
+
+๐ข BREAKING CHANGES: |
+|-|
+
+๐งจ suscipit, euismod id vitae faucibus adipiscing tempus ante, convallis odio ultricies fringilla, sapien ..๐
+
+
+
+
+
+## ๐ฏ-โจ feat(test): test
+
+
+> [๐งฐ]ยป MINOR
+
+๐ NOTES:
+
+โ test ..๐
+
+๐ FEATURE ADDTIONS: |
+|-|
+
+๐ pulvinar. ligula sapien eros vitae vulputate a consectetur iaculis interdum iaculis vitae ..๐
+
+
+๐ BUG FIXES: |
+|-|
+
+๐ฆ magna, fringilla, ultricies. est eros augue nunc ac eros mollis nibh augue consequat libero ..๐
+
+
+๐งช FEATURE UPDATES: |
+|-|
+
+๐จ pulvinar a vestibulum congue mi ligula sed nibh scelerisque ex Etiam dolor. Phasellus ..๐
+
+
+๐ข BREAKING CHANGES: |
+|-|
+
+๐งจ vitae elementum. ligula. velit. vitae Vestibulum lectus et ultricies dignissim odio ac ac elit. Donec ultricies, libero Nunc ..๐
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/tools/Issue#1.txt b/tools/Issue#1.txt
new file mode 100644
index 0000000..84ee9ba
--- /dev/null
+++ b/tools/Issue#1.txt
@@ -0,0 +1,3 @@
+https://stackoverflow.com/questions/5596982/using-powershell-to-write-a-file-in-utf-8-without-the-bom
+
+- Missing BOM encoding for non-ASCII encoded file on_class.p 'CommitFusion_class.psm1'
\ No newline at end of file
diff --git a/commit-helper.ps1 b/tools/commit-helper.ps1
similarity index 100%
rename from commit-helper.ps1
rename to tools/commit-helper.ps1
diff --git a/tools/devmodulehelper.ps1 b/tools/devmodulehelper.ps1
new file mode 100644
index 0000000..0fd92fd
--- /dev/null
+++ b/tools/devmodulehelper.ps1
@@ -0,0 +1,80 @@
+# Function Get-ModuleDistribution(){
+# param(
+# [cmdletbinding]
+# [validateset("nuget","powershell","choco","gitlab","psgallary")]
+# [parameter(mandatory=$false)]$type
+# )
+# process {
+# $CommandArray = @( { Ping Google.com.au }, { ping github.com})
+# # Create Run space with a Pool of 5
+# $runspacePool = [runspacefactory]::CreateRunspacePool(1, 5)
+# # Open RunSpace
+# $runspacePool.open()
+
+# # Create Powershell Object
+
+# foreach($command in $commandArray){
+# $pwsh = [powershell]::Create()
+# $pwsh.RunspacePool = $runspacePool
+# $pwsh.AddScript($command) | Out-Null
+# $pwsh.AddArgument($Arguments) | out-null
+# }
+# $Response = $pwsh.BeginInvoke()
+# # Store the PowerShell instance in an array for later retrieval
+# $powershellJobs += [PSCustomObject]@{
+# PowerShell = $pwsh
+# Result = $Response
+# }
+# $powershellJobs.Result
+# }
+
+
+
+
+
+
+# # $RunSpace = [RunSpacefactory]::CreateRunSpace()
+
+# # $runspace.OpenAsync();
+# # $pwsh = [powershell]::Create()
+# # $pwsh.RunSpace = $ShellDock
+# # $pwsh.AddScript({ping google.com.au}) | out-null
+# # $pwsh.AddArgument($Arguments) | out-null
+# # $Response = $pwsh.BeginInvoke()
+# # $output = $pwsh.EndInvoke($Response)
+# }
+# Get-ModuleDistribution
+
+
+
+
+#=======================
+
+
+$CommandArray = @( [scriptblock]{ Ping Google.com.au }, [scriptblock]{ ping github.com})
+# Create Run space with a Pool of 5
+$runspacePool = [runspacefactory]::CreateRunspacePool(1, 5)
+# Open RunSpace
+$runspacePool.open()
+
+# Create Powershell Object
+$powershellJobs = @()
+foreach($command in $commandArray){
+ $pwsh = [powershell]::Create()
+ $pwsh.RunspacePool = $runspacePool
+ $pwsh.AddScript($command) | Out-Null
+ $pwsh.AddArgument($Arguments) | out-null
+ $Response = $pwsh.BeginInvoke()
+ # Store the PowerShell instance in an array for later retrieval
+ $powershellJobs += [PSCustomObject]@{
+ pwsh = $pwsh
+ Response = $Response
+ }
+}
+
+$powershellJobs.Response
+$runspacePool.RunspacePoolAvailability
+
+# Close the runspace pool
+$runspacePool.Close()
+$runspacePool.Dispose()
\ No newline at end of file
diff --git a/tools/gitlab-pages.txt b/tools/gitlab-pages.txt
new file mode 100644
index 0000000..fa6a852
--- /dev/null
+++ b/tools/gitlab-pages.txt
@@ -0,0 +1,6 @@
+Switch Environments
+
+Main.js
+ -> Change Development to false
+_config.yaml
+ -> Change - Uncommit dev and comment prod vs versa
\ No newline at end of file
diff --git a/tools/readme-nuget.md b/tools/readme-nuget.md
new file mode 100644
index 0000000..a13632d
--- /dev/null
+++ b/tools/readme-nuget.md
@@ -0,0 +1,68 @@
+*CommitFusion* is a PowerShell module crafted to streamline the creation of well-organized and uniform commit messages in adherence to the [๐งทConventional Commits specification](https://www.onventionalcommits.org/en/v1.0.0/) for your `git` repository.
+
+A custom version of the [๐งทcarloscuesta gitmojis Schema](/~https://github.com/carloscuesta/gitmoji/blob/master/packages/gitmojis/src/gitmojis.json) (accessible at [๐งทgitmoji.dev](https://gitmoji.dev)) is used to define the emojis, scope, and default description of the commit string.
+
+### Features
+
+- Conventional Commit specification.
+- Custom commit Types.
+- Customizable Commit Messages.
+- Changelog auto-updater.
+- Semver(*Semantic Versioning specification*).
+- Emoji parser.
+- Gitmoji parser.
+- Auto Commit
+
+## Example 1
+
+Minimal **Paramaters** to compose a commit message.
+
+```powershell
+# Feature commit message returns a string
+New-ConventionalCommit -Type improve
+
+```
+
+Ouput
+
+
+
+improve: Improve structure / format of the code.
+
+๐งฐ Build: patch
+
+
+## Example 2
+```powershell
+# Get the available commit types with semver value of patch
+Get-CiSetFusion
+```
+
+Output
+
+
+
+Type description semver cfs emoji
+---- ----------- ------ --- -----
+changes Introduce breaking changes. major ๐ฅ
+
+
+
+### Example 2
+
+Parameters for the module *all params* Compose a commit message with the following parameters:
+
+```powershell
+New-ConventionalCommit -type improve `
+ -Description "Fixed Output and emoji displayed" `
+ -Scope "Module" `
+ -Body "Added a new cmdlet called Get-Emoji" `
+ -Footer "Added a new cmdlet called Get-Emoji" `
+ -GitUser "sgkens" `
+ -GitGroup "ccharp" `
+ -FeatureAddtions "Exposes all methods and properties of the Table and Rule class" `
+ -BugFixes "Fixed Output and emoji displayed" `
+ -BreakingChanges "Fixed Output and emoji displayed" `
+ -FeatureNotes "Fixed Output and emoji displayed" `
+ -AsString $true
+```
diff --git a/run-bundle-jekyll-local.ps1 b/tools/run-bundle-jekyll-local.ps1
similarity index 62%
rename from run-bundle-jekyll-local.ps1
rename to tools/run-bundle-jekyll-local.ps1
index cc71aa9..26885cc 100644
--- a/run-bundle-jekyll-local.ps1
+++ b/tools/run-bundle-jekyll-local.ps1
@@ -1,2 +1,2 @@
-set-location .\docs
+set-location ..\docs
bundle exec jekyll serve --livereload
\ No newline at end of file
+
+ 
-
+
@@ -25,7 +29,8 @@
- 
+ 
@@ -95,6 +100,4 @@ $version = "v_$((Get-GitAutoVersion).Version)"
### Default avaliable commit types
-> Types are found at`$moduleroot/libs/commitfusion.types.json
-
-# ๐ Changelog
+> Types are found at`$moduleroot/libs/commitfusion.types.json
\ No newline at end of file
diff --git a/build/bt2-ci-create-packages.ps1 b/build/bt2-ci-create-packages.ps1
index e9a195d..a038bc3 100644
--- a/build/bt2-ci-create-packages.ps1
+++ b/build/bt2-ci-create-packages.ps1
@@ -7,22 +7,63 @@ $ModuleManifest = Test-ModuleManifest -path .\dist\$modulename\$modulename.psd1
#----Special Config Choco --------------------------------
# Choco supports markdown nuget and psgallary done
-$Additional_descriptions = @"
-*CommitFusion* is a PowerShell module crafted to streamline the creation of well-organized and uniform commit messages in adherence to the [๐งทConventional Commits specification](https://www.onventionalcommits.org/en/v1.0.0/) for your `git` repository.
-
-A custom version of the [๐งทcarloscuesta gitmojis Schema](/~https://github.com/carloscuesta/gitmoji/blob/master/packages/gitmojis/src/gitmojis.json) (accessible at [๐งทgitmoji.dev](https://gitmoji.dev)) is used to define the emojis, scope, and default description of the commit string.
+$Additional_descriptions = @'
+***CommitFusion*** is a **PowerShell** module designed to streamline the process of generating *Conventional Commits Messages* in `git`. Commit messages are constructed using the [๐งทConventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) standard, and uses [๐งทgitmojis Schema](/~https://github.com/carloscuesta/gitmoji/blob/master/packages/gitmojis/src/gitmojis.json) see [๐งทgitmoji.dev](https://gitmoji.dev), The module allows the construction of a custimized commit message with a number of options.
### Features
-- Conventional Commit specification.
-- Custom commit Types.
-- Customizable Commit Messages.
-- Changelog auto-updater.
-- Semver(*Semantic Versioning specification*).
-- Emoji parser.
-- Gitmoji parser.
-- Auto Commit
-"@
+๐ชถ Conventional Commits Standard
+๐ชถ Customizable Commit Message
+๐ชถ Semver Versioning Generator
+๐ชถ Changelog Auto-update with Markdown Auto-format
+๐ชถ Gitmoji Custom Schema
+
+## ๐พ Using Commitfusion
+
+Retrive list of available commit types
+
+``````powershell
+Get-CommitTypes
+``````
+
+Retrive list of available commit types.
+
+``````powershell
+Get-CommitTypes -Semver patch
+Get-CommitTypes -Semver minor
+Get-CommitTypes -Semver major
+Get-CommitTypes -Semver nosemver
+``````
+
+Creating a new feature` commit.
+
+``````powershell
+# Default Returns ]string]
+``````
+
+Assuming you have staged files, you can use the following to commit the changes:
+
+``````powershell
+# Apply Commit
+New-Commit @params | Set-Commit -Confirm
+# Apply Commit and write to changelog file
+New-Commit @params | Format-FusionMD | Update-Changelog -logfile path\to\file | Set-Commit -Confirm
+``````
+
+Generate Semver version base on you commits
+
+``````powershell
+# generate SemVer Version returns psobject
+Get-GitAutoVersion | select version
+# only string
+(Get-GitAutoVersion).Version
+``````
+
+### Default avaliable commit types
+
+> Types are found at $moduleroot/libs/commitfusion.types.json
+'@
+
#----Special Config Choco --------------------------------
$NuSpecParams = @{
path=".\dist\$ModuleName"
@@ -31,6 +72,7 @@ $NuSpecParams = @{
Author = $ModuleManifest.Author
Description = "$($ModuleManifest.Description)"
ProjectUrl = $ModuleManifest.PrivateData.PSData.ProjectUri
+ IconUrl = 'https://raw.githubusercontent.com/sgkens/resources/main/modules/CommitFusion/dist/v2/commitfusion-icon-x128.png'
License = "MIT"
company = $ModuleManifest.CompanyName
Tags = $ModuleManifest.Tags
@@ -42,8 +84,9 @@ $NuSpecParamsChoco = @{
ModuleName = $ModuleName
ModuleVersion = $ModuleManifest.Version -replace "\.\d+$",""
Author = $ModuleManifest.Author
- Description = "$($ModuleManifest.Description)"
+ Description = "$($ModuleManifest.Description) `n`n $Additional_descriptions"
ProjectUrl = $ModuleManifest.PrivateData.PSData.ProjectUri
+ IconUrl = 'https://raw.githubusercontent.com/sgkens/resources/main/modules/CommitFusion/dist/v2/commitfusion-icon-x128.png'
License = "MIT"
company = $ModuleManifest.CompanyName
Tags = $ModuleManifest.Tags
diff --git a/build/bt5-ci-deploy-pushtochoco.ps1 b/build/bt5-ci-deploy-pushtochoco.ps1
index ae3b617..8cbd364 100644
--- a/build/bt5-ci-deploy-pushtochoco.ps1
+++ b/build/bt5-ci-deploy-pushtochoco.ps1
@@ -10,8 +10,7 @@ $SemVerVersion = $ModuleManifest.Version -replace "\.\d+$",""
if(Get-command choco.exe){
write-host "Chocolatey is installed, skipping install"
write-host "Pushing to chocolatey https://community.chocolatey.org/"
- choco apikey --key $CHOCO_API_KEY --source https://push.chocolatey.org/
- choco.exe push .\dist\$ModuleName.$SemVerVersion.nupkg --source 'https://community.chocolatey.org/'
+ choco push .\dist\choco\$($ModuleManifest.CompanyName).$ModuleName.$SemVerVersion.nupkg --source 'https://community.chocolatey.org/' --api-key $CHOCO_API_KEY --source https://push.chocolatey.org/
write-host "Pushed to chocolatey - Complete"
}else{
write-host "Chocolatey is not installed, please install chocolatey https://community.chocolatey.org/"
diff --git a/build/bt6-ci-deploy-psgallary.ps1 b/build/bt6-ci-deploy-psgallary.ps1
index fb38ab4..c2bcb04 100644
--- a/build/bt6-ci-deploy-psgallary.ps1
+++ b/build/bt6-ci-deploy-psgallary.ps1
@@ -5,11 +5,10 @@ $ModuleManifest = Test-ModuleManifest -path ".\dist\$ModuleName\$ModuleName`.psd
#---CONFIG----------------------------
-
#------------------------------------
publish-Module `
-path ".\dist\$modulename" `
- -Repository 'psgallary' `
+ -Repository 'psgallery' `
-NuGetApiKey $PSGAL_API_KEY `
-projecturi $ModuleManifest.ProjectUri `
-licenseuri $ModuleManifest.LicenseUri `
diff --git a/coverage.xml b/coverage.xml
deleted file mode 100644
index 1094fbb..0000000
--- a/coverage.xml
+++ /dev/null
@@ -1,675 +0,0 @@
-
-
-