Changelog History
Page 2
-
v4.0.0 Changes
January 03, 2015Why Skip 3.0?
๐ Version
3.0
was skipped, because master branch had3.0-dev
alias with code
base similar to 2.8. Since then there were many BC breaks, thus major version was bumped to4.0
.
๐ This release closes refactoring of version 2.8. Its aim was to improve code base, provide fairly high code coverage (from 0 % in 2.8) to improve further development and close old pull-requests. Now it's at 84 %, which really makes changes easier.
Saying that, next version will focus on:
- ๐ new features based on issues/PR from you , end users.
- website management
- ๐ฆ package decoupling
- ๐ documentation
๐ Changes
- [#492] use "dash" type (BC for 2.8)
- ๐ [#493] support for various CLI option input format
- 0๏ธโฃ 8bf2325
php
is now off by default, turn it on by--php
- ๐ 0cc7640 Kdyby\Console removed
- 91d5e6b
autocomplete
option dropped - to much detailed was use-non-friendly - โก๏ธ c749343 self-update command now uses https://github.com/herrera-io/php-phar-update
๐ Bugfixes
- ๐ [#490] reading options from apigen.neon fixed
- ๐ [#434] PHAR installation simplified and fixed for cross platform
- ๐ [#465] relative path on Windows fixed
- ๐ฆ [#375] constant version returned, so now it's available in composer installed packages as well
Full diff: v4.0.0-RC5...v4.0.0
โฌ๏ธ How to Upgrade
0๏ธโฃ Default command
generate
added:Before:
apigen -s source -d destination
After:
apigen generate -s source -d destination
๐ New command
self-update
added, to upgrade.phar
file.Before:
โก๏ธ manual update
After:
โก๏ธ
apigen self-update
Bool options for arguments passed via CLI are off when absent, on when
present.Before:
... --tree yes # tree => true
... --tree no # tree => false
After:
... --tree # tree => true
... # tree => false
Options with values for arguments passed via CLI now accept multiple formats:
Before:
... --access-levels public --access-levels protected
After:
... --access-levels public,protected
or
... --access-levels="public,protected"
or
... --access-levels public --access-levels protected
๐ Some CLI options were dropped. To see what the available ones are, just run
apigen generate --help
.--skip-doc-prefix
was dropped, use--skip-doc-path
instead--allowed-html
was dropped--autocomplete
was dropped; autocomplete now works for classes, constants and functions by default--report
; use Php_CodeSniffer for any custom checkstyle--wipeout
; now wipes out everytime--progressbar
; now always present--colors
; now always colors
-
--update-check
; update manually byapigen self-update
(new version is released every ~ 2 months)Some CLI options were renamed and reversed.
--source-code
was off by default, now it on by default; to turn it off, add--no-source-code