www.aleph1.co.uk Git - yaffs-website/blob - vendor/consolidation/annotated-command/CHANGELOG.md

   1 # Change Log
   2
   3 ### 2.9.0 & 2.9.1 - 19 Sept 2018
   4
   5 - Improve commandfile discovery for extensions installed via Composer. (#156)
   6
   7 ### 2.8.5 - 18 Aug 2018
   8
   9 - Add dependencies.yml for dependencies.io
  10 - Fix warning in AnnotatedCommandFactory when getCommandInfoListFromCache called with null.
  11
  12 ### 2.8.4 - 25 May 2018
  13
  14 - Use g1a/composer-test-scenarios for better PHP version matrix testing.
  15
  16 ### 2.8.3 - 23 Feb 2018
  17
  18 - BUGFIX: Do not shift off the command name unless it is there. (#139)
  19 - Use test scenarios to test multiple versions of Symfony. (#136, #137)
  20
  21 ### 2.8.2 - 29 Nov 2017
  22
  23 - Allow Symfony 4 components.
  24
  25 ### 2.8.1 - 16 Oct 2017
  26
  27 - Add hook methods to allow Symfony command events to be added directly to the hook manager, givig better control of hook order. (#131)
  28
  29 ### 2.8.0 - 13 Oct 2017
  30
  31 - Remove phpdocumentor/reflection-docblock in favor of using a bespoke parser (#130)
  32
  33 ### 2.7.0 - 18 Sept 2017
  34
  35 - Add support for options with a default value of 'true' (#119)
  36 - BUGFIX: Improve handling of options with optional values, which previously was not working correctly. (#118)
  37
  38 ### 2.6.1 - 18 Sep 2017
  39
  40 - Reverts to contents of the 2.4.13 release.
  41
  42 ### 2.5.0 & 2.5.1 - 17 Sep 2017
  43
  44 - BACKED OUT. These releases accidentally introduced breaking changes.
  45
  46 ### 2.4.13 - 28 Aug 2017
  47
  48 - Add a followLinks() method (#108)
  49
  50 ### 2.4.12 - 24 Aug 2017
  51
  52 - BUGFIX: Allow annotated commands to directly use InputInterface and OutputInterface (#106)
  53
  54 ### 2.4.11 - 27 July 2017
  55
  56 - Back out #102: do not change behavior of word wrap based on STDOUT redirection.
  57
  58 ### 2.4.10 - 21 July 2017
  59
  60 - Add a method CommandProcessor::setPassExceptions() to allow applicationsto prevent the command processor from catching exceptions thrown by command methods and hooks. (#103)
  61
  62 ### 2.4.9 - 20 Jul 2017
  63
  64 - Automatically disable wordwrap when the terminal is not connected to STDOUT (#102)
  65
  66 ### 2.4.8 - 3 Apr 2017
  67
  68 - Allow multiple annotations with the same key. These are returned as a csv, or, alternately, can be accessed as an array via the new accessor.
  69 - Unprotect two methods for benefit of Drush help. (#99)
  70 - BUGFIX: Remove symfony/console pin (#100)
  71
  72 ### 2.4.7 & 2.4.6 - 17 Mar 2017
  73
  74 - Avoid wrapping help text (#93)
  75 - Pin symfony/console to version < 3.2.5 (#94)
  76 - Add getExampleUsages() to AnnotatedCommand. (#92)
  77
  78 ### 2.4.5 - 28 Feb 2017
  79
  80 - Ensure that placeholder entries are written into the commandfile cache. (#86)
  81
  82 ### 2.4.4 - 27 Feb 2017
  83
  84 - BUGFIX: Avoid rewriting the command cache unless something has changed.
  85 - BUGFIX: Ensure that the default value of options are correctly cached.
  86
  87 ### 2.4.2 - 24 Feb 2017
  88
  89 - Add SimpleCacheInterface as a documentation interface (not enforced).
  90
  91 ### 2.4.1 - 20 Feb 2017
  92
  93 - Support array options: multiple options on the commandline may be passed in to options array as an array of values.
  94 - Add php 7.1 to the test matrix.
  95
  96 ### 2.4.0 - 3 Feb 2017
  97
  98 - Automatically rebuild cached commandfile data when commandfile changes.
  99 - Provide path to command file in AnnotationData objects.
 100 - Bugfix: Add dynamic options when user runs '--help my:command' (previously, only 'help my:command' worked).
 101 - Bugfix: Include description of last parameter in help (was omitted if no options present)
 102 - Add Windows testing with Appveyor
 103
 104
 105 ### 2.3.0 - 19 Jan 2017
 106
 107 - Add a command info cache to improve performance of applications with many commands
 108 - Bugfix: Allow trailing backslashes in namespaces in CommandFileDiscovery
 109 - Bugfix: Rename @topic to @topics
 110
 111
 112 ### 2.2.0 - 23 November 2016
 113
 114 - Support custom events
 115 - Add xml and json output for replacement help command. Text / html format for replacement help command not available yet.
 116
 117
 118 ### 2.1.0 - 14 November 2016
 119
 120 - Add support for output formatter wordwrapping
 121 - Fix version requirement for output-formatters in composer.json
 122 - Use output-formatters ~3
 123 - Move php_codesniffer back to require-dev (moved to require by mistake)
 124
 125
 126 ### 2.0.0 - 30 September 2016
 127
 128 - **Breaking** Hooks with no command name now apply to all commands defined in the same class. This is a change of behavior from the 1.x branch, where hooks with no command name applied to a command with the same method name in a *different* class.
 129 - **Breaking** The interfaces ValidatorInterface, ProcessResultInterface and AlterResultInterface have been updated to be passed a CommandData object, which contains an Input and Output object, plus the AnnotationData.
 130 - **Breaking** The Symfony Command Event hook has been renamed to COMMAND_EVENT.  There is a new COMMAND hook that behaves like the existing Drush command hook (i.e. the post-command event is called after the primary command method runs).
 131 - Add an accessor function AnnotatedCommandFactory::setIncludeAllPublicMethods() to control whether all public methods of a command class, or only those with a @command annotation will be treated as commands. Default remains to treat all public methods as commands. The parameters to AnnotatedCommandFactory::createCommandsFromClass() and AnnotatedCommandFactory::createCommandsFromClassInfo() still behave the same way, but are deprecated. If omitted, the value set by the accessor will be used.
 132 - @option and @usage annotations provided with @hook methods will be added to the help text of the command they hook.  This should be done if a hook needs to add a new option, e.g. to control the behavior of the hook.
 133 - @option annotations can now be either `@option type $name description`, or just `@option name description`.
 134 - `@hook option` can be used to programatically add options to a command.
 135 - A CommandInfoAltererInterface can be added via AnnotatedCommandFactory::addCommandInfoAlterer(); it will be given the opportunity to adjust every CommandInfo object parsed from a command file prior to the creation of commands.
 136 - AnnotatedCommandFactory::setIncludeAllPublicMethods(false) may be used to require methods to be annotated with @commnad in order to be considered commands. This is in preference to the existing parameters of various command-creation methods of AnnotatedCommandFactory, which are now all deprecated in favor of this setter function.
 137 - If a --field option is given, it will also force the output format to 'string'.
 138 - Setter methods more consistently return $this.
 139 - Removed PassThroughArgsInput. This class was unnecessary.
 140
 141
 142 ### 1.4.0 - 13 September 2016
 143
 144 - Add basic annotation hook capability, to allow hook functions to be attached to commands with arbitrary annotations.
 145
 146
 147 ### 1.3.0 - 8 September 2016
 148
 149 - Add ComandFileDiscovery::setSearchDepth(). The search depth applies to each search location, unless there are no search locations, in which case it applies to the base directory.
 150
 151
 152 ### 1.2.0 - 2 August 2016
 153
 154 - Support both the 2.x and 3.x versions of phpdocumentor/reflection-docblock.
 155 - Support php 5.4.
 156 - **Bug** Do not allow an @param docblock comment for the options to override the meaning of the options.
 157
 158
 159 ### 1.1.0 - 6 July 2016
 160
 161 - Introduce AnnotatedCommandFactory::createSelectedCommandsFromClassInfo() method.
 162
 163
 164 ### 1.0.0 - 20 May 2016
 165
 166 - First stable release.