Skip to content

Commit d518837

Browse files
stevleibeltstevleibelt
committed
moved history into dedicated changelog file
1 parent 5ca53c3 commit d518837

File tree

2 files changed

+114
-44
lines changed

2 files changed

+114
-44
lines changed

‎CHANGELOG.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](http://keepachangelog.com/)
6+
and this project adheres to [Semantic Versioning](http://semver.org/).
7+
8+
## [Open]
9+
10+
### To Add
11+
12+
* add *hasFlags* to easy up validation if long or short flag is set (e.g. '-v|--verbose')
13+
14+
### To Change
15+
16+
* cover Parser with unit tests
17+
* synchronize styling of the release dates
18+
19+
## [Unreleased]
20+
21+
### Added
22+
23+
### To Change
24+
25+
## [1.4.0](https://github.com/bazzline/php_component_cli_argument/tree/1.4.0) - released at 2017-01-29
26+
27+
### Changed
28+
29+
* updated minimum requirements to php 5.6
30+
31+
## [1.3.2](https://github.com/bazzline/php_component_cli_argument/tree/1.3.2) - released at 2016-08-07
32+
33+
### Changed
34+
35+
* updated to phpunit 5.5
36+
37+
## [1.3.1](https://github.com/bazzline/php_component_cli_argument/tree/1.3.1) - released at 2015-06-05
38+
39+
### Added
40+
41+
* added php 7.0 to testing environment
42+
43+
### Changed
44+
45+
* enhanced phpunit compatibility by using "~4.8||~5.4"
46+
* moved to psr-4 autoloading
47+
* removed php 5.3.3 testing environment
48+
* updated to phpunit 5.4
49+
50+
## [1.3.0](https://github.com/bazzline/php_component_cli_argument/tree/1.3.0) - released at 2015-12-01
51+
52+
### Added
53+
54+
* added support for single argument like "a" or "-"
55+
56+
## [1.2.0](https://github.com/bazzline/php_component_cli_argument/tree/1.2.0) - released at 2015-11-28
57+
58+
### Added
59+
60+
* added *convertToArray()'
61+
* added *convertToString()'
62+
* added *getNumberOf[Arguments|Flags|Lists|Values]
63+
64+
### Changed
65+
66+
* removed *generate_api*
67+
* replaced "setArguments" with "parseArguments" like [nette](https://github.com/nette/command-line/blob/master/src/CommandLine/Parser.php) is doing it
68+
* updated dependency handling by being less restrictive (added lower limit for phpunit)
69+
70+
## [1.1.2](https://github.com/bazzline/php_component_cli_argument/tree/1.1.2) - released at 2015-11-07
71+
72+
### Changed
73+
74+
* updated dependencies
75+
76+
## [1.1.1](https://github.com/bazzline/php_component_cli_argument/tree/1.1.1) - released at 2015-08-18
77+
78+
### Changed
79+
80+
* updated dependencies
81+
82+
## [1.1.0](https://github.com/bazzline/php_component_cli_argument/tree/1.1.0) - released at 2015-07-02
83+
84+
### Changed
85+
86+
* added second argument to `Arguments::__construct()` and `Arguments::setArguments` called "removeFirstArgument"
87+
88+
## [1.0.2](https://github.com/bazzline/php_component_cli_argument/tree/1.0.2) - released at 2015-07-02
89+
90+
### Changed
91+
92+
* updated dependencies
93+
94+
## [1.0.1](https://github.com/bazzline/php_component_cli_argument/tree/1.0.1) - released at 2015-05-22
95+
96+
### Changed
97+
98+
* updated dependencies
99+
100+
## [1.0.0](https://github.com/bazzline/php_component_cli_argument/tree/1.0.0) - released at 2015-04-23
101+
102+
### Added
103+
104+
* initial release

‎README.md‎

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,23 @@ The versioneye status is:
1414

1515
Take a look on [openhub.net](https://www.openhub.net/p/php_component_cli_arguments).
1616

17+
The current change log can be found [here](https://github.com/bazzline/php_component_cli_arguments/blob/master/CHANGELOG.md).
18+
1719
# Install
1820

1921
## By Hand
2022

21-
mkdir -p vendor/net_bazzline/php_component_cli_arguments
22-
cd vendor/net_bazzline/php_component_cli_arguments
23-
git clone https://github.com/bazzline/php_component_cli_arguments .
23+
```bash
24+
mkdir -p vendor/net_bazzline/php_component_cli_arguments
25+
cd vendor/net_bazzline/php_component_cli_arguments
26+
git clone https://github.com/bazzline/php_component_cli_arguments .
27+
```
2428

2529
## With [Packagist](https://packagist.org/packages/net_bazzline/php_component_cli_arguments)
2630

27-
composer require net_bazzline/php_component_cli_arguments:dev-master
31+
```bash
32+
composer require net_bazzline/php_component_cli_arguments:dev-master
33+
```
2834

2935
# Benefits
3036

@@ -156,50 +162,10 @@ Since I won't write "never say never", if you have a smart idea or way to easy u
156162
Optional arguments underlying the same problems as validation. It is not that easy to implement in an elegant way. It is very special/domain specific (e.g. an argument is optional if flag "--xyz" is used, otherwise mandatory).
157163
Your code has to take care if an argument is passed or not anyways. Using the available "has..."-methods should be sufficient and generic enough.
158164

159-
160165
# API
161166

162167
[API](http://www.bazzline.net/988fc4501e48d8aed30583f58a97f0d4c14ab2d3/index.html) is available at [bazzline.net](http://www.bazzline.net).
163168

164-
# History
165-
166-
* upcomming
167-
* @todo
168-
* add *hasFlags* to easy up validation if long or short flag is set (e.g. '-v|--verbose')
169-
* cover Parser with unit tests
170-
* synchronize styling of the release dates
171-
* [1.4.0](https://github.com/bazzline/php_component_cli_argument/tree/1.4.0) - released at 2017-01-29
172-
* updated minimum requirements to php 5.6
173-
* [1.3.2](https://github.com/bazzline/php_component_cli_argument/tree/1.3.2) - released at 07.08.2016
174-
* updated to phpunit 5.5
175-
* [1.3.1](https://github.com/bazzline/php_component_cli_argument/tree/1.3.1) - released at 05.06.2015
176-
* added php 7.0 to testing environment
177-
* enhanced phpunit compatibility by using "~4.8||~5.4"
178-
* moved to psr-4 autoloading
179-
* removed php 5.3.3 testing environment
180-
* updated to phpunit 5.4
181-
* [1.3.0](https://github.com/bazzline/php_component_cli_argument/tree/1.3.0) - released at 01.12.2015
182-
* added support for single argument like "a" or "-"
183-
* [1.2.0](https://github.com/bazzline/php_component_cli_argument/tree/1.2.0) - released at 28.11.2015
184-
* added *convertToArray()'
185-
* added *convertToString()'
186-
* added *getNumberOf[Arguments|Flags|Lists|Values]
187-
* removed *generate_api*
188-
* replaced "setArguments" with "parseArguments" like [nette](https://github.com/nette/command-line/blob/master/src/CommandLine/Parser.php) is doing it
189-
* updated dependency handling by being less restrictive (added lower limit for phpunit)
190-
* [1.1.2](https://github.com/bazzline/php_component_cli_argument/tree/1.1.2) - released at 07.11.2015
191-
* updated dependencies
192-
* [1.1.1](https://github.com/bazzline/php_component_cli_argument/tree/1.1.1) - released at 18.08.2015
193-
* updated dependencies
194-
* [1.1.0](https://github.com/bazzline/php_component_cli_argument/tree/1.1.0) - released at 02.07.2015
195-
* added second argument to `Arguments::__construct()` and `Arguments::setArguments` called "removeFirstArgument"
196-
* [1.0.2](https://github.com/bazzline/php_component_cli_argument/tree/1.0.2) - released at 02.07.2015
197-
* updated dependencies
198-
* [1.0.1](https://github.com/bazzline/php_component_cli_argument/tree/1.0.1) - released at 22.05.2015
199-
* updated dependencies
200-
* [1.0.0](https://github.com/bazzline/php_component_cli_argument/tree/1.0.0) - released at 23.04.2015
201-
* initial release
202-
203169
# Other Great Components
204170

205171
* [search on packagist](https://packagist.org/search/?search_query%5Bquery%5D=getopt)

0 commit comments

Comments
 (0)