Skip to content

Commit 18e1741

Browse files
committed
πŸ“ [docs] Refactor README and add GWAR tribute
πŸ“ [docs] Refactors the README for clarity and includes a GWAR tribute ANSI script - ✨ [feat] Adds new ANSI art: - Adds a tribute to GWAR, converted from an ANSI file, split into multiple PowerShell scripts for better handling - Adds the original ANSI file for the GWAR tribute - 🚜 [refactor] Improves documentation structure: - Categorizes documentation links in the README into "User Documentation", "Developer Documentation", and "Project Information" for better organization - Moves testing, linting, npm scripts, release process, and additional package feeds information into separate documentation files - Removes the "ANSI Utility Scripts" section, as its content is now integrated into the "ANSI Conversion Guide" - πŸ“ [docs] Enhances contribution guidelines: - Expands the contribution guidelines, providing more details on development setup, coding standards, pull request submission, and testing requirements - Refers to the "Developer Documentation" section for development-specific tasks - ⚑ [perf] Optimizes ANSI conversion guide: - Adds a section on advanced utilities, including instructions for splitting super-tall ANSI art and using other developer utilities like `Generate-ReleaseNotes.ps1` and `Validate-Changelog.ps1` - πŸ› οΈ [fix] Fixes documentation links: - Updates broken links and improves the overall clarity and accuracy of the documentation - 🧹 [chore] Moves and renames files: - Moves oversized colorscripts from the `docs` directory to the `assets` directory to better organize the project structure - Moves the `ant80s_gwar_tribute.ans` file to the `assets` directory Signed-off-by: Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com>
1 parent c142500 commit 18e1741

1,823 files changed

Lines changed: 133751 additions & 179 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

β€ŽBlocktronics-WTF4_Megajoint.ansβ€Ž

Lines changed: 1296 additions & 0 deletions
Large diffs are not rendered by default.

β€ŽColorScripts-Enhanced/README.mdβ€Ž

