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

   1 # Change Log
   2
   3 ### 2.8.3 - 23 Feb 2018
   4
   5 - BUGFIX: Do not shift off the command name unless it is there. (#139)
   6 - Use test scenarios to test multiple versions of Symfony. (#136, #137)
   7
   8 ### 2.8.2 - 29 Nov 2017
   9
  10 - Allow Symfony 4 components.
  11
  12 ### 2.8.1 - 16 Oct 2017
  13
  14 - Add hook methods to allow Symfony command events to be added directly to the hook manager, givig better control of hook order. (#131)
  15
  16 ### 2.8.0 - 13 Oct 2017
  17
  18 - Remove phpdocumentor/reflection-docblock in favor of using a bespoke parser (#130)
  19
  20 ### 2.7.0 - 18 Sept 2017
  21
  22 - Add support for options with a default value of 'true' (#119)
  23 - BUGFIX: Improve handling of options with optional values, which previously was not working correctly. (#118)
  24
  25 ### 2.6.1 - 18 Sep 2017
  26
  27 - Reverts to contents of the 2.4.13 release.
  28
  29 ### 2.5.0 & 2.5.1 - 17 Sep 2017
  30
  31 - BACKED OUT. These releases accidentally introduced breaking changes.
  32
  33 ### 2.4.13 - 28 Aug 2017
  34
  35 - Add a followLinks() method (#108)
  36
  37 ### 2.4.12 - 24 Aug 2017
  38
  39 - BUGFIX: Allow annotated commands to directly use InputInterface and OutputInterface (#106)
  40
  41 ### 2.4.11 - 27 July 2017
  42
  43 - Back out #102: do not change behavior of word wrap based on STDOUT redirection.
  44
  45 ### 2.4.10 - 21 July 2017
  46
  47 - Add a method CommandProcessor::setPassExceptions() to allow applicationsto prevent the command processor from catching exceptions thrown by command methods and hooks. (#103)
  48
  49 ### 2.4.9 - 20 Jul 2017
  50
  51 - Automatically disable wordwrap when the terminal is not connected to STDOUT (#102)
  52
  53 ### 2.4.8 - 3 Apr 2017
  54
  55 - 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.
  56 - Unprotect two methods for benefit of Drush help. (#99)
  57 - BUGFIX: Remove symfony/console pin (#100)
  58
  59 ### 2.4.7 & 2.4.6 - 17 Mar 2017
  60
  61 - Avoid wrapping help text (#93)
  62 - Pin symfony/console to version < 3.2.5 (#94)
  63 - Add getExampleUsages() to AnnotatedCommand. (#92)
  64
  65 ### 2.4.5 - 28 Feb 2017
  66
  67 - Ensure that placeholder entries are written into the commandfile cache. (#86)
  68
  69 ### 2.4.4 - 27 Feb 2017
  70
  71 - BUGFIX: Avoid rewriting the command cache unless something has changed.
  72 - BUGFIX: Ensure that the default value of options are correctly cached.
  73
  74 ### 2.4.2 - 24 Feb 2017
  75
  76 - Add SimpleCacheInterface as a documentation interface (not enforced).
  77
  78 ### 2.4.1 - 20 Feb 2017
  79
  80 - Support array options: multiple options on the commandline may be passed in to options array as an array of values.
  81 - Add php 7.1 to the test matrix.
  82
  83 ### 2.4.0 - 3 Feb 2017
  84
  85 - Automatically rebuild cached commandfile data when commandfile changes.
  86 - Provide path to command file in AnnotationData objects.
  87 - Bugfix: Add dynamic options when user runs '--help my:command' (previously, only 'help my:command' worked).
  88 - Bugfix: Include description of last parameter in help (was omitted if no options present)
  89 - Add Windows testing with Appveyor
  90
  91
  92 ### 2.3.0 - 19 Jan 2017
  93
  94 - Add a command info cache to improve performance of applications with many commands
  95 - Bugfix: Allow trailing backslashes in namespaces in CommandFileDiscovery
  96 - Bugfix: Rename @topic to @topics
  97
  98
  99 ### 2.2.0 - 23 November 2016
 100
 101 - Support custom events
 102 - Add xml and json output for replacement help command. Text / html format for replacement help command not available yet.
 103
 104
 105 ### 2.1.0 - 14 November 2016
 106
 107 - Add support for output formatter wordwrapping
 108 - Fix version requirement for output-formatters in composer.json
 109 - Use output-formatters ~3
 110 - Move php_codesniffer back to require-dev (moved to require by mistake)
 111
 112
 113 ### 2.0.0 - 30 September 2016
 114
 115 - **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.
 116 - **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.
 117 - **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).
 118 - 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.
 119 - @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.
 120 - @option annotations can now be either `@option type $name description`, or just `@option name description`.
 121 - `@hook option` can be used to programatically add options to a command.
 122 - 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.
 123 - 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.
 124 - If a --field option is given, it will also force the output format to 'string'.
 125 - Setter methods more consistently return $this.
 126 - Removed PassThroughArgsInput. This class was unnecessary.
 127
 128
 129 ### 1.4.0 - 13 September 2016
 130
 131 - Add basic annotation hook capability, to allow hook functions to be attached to commands with arbitrary annotations.
 132
 133
 134 ### 1.3.0 - 8 September 2016
 135
 136 - 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.
 137
 138
 139 ### 1.2.0 - 2 August 2016
 140
 141 - Support both the 2.x and 3.x versions of phpdocumentor/reflection-docblock.
 142 - Support php 5.4.
 143 - **Bug** Do not allow an @param docblock comment for the options to override the meaning of the options.
 144
 145
 146 ### 1.1.0 - 6 July 2016
 147
 148 - Introduce AnnotatedCommandFactory::createSelectedCommandsFromClassInfo() method.
 149
 150
 151 ### 1.0.0 - 20 May 2016
 152
 153 - First stable release.