Updated README and CHANGELOG for 1.1.8 release

This commit is contained in:
Alannah Kearney 2019-06-01 23:04:07 +10:00
commit ace7c68ed6
2 changed files with 22 additions and 17 deletions

View file

@ -3,7 +3,11 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).
**View all [Unreleased][] changes here**
## [1.1.8][]
#### Changed
- Updated `manpage()` to work with `pointybeard/helpers-cli-input` 1.2
- Using v1.2.x of `pointybeard/helpers-cli-input`
- Updated version constraints in `composer.json`
## [1.1.7][]
#### Added
@ -22,11 +26,11 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [1.1.4][]
#### Changed
- Refactoring of `manpage()` to hide 'Options' and/or 'Arguments' if there are none to show.
- Refactoring of `manpage()` to hide 'Options' and/or 'Arguments' if there are none to show
## [1.1.3][]
#### Changed
- Updated `manpage()` to include `foregroundColour`, `headingColour`, and `additional` arguments. Removed `example` argument in favour of including it inside `additional`.
- Updated `manpage()` to include `foregroundColour`, `headingColour`, and `additional` arguments. Removed `example` argument in favour of including it inside `additional`
- Added `pointybeard/helpers-cli-colour` composer package
## [1.1.2][]
@ -49,7 +53,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
#### Added
- Initial release
[Unreleased]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.6...integration
[1.1.8]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.7...1.1.8
[1.1.7]: https://github.com/pointybeard/helpers-functions-cli/compare/1.1.6...1.1.7
[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

View file

@ -1,7 +1,7 @@
# PHP Helpers: Command-line Functions
- Version: v1.1.7
- Date: May 26 2019
- Version: v1.1.8
- Date: June 01 2019
- [Release notes](https://github.com/pointybeard/helpers-functions-cli/blob/master/CHANGELOG.md)
- [GitHub repository](https://github.com/pointybeard/helpers-functions-cli)
@ -61,16 +61,16 @@ var_dump(Cli\get_window_size());
echo Cli\manpage(
'test',
'1.0.1',
'1.0.2',
'A simple test command with a really long description. This is an intentionally very long argument description so we can check that word wrapping is working correctly. It should wrap to the window',
(new Input\InputCollection())
->append(
->add(
Input\InputTypeFactory::build('Argument')
->name('action')
->flags(Input\AbstractInputType::FLAG_REQUIRED)
->description('The name of the action to perform. This is an intentionally very long argument description so we can check that word wrapping is working correctly')
)
->append(
->add(
Input\InputTypeFactory::build('IncrementingFlag')
->name('v')
->flags(Input\AbstractInputType::FLAG_OPTIONAL | Input\AbstractInputType::FLAG_TYPE_INCREMENTING)
@ -82,14 +82,14 @@ echo Cli\manpage(
}
))
)
->append(
->add(
Input\InputTypeFactory::build('Option')
->name('P')
->flags(Input\AbstractInputType::FLAG_OPTIONAL | Input\AbstractInputType::FLAG_VALUE_OPTIONAL)
->description('Port to use for all connections.')
->default('3306')
)
->append(
->add(
Input\InputTypeFactory::build('LongOption')
->name('data')
->short('d')
@ -103,17 +103,17 @@ echo Cli\manpage(
]
).PHP_EOL;
// test 1.0.0, A simple test command with a really long description. This is an intentionally very long argument description so we can check that word wrapping is working correctly. It should wrap to the window
// test 1.0.2, A simple test command with a really long description. This is an intentionally very long argument description so we can check that word wrapping is working correctly. It should wrap to the window
// Usage: test [OPTIONS]... ACTION...
//
// Arguments:
// ACTION The name of the action to perform. This is an
// intentionally very long argument description so we can check
// that word wrapping is working correctly
// ACTION The name of the action to perform. This is an intentionally very
// long argument description so we can check that word wrapping is
// working correctly
//
// Options:
// -v verbosity level. -v (errors only), -vv
// (warnings and errors), -vvv (everything).
// -v verbosity level. -v (errors only), -vv (warnings and errors),
// -vvv (everything).
// -P Port to use for all connections.
// -d, --data=VALUE Path to the input JSON data.
//