Lines changed: 19 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,9 @@ A high-performance PowerShell module for displaying beautiful ANSI colorscripts
4141
- [Installation](#installation)
4242
- [Usage](#usage)
4343
- [Performance](#performance)
44-
- [ANSI Utility Scripts](#ansi-utility-scripts)
4544
- [Available Colorscripts](#available-colorscripts)
4645
- [Commands](#commands)
47-
- [Testing](#testing)
48-
- [Linting](#linting)
49-
- [npm Scripts](#npm-scripts)
5046
- [Documentation](#documentation)
51-
- [Release Process](#release-process)
52-
- [Additional Package Feeds](#additional-package-feeds)
5347
- [Contributing](#contributing)
5448
- [License](#license)
5549
- [Support](#support)
@@ -392,71 +386,41 @@ Get-Help about_ColorScripts-Enhanced
392386

393387
## Documentation
394388

389+
### User Documentation
390+
395391
- [Quick Start & Reference](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/QUICK_REFERENCE.md)
396392
- [ANSI Color Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/ANSI-COLOR-GUIDE.md)
397393
- [ANSI Conversion Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/ANSI-CONVERSION-GUIDE.md)
398394
- [ANSI Conversion Examples](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/examples/ansi-conversion/README.md)
399395
- [Module Summary](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/MODULE_SUMMARY.md)
396+
397+
### Developer Documentation
398+
400399
- [Development Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/Development.md)
400+
- [Testing Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/TESTING.md)
401+
- [Linting Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/LINTING.md)
402+
- [npm Scripts Reference](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/NPM_SCRIPTS.md)
401403
- [Publishing Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/Publishing.md)
402404
- [Release Checklist](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/ReleaseChecklist.md)
405+
406+
### Project Information
407+
403408
- [Support Policy](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/SUPPORT.md)
404409
- [Code of Conduct](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/CODE_OF_CONDUCT.md)
405410
- [Security Policy](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/SECURITY.md)
406411
- [Project Roadmap](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/ROADMAP.md)
412+
- [Documentation Index](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/DOCUMENTATION_INDEX.md)
407413

408-
## Testing
409-
410-
- Smoke tests (includes ScriptAnalyzer): `pwsh -NoProfile -Command "& .\scripts\Test-Module.ps1"`
411-
- Full test suite: `Invoke-Pester -Path ./Tests`
412-
- Continuous integration: [`test.yml`](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/.github/workflows/test.yml) runs on Windows PowerShell 5.1, PowerShell 7.x across Windows/Linux/macOS, includes a PowerShell 7.5 preview container smoke test, and validates markdown links.
413-
414-
## Linting
415-
416-
- Linting (module only): `pwsh -NoProfile -Command "& .\scripts\Lint-Module.ps1"`
417-
- Linting (treat warnings as errors and include tests): `pwsh -NoProfile -Command "& .\scripts\Lint-Module.ps1" -IncludeTests -TreatWarningsAsErrors`
418-
- Lint auto-fix (apply ScriptAnalyzer fixes, then re-run lint): `pwsh -NoProfile -Command "& .\scripts\Lint-Module.ps1" -Fix`
419-
420-
## npm Scripts
421-
422-
> **Note:** The following npm scripts are for development and repository maintenance only. End-users do not need Node.js or npm to use the PowerShell module.
423-
424-
| Command | Description |
425-
| --------------------------------------------------- | ---------------------------------------------------------------------------- |
426-
| `npm run build` | Build the module manifest and refresh documentation counts. |
427-
| `npm run lint` | Run ScriptAnalyzer against the module. |
428-
| `npm run lint:strict` | Run lint with tests included and warnings treated as errors. |
429-
| `npm run lint:fix` | Apply ScriptAnalyzer fixes where possible, then rerun lint. |
430-
| `npm test` | Execute the smoke-test harness (`Test-Module.ps1`). |
431-
| `npm run test:pester` | Run the full Pester suite in `./Tests`. |
432-
| `npm run docs:update-counts` | Synchronize script-count markers across all docs. |
433-
| `npm run package:metadata -- --PackagePath <nupkg>` | Inject README/license/icon metadata into a generated package before pushing. |
434-
| `npm run scripts:convert -- <ansi-file>` | Convert an ANSI file into a colorscript (Node-based converter). |
435-
| `npm run scripts:split -- <file> [options]` | Split a tall ANSI or PowerShell script into multiple chunks. |
436-
| `npm run scripts:test-all` | Execute every colorscript via `Test-AllColorScripts.ps1`. |
437-
| `npm run release:notes` | Generate unreleased notes (stripped header) for gallery publishing. |
438-
| `npm run release:notes:latest` | Generate the most recent tagged release notes. |
439-
| `npm run release:verify` | Validate CHANGELOG.md against the module manifest and git-cliff. |
440-
| `npm run markdown:check` | Run `markdown-link-check` across all repository docs. |
441-
| `npm run verify` | Run strict linting, markdown checks, and both smoke + Pester tests. |
442-
443-
## Release Process
444-
445-
- Automated publishing workflow: [`publish.yml`](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/.github/workflows/publish.yml)
446-
- Local helper script: `build.ps1`
447-
- Release notes automation: `npm run release:notes` (gallery snippet) & `npm run release:verify` (requires [git-cliff](https://github.com/orhun/git-cliff))
448-
- Optional help generation: `Build-Help.ps1`
449-
- Documentation: [Publishing Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/Publishing.md) & [Release Checklist](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/ReleaseChecklist.md)
414+
## Contributing
450415

451-
## Additional Package Feeds
416+
We welcome contributions! Please review [CONTRIBUTING.md](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/CONTRIBUTING.md) for:
452417

453-
- PowerShell Gallery / NuGet.org (primary distribution)
454-
- GitHub Packages (optional; instructions in [Publishing Guide](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/docs/Publishing.md))
455-
- Azure Artifacts or other NuGet-compatible feeds for enterprise deployment
418+
- Development setup and workflow
419+
- Coding standards and best practices
420+
- How to submit pull requests
421+
- Testing requirements
456422

457-
## Contributing
458-
459-
Please review [CONTRIBUTING.md](https://github.com/Nick2bad4u/ps-color-scripts-enhanced/blob/main/CONTRIBUTING.md) for development guidelines, coding standards, and how to submit pull requests.
423+
For development-specific tasks, see the [Developer Documentation](#developer-documentation) section above.
460424

461425
## Performance
462426

@@ -572,38 +536,6 @@ The module includes <!-- COLOR_SCRIPT_COUNT_PLUS -->286+<!-- /COLOR_SCRIPT_COUNT
572536

573537
Use `Show-ColorScript -List` to see all available scripts.
574538

575-
## ANSI Utility Scripts
576-
577-
The repository ships several helpers for working with ANSI art, release notes, and documentation hygiene:
578-
579-
- `Convert-AnsiToColorScript.js` converts a `.ANS` file into a PowerShell script ready to drop into `ColorScripts-Enhanced/Scripts`.
580-
- `scripts/Split-AnsiFile.js` slices extremely tall ANSI art into smaller chunks that can be converted individually.
581-
- `scripts/Generate-ReleaseNotes.ps1` wraps `git-cliff` so you can build PowerShell Gallery release notes or tag summaries in one command.
582-
- `scripts/Validate-Changelog.ps1` checks that `CHANGELOG.md` matches the manifest version and the latest `git-cliff` output.
583-
- `scripts/Invoke-MarkdownLinkCheck.ps1` runs `markdown-link-check` across every markdown file using the bundled configuration.
584-
- `docs/examples/ansi-conversion/` contains turnkey PowerShell scripts that demonstrate the Node and PowerShell conversion utilities end-to-end.
585-
586-
### Split Super-Tall ANSI Art
587-
588-
```powershell
589-
# Preview suggested splits without writing files (looks for 4+ blank rows)
590-
node scripts/Split-AnsiFile.js .\we-ACiDTrip.ANS --auto --dry-run
591-
592-
# Generate three 300-line chunks as PowerShell scripts
593-
node scripts/Split-AnsiFile.js .\we-ACiDTrip.ANS --heights=300,300,300
594-
595-
# Emit ANSI slices instead of .ps1 wrappers
596-
node scripts/Split-AnsiFile.js .\we-ACiDTrip.ANS --format=ansi --breaks=420,840
597-
598-
# Split an already converted colorscript
599-
node scripts/Split-AnsiFile.js .\ColorScripts-Enhanced\Scripts\we-acidtrip.ps1 --input=ps1 --heights=320,320
600-
601-
# Split every 160 lines automatically
602-
node scripts/Split-AnsiFile.js .\we-ACiDTrip.ANS --every=160
603-
```
604-
605-
Options can be combined--`--auto` adds breaks where large blank gaps exist, `--heights` / `--breaks` enforce manual cut points, `--every=<n>` evenly divides the render, and `--strip-space-bg` (ANSI input only) mirrors the conversion behavior that clears background colors on plain spaces. Each output chunk is normalized with a trailing `ESC[0m` so the terminal resets cleanly after display.
606-
607539
## Troubleshooting
608540

609541
### Cache Not Working
@@ -760,4 +692,3 @@ For support options, response targets, and contact channels, review the [Support
760692
- [r/ANSIart](https://www.reddit.com/r/ANSIart/)
761693

762694
- [Sixteen Colors Facebook](https://www.facebook.com/sixteencolors/)
763-

0 commit comments

Comments
Β (0)