rabe/helpers-functions-cli
11
0
Fork 0
mirror of https://github.com/n3w/helpers-functions-cli.git synced 2025-12-19 12:43:22 +00:00
Code Issues Projects Releases Wiki Activity

Updated composer.json, README, and CHANGELOG for 1.1.6 release

Browse source
This commit is contained in:
Alannah Kearney 2019-05-25 14:29:34 +10:00
commit 4c33ccfc23
3 changed files with 18 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

9
CHANGELOG.md
View file

@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
**View all [Unreleased][] changes here** **View all [Unreleased][] changes here**
## [1.1.6][]
#### Added
- Added `display_error_and_exit` function
## [1.1.5][] ## [1.1.5][]
#### Changed #### Changed
- Updated to work with `pointybeard/helpers-cli-input` v1.1.x - Updated to work with `pointybeard/helpers-cli-input` v1.1.x
@ -38,8 +42,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
#### Added #### Added
- Initial release - Initial release
[Unreleased]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.5...integration [Unreleased]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.6...integration
[1.1.5]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.5...1.1.5 [1.1.6]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.5...1.1.6
[1.1.5]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.4...1.1.5
[1.1.4]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.3...1.1.4 [1.1.4]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.3...1.1.4
[1.1.3]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.2...1.1.3 [1.1.3]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.2...1.1.3
[1.1.2]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.1...1.1.2 [1.1.2]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.1...1.1.2

9
README.md
View file

@ -1,7 +1,7 @@
# PHP Helpers: Command-line Functions # PHP Helpers: Command-line Functions
- Version: v1.1.5 - Version: v1.1.6
- Date: May 24 2019 - Date: May 25 2019
- [Release notes](https://github.com/pointybeard/helpers-functions-cli/blob/master/CHANGELOG.md) - [Release notes](https://github.com/pointybeard/helpers-functions-cli/blob/master/CHANGELOG.md)
- [GitHub repository](https://github.com/pointybeard/helpers-functions-cli) - [GitHub repository](https://github.com/pointybeard/helpers-functions-cli)
@ -33,6 +33,7 @@ The following functions are provided:
- `usage(string $name, Cli\Input\InputCollection $collection) : string` - `usage(string $name, Cli\Input\InputCollection $collection) : string`
- `manpage(string $name, string $version, string $description, Input\InputCollection $collection, $foregroundColour=Colour\Colour::FG_DEFAULT, $headingColour=Colour\Colour::FG_WHITE, array $additional=[]): string` - `manpage(string $name, string $version, string $description, Input\InputCollection $collection, $foregroundColour=Colour\Colour::FG_DEFAULT, $headingColour=Colour\Colour::FG_WHITE, array $additional=[]): string`
- `get_window_size(): array` - `get_window_size(): array`
- `display_error_and_exit($message, $heading = 'Error', $background = Colour\Colour::BG_RED): void`
Example usage: Example usage:
@ -119,6 +120,10 @@ echo Cli\manpage(
// Examples: // Examples:
// php -f test.php -- import -vvv -d test.json // php -f test.php -- import -vvv -d test.json
Cli\display_error_and_exit('Looks like something went wrong!', 'Fatal Error');
// Fatal Error
// Looks like something went wrong!
``` ```
## Support ## Support

5
composer.json
View file

@ -1,6 +1,6 @@
{ {
"name": "pointybeard/helpers-functions-cli", "name": "pointybeard/helpers-functions-cli",
"version": "1.1.5", "version": "1.1.6",
"description": "A collection of functions relating to the command-line", "description": "A collection of functions relating to the command-line",
"homepage": "https://github.com/pointybeard/helpers-functions-cli", "homepage": "https://github.com/pointybeard/helpers-functions-cli",
"license": "MIT", "license": "MIT",
@ -17,7 +17,8 @@
"pointybeard/helpers-cli-input": "~1.1", "pointybeard/helpers-cli-input": "~1.1",
"pointybeard/helpers-cli-colour": "~1", "pointybeard/helpers-cli-colour": "~1",
"pointybeard/helpers-functions-strings": "~1.1", "pointybeard/helpers-functions-strings": "~1.1",
"pointybeard/helpers-functions-flags": "~1" "pointybeard/helpers-functions-flags": "~1",
"pointybeard/helpers-functions-arrays": "~1"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "^8" "phpunit/phpunit": "^8"