Skip to content

Commit 92fd605

Browse files
Nick2bad4uNick2bad4u
committed
✨ [feat] Enhances ColorScripts module with new features
Adds new colorscripts, improves documentation, and enhances functionality. - ➕ Adds 9 new colorscripts to the module, increasing the total number of available scripts from 286 to 295. - ✨ The new scripts include a variety of styles and categories, expanding the module's visual appeal and utility. - 📝 Updates the module manifest (`ColorScripts-Enhanced.psd1`) to reflect the new version, script count, and file list. - 🔢 The `ModuleVersion` is updated to `2025.10.15.0137`. - 📄 The `FileList` is updated to include the new `README-Gallery.md` file. - 🛠️ Modifies the `Get-ColorScriptConfiguration`, `Set-ColorScriptConfiguration`, `Reset-ColorScriptConfiguration`, `Show-ColorScript`, `Get-ColorScriptList`, `Export-ColorScriptMetadata`, `Build-ColorScriptCache`, `Clear-ColorScriptCache`, `New-ColorScript`, and `Add-ColorScriptProfile` functions in `ColorScripts-Enhanced.psm1` - ➕ Adds `-Help` switch parameter to all functions to display full cmdlet help using `Get-Help` for each function. - 📝 Includes new documentation files: - 📄 `ANSI-COLOR-GUIDE.md`: Provides guidelines for creating ANSI color scripts in PowerShell, covering variable delimiters, escape sequences, and best practices. - 📄 `ANSI-CONVERSION-GUIDE.md`: Details how to convert ANSI art files to ColorScripts, including batch conversion and advanced options. - 📄 `CONTRIBUTORS.md`: Lists project contributors and provides instructions on how to contribute. - 📄 `DOCUMENTATION_INDEX.md`: Serves as a comprehensive index of all documentation files in the repository. - 📄 `Development.md`: Outlines local development practices for the ColorScripts-Enhanced module. - 📄 `LINTING.md`: Covers code quality standards and linting procedures for the module. - 📄 `MEGALINTER-SETUP.md`: Provides instructions for setting up MegaLinter for the project. - 📄 `MODULE_SUMMARY.md`: Offers a complete implementation summary of the ColorScripts-Enhanced module. - 📄 `NPM_SCRIPTS.md`: Describes the npm scripts available for ColorScripts-Enhanced development and maintenance. - 📄 `POWERSHELL-VERSIONS.md`: Explains the PowerShell version support strategy for the module. - 📄 `Publishing.md`: Details how to publish the module to different package galleries. - 📄 `QUICK_REFERENCE.md`: Provides a quick reference guide for the ColorScripts-Enhanced module. - 📄 `REORGANIZATION.md`: Describes the repository structure reorganization performed. - 📄 `ROADMAP.md`: Highlights short-, medium-, and long-term priorities for the module. - 📄 `ReleaseChecklist.md`: Lists a step-by-step guide to produce a production-ready release of ColorScripts-Enhanced. - 📄 `SUPPORT.md`: Explains how to request help and what to expect from the maintainers. - 📝 Updates `README-Gallery.md` and `README.md` to reflect the new number of colorscripts - 📝 Updates `ScriptMetadata.psd1`, improving script categorization and metadata - ✨ Adds new categories `AutoCategorized`, `Custom`. - ➕ Adds descriptions for all colorscripts Signed-off-by: Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com>
1 parent 18e1741 commit 92fd605

34 files changed

Lines changed: 4449 additions & 153 deletions

‎ColorScripts-Enhanced/ColorScripts-Enhanced.psd1‎

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,33 @@
33
#
44
# Generated by: Nick2bad4u
55
#
6-
# Generated on: 10/14/2025
6+
# Generated on: 10/15/2025
77
#
88

99
@{
1010
# Script module or binary module file associated with this manifest.
11-
RootModule = 'ColorScripts-Enhanced.psm1'
11+
RootModule = 'ColorScripts-Enhanced.psm1'
1212

1313
# Version number of this module.
14-
ModuleVersion = '2025.10.14.2033'
14+
ModuleVersion = '2025.10.15.0137'
1515

1616
# Supported PSEditions
17-
CompatiblePSEditions = @('Desktop', 'Core')
17+
CompatiblePSEditions = @('Desktop', 'Core')
1818

1919
# ID used to uniquely identify this module
20-
GUID = 'f77548d7-23eb-48ce-a6e0-f64b4758d995'
20+
GUID = 'f77548d7-23eb-48ce-a6e0-f64b4758d995'
2121

2222
# Author of this module
23-
Author = 'Nick2bad4u'
23+
Author = 'Nick2bad4u'
2424

2525
# Company or vendor of this module
26-
CompanyName = 'Community'
26+
CompanyName = 'Community'
2727

2828
# Copyright statement for this module
29-
Copyright = '(c) 2025. All rights reserved.'
29+
Copyright = '(c) 2025. All rights reserved.'
3030

3131
# Description of the functionality provided by this module
32-
Description = @'
32+
Description = @'
3333
Enhanced PowerShell ColorScripts with high-performance caching system. Display beautiful ANSI art in your terminal with 6-19x faster load times.
3434
3535
Features:
@@ -48,7 +48,7 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
4848
'@
4949

5050
# Minimum version of the PowerShell engine required by this module
51-
PowerShellVersion = '5.1'
51+
PowerShellVersion = '5.1'
5252

5353
# Name of the PowerShell host required by this module
5454
# PowerShellHostName = ''
@@ -84,7 +84,7 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
8484
# NestedModules = @()
8585

8686
# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
87-
FunctionsToExport = @(
87+
FunctionsToExport = @(
8888
'Show-ColorScript'
8989
'Get-ColorScriptList'
9090
'Build-ColorScriptCache'
@@ -98,13 +98,13 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
9898
)
9999

100100
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
101-
CmdletsToExport = @()
101+
CmdletsToExport = @()
102102

103103
# Variables to export from this module
104-
VariablesToExport = @()
104+
VariablesToExport = @()
105105

106106
# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
107-
AliasesToExport = @('scs')
107+
AliasesToExport = @('scs')
108108

109109
# DSC resources to export from this module
110110
# DscResourcesToExport = @()
@@ -113,19 +113,20 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
113113
# ModuleList = @()
114114

115115
# List of all files packaged with this module
116-
FileList = @(
116+
FileList = @(
117117
'ColorScripts-Enhanced.psm1'
118118
'ColorScripts-Enhanced.psd1'
119119
'README.md'
120+
'README-Gallery.md'
120121
'ScriptMetadata.psd1'
121122
'Install.ps1'
122123
)
123124

124125
# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
125-
PrivateData = @{
126+
PrivateData = @{
126127
PSData = @{
127128
# Tags applied to this module. These help with module discovery in online galleries.
128-
Tags = @(
129+
Tags = @(
129130
'ColorScripts'
130131
'ANSI'
131132
'Terminal'
@@ -158,25 +159,25 @@ Full documentation: https://github.com/Nick2bad4u/ps-color-scripts-enhanced
158159
)
159160

160161
# A URL to the license for this module.
161-
LicenseUri = 'https://licenses.nuget.org/MIT'
162+
LicenseUri = 'https://licenses.nuget.org/MIT'
162163

163164
# License expression or path to license file
164-
License = 'MIT'
165+
License = 'MIT'
165166

166167
# A URL to the main website for this project.
167-
ProjectUri = 'https://github.com/Nick2bad4u/ps-color-scripts-enhanced'
168+
ProjectUri = 'https://github.com/Nick2bad4u/ps-color-scripts-enhanced'
168169

169170
# A URL to an icon representing this module.
170-
IconUri = 'https://raw.githubusercontent.com/Nick2bad4u/ps-color-scripts-enhanced/main/docs/colorscripts-icon.png'
171+
IconUri = 'https://raw.githubusercontent.com/Nick2bad4u/ps-color-scripts-enhanced/main/docs/colorscripts-icon.png'
171172

172173
# ReleaseNotes of this module
173-
ReleaseNotes = @'
174-
Version 2025.10.14.2033:
174+
ReleaseNotes = @'
175+
Version 2025.10.15.0137:
175176
- Enhanced caching system with OS-wide cache in AppData
176177
- 6-19x performance improvement
177178
- Cache stored in centralized location
178179
- Works from any directory
179-
- 286 beautiful colorscripts included
180+
- 295 beautiful colorscripts included
180181
- Full comment-based help documentation
181182
- Scripts optimized for performance and visual quality
182183
- Cross-platform support (Windows, Linux, macOS)
@@ -195,7 +196,7 @@ Version 2025.10.14.2033:
195196
}
196197

197198
# HelpInfo URI of this module
198-
HelpInfoURI = 'https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/README.md'
199+
HelpInfoURI = 'https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/README.md'
199200

200201
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
201202
# DefaultCommandPrefix = ''

‎ColorScripts-Enhanced/ColorScripts-Enhanced.psm1‎

Lines changed: 88 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,15 @@ function Get-ColorScriptConfiguration {
195195
.EXTERNALHELP ColorScripts-Enhanced-help.xml
196196
#>
197197
[CmdletBinding()]
198-
param()
198+
param(
199+
[Alias('Help')]
200+
[switch]$h
201+
)
202+
203+
if ($h) {
204+
Get-Help Get-ColorScriptConfiguration -Full
205+
return
206+
}
199207

200208
$data = Copy-ColorScriptHashtable (Get-ConfigurationDataInternal)
201209
return $data
@@ -207,13 +215,21 @@ function Set-ColorScriptConfiguration {
207215
#>
208216
[CmdletBinding()]
209217
param(
218+
[Alias('Help')]
219+
[switch]$h,
220+
210221
[Nullable[bool]]$AutoShowOnImport,
211222
[Nullable[bool]]$ProfileAutoShow,
212223
[string]$CachePath,
213224
[string]$DefaultScript,
214225
[switch]$PassThru
215226
)
216227

228+
if ($h) {
229+
Get-Help Set-ColorScriptConfiguration -Full
230+
return
231+
}
232+
217233
$data = Get-ConfigurationDataInternal
218234

219235
if ($PSBoundParameters.ContainsKey('AutoShowOnImport')) {
@@ -267,9 +283,17 @@ function Reset-ColorScriptConfiguration {
267283
#>
268284
[CmdletBinding(SupportsShouldProcess = $true)]
269285
param(
286+
[Alias('Help')]
287+
[switch]$h,
288+
270289
[switch]$PassThru
271290
)
272291

292+
if ($h) {
293+
Get-Help Reset-ColorScriptConfiguration -Full
294+
return
295+
}
296+
273297
$configRoot = Get-ColorScriptsConfigurationRoot
274298
$configPath = Join-Path -Path $configRoot -ChildPath 'config.json'
275299

@@ -1491,6 +1515,10 @@ function Show-ColorScript {
14911515
[CmdletBinding(DefaultParameterSetName = 'Random')]
14921516
[Alias('scs')]
14931517
param(
1518+
[Parameter(ParameterSetName = 'Help')]
1519+
[Alias('Help')]
1520+
[switch]$h,
1521+
14941522
[Parameter(ParameterSetName = 'Named', Position = 0)]
14951523
[SupportsWildcards()]
14961524
[string]$Name,
@@ -1519,6 +1547,12 @@ function Show-ColorScript {
15191547
[switch]$ReturnText
15201548
)
15211549

1550+
# Handle help request
1551+
if ($h) {
1552+
Get-Help Show-ColorScript -Full
1553+
return
1554+
}
1555+
15221556
# Handle list request
15231557
if ($List) {
15241558
$listParams = @{}
@@ -1651,6 +1685,9 @@ function Get-ColorScriptList {
16511685
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Structured list is emitted for pipeline consumption.')]
16521686
[CmdletBinding()]
16531687
param(
1688+
[Alias('Help')]
1689+
[switch]$h,
1690+
16541691
[switch]$AsObject,
16551692
[switch]$Detailed,
16561693
[SupportsWildcards()]
@@ -1659,6 +1696,11 @@ function Get-ColorScriptList {
16591696
[string[]]$Tag
16601697
)
16611698

1699+
if ($h) {
1700+
Get-Help Get-ColorScriptList -Full
1701+
return
1702+
}
1703+
16621704
$records = Get-ColorScriptEntry -Category $Category -Tag $Tag | Sort-Object Name
16631705

16641706
if ($Name) {
@@ -1709,6 +1751,9 @@ function Export-ColorScriptMetadata {
17091751
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseSingularNouns', '', Justification = 'Metadata is a collective noun representing the exported dataset.')]
17101752
[CmdletBinding()]
17111753
param(
1754+
[Alias('Help')]
1755+
[switch]$h,
1756+
17121757
[Parameter()]
17131758
[string]$Path,
17141759

@@ -1722,6 +1767,11 @@ function Export-ColorScriptMetadata {
17221767
[switch]$PassThru
17231768
)
17241769

1770+
if ($h) {
1771+
Get-Help Export-ColorScriptMetadata -Full
1772+
return
1773+
}
1774+
17251775
$records = Get-ColorScriptEntry | Sort-Object Name
17261776
Initialize-CacheDirectory
17271777

@@ -1822,6 +1872,9 @@ function Build-ColorScriptCache {
18221872
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Returns structured pipeline records for each cache operation.')]
18231873
[CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')]
18241874
param(
1875+
[Alias('Help')]
1876+
[switch]$h,
1877+
18251878
[Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
18261879
[SupportsWildcards()]
18271880
[string[]]$Name,
@@ -1843,6 +1896,11 @@ function Build-ColorScriptCache {
18431896
)
18441897

18451898
begin {
1899+
if ($h) {
1900+
Get-Help Build-ColorScriptCache -Full
1901+
return
1902+
}
1903+
18461904
$collectedNames = New-Object 'System.Collections.Generic.List[string]'
18471905
}
18481906

@@ -2049,6 +2107,9 @@ function Clear-ColorScriptCache {
20492107
[Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseOutputTypeCorrectly', '', Justification = 'Returns structured pipeline records for each cache entry.')]
20502108
[CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')]
20512109
param(
2110+
[Alias('Help')]
2111+
[switch]$h,
2112+
20522113
[Parameter(ValueFromPipeline, ValueFromPipelineByPropertyName)]
20532114
[SupportsWildcards()]
20542115
[string[]]$Name,
@@ -2070,6 +2131,11 @@ function Clear-ColorScriptCache {
20702131
)
20712132

20722133
begin {
2134+
if ($h) {
2135+
Get-Help Clear-ColorScriptCache -Full
2136+
return
2137+
}
2138+
20732139
$collectedNames = New-Object 'System.Collections.Generic.List[string]'
20742140
}
20752141

@@ -2327,6 +2393,9 @@ function New-ColorScript {
23272393
#>
23282394
[CmdletBinding(SupportsShouldProcess = $true)]
23292395
param(
2396+
[Alias('Help')]
2397+
[switch]$h,
2398+
23302399
[Parameter(Mandatory)]
23312400
[ValidatePattern('^[a-zA-Z0-9][a-zA-Z0-9_-]*$')]
23322401
[string]$Name,
@@ -2347,6 +2416,11 @@ function New-ColorScript {
23472416
[switch]$GenerateMetadataSnippet
23482417
)
23492418

2419+
if ($h) {
2420+
Get-Help New-ColorScript -Full
2421+
return
2422+
}
2423+
23502424
$targetDirectory = $script:ScriptsPath
23512425
if ($PSBoundParameters.ContainsKey('OutputPath')) {
23522426
$resolvedOutput = Resolve-CachePath -Path $OutputPath
@@ -2411,11 +2485,11 @@ foreach ($line in $ansiLines) {
24112485
}
24122486

24132487
$result = [pscustomobject]@{
2414-
Name = $Name
2415-
Path = $targetPath
2416-
CategorySuggestion = if ($Category) { $Category } else { $null }
2417-
TagSuggestion = if ($Tag) { [string[]]$Tag } else { @() }
2418-
MetadataGuidance = $metadataSnippet
2488+
Name = $Name
2489+
Path = $targetPath
2490+
CategorySuggestion = if ($Category) { $Category } else { $null }
2491+
TagSuggestion = if ($Tag) { [string[]]$Tag } else { @() }
2492+
MetadataGuidance = $metadataSnippet
24192493
}
24202494

24212495
if ($metadataSnippet) {
@@ -2431,6 +2505,9 @@ function Add-ColorScriptProfile {
24312505
#>
24322506
[CmdletBinding(SupportsShouldProcess = $true)]
24332507
param(
2508+
[Alias('Help')]
2509+
[switch]$h,
2510+
24342511
[Parameter()]
24352512
[ValidateSet('CurrentUserAllHosts', 'CurrentUserCurrentHost', 'AllUsersAllHosts', 'AllUsersCurrentHost')]
24362513
[string]$Scope = 'CurrentUserAllHosts',
@@ -2445,6 +2522,11 @@ function Add-ColorScriptProfile {
24452522
[switch]$Force
24462523
)
24472524

2525+
if ($h) {
2526+
Get-Help Add-ColorScriptProfile -Full
2527+
return
2528+
}
2529+
24482530
if ($null -ne $PSSenderInfo) {
24492531
Write-Warning "Profile updates are not supported in remote sessions."
24502532
return [pscustomobject]@{

‎ColorScripts-Enhanced/README-Gallery.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Display beautiful ANSI colorscripts in your terminal with intelligent caching fo
88

99
## Features
1010

11-
- ✨ **<!-- COLOR_SCRIPT_COUNT_PLUS -->286+<!-- /COLOR_SCRIPT_COUNT_PLUS --> Colorscripts** - Extensive ANSI art collection across 15+ categories
11+
- ✨ **<!-- COLOR_SCRIPT_COUNT_PLUS -->295+<!-- /COLOR_SCRIPT_COUNT_PLUS --> Colorscripts** - Extensive ANSI art collection across 15+ categories
1212
- ⚡ **6-19x Faster** - Intelligent caching (5-20ms vs 50-300ms load times)
1313
- 🌐 **Cross-Platform** - Fully tested on Windows, macOS, and Linux
1414
- 🎯 **Simple API** - Easy cmdlets with full tab completion
@@ -202,4 +202,3 @@ MIT - See [LICENSE](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob
202202
---
203203

204204
**Tip**: Run `Get-ColorScriptList | Select-Object -First 10` to preview your first 10 scripts!
205-

0 commit comments

Comments
 (0)