Skip to content

Commit

Permalink
Robo release 1.4.10
Browse files Browse the repository at this point in the history
  • Loading branch information
greg-1-anderson committed Jul 29, 2019
1 parent abe2f57 commit e5a6ca6
Show file tree
Hide file tree
Showing 8 changed files with 95 additions and 77 deletions.
46 changes: 23 additions & 23 deletions docs/tasks/ApiGen.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,37 +17,37 @@ $this->taskApiGen('./vendor/apigen/apigen.phar')

* `args($args)` Pass methods parameters as arguments to executable. Argument values
* `config($config)` * `param string` $config
* `source($src)` * `param array|string|Traversable` $src one or more source values
* `source($src)` * `param array|string|\Traversable` $src
* `destination($dest)` * `param string` $dest
* `extensions($exts)` * `param array|string` $exts one or more extensions
* `exclude($exclude)` * `param array|string` $exclude one or more exclusions
* `skipDocPath($path)` * `param array|string|Traversable` $path one or more skip-doc-path values
* `skipDocPrefix($prefix)` * `param array|string|Traversable` $prefix one or more skip-doc-prefix values
* `charset($charset)` * `param array|string` $charset one or more charsets
* `extensions($exts)` * `param array|string` $exts
* `exclude($exclude)` * `param array|string` $exclude
* `skipDocPath($path)` * `param array|string|\Traversable` $path
* `skipDocPrefix($prefix)` * `param array|string|\Traversable` $prefix
* `charset($charset)` * `param array|string` $charset
* `mainProjectNamePrefix($name)` * `param string` $name
* `title($title)` * `param string` $title
* `baseUrl($baseUrl)` * `param string` $baseUrl
* `googleCseId($id)` * `param string` $id
* `googleAnalytics($trackingCode)` * `param string` $trackingCode
* `templateConfig($templateConfig)` * `param mixed` $templateConfig
* `allowedHtml($tags)` * `param array|string` $tags one or more supported html tags
* `allowedHtml($tags)` * `param array|string` $tags
* `groups($groups)` * `param string` $groups
* `autocomplete($types)` * `param array|string` $types or more supported autocomplete types
* `accessLevels($levels)` * `param array|string` $levels one or more access levels
* `internal($internal)` * `param boolean|string` $internal 'yes' or true if internal, 'no' or false if not
* `php($php)` * `param boolean|string` $php 'yes' or true to generate documentation for internal php classes,
* `tree($tree)` * `param bool|string` $tree 'yes' or true to generate a tree view of classes, 'no' or false otherwise
* `deprecated($dep)` * `param bool|string` $dep 'yes' or true to generate documentation for deprecated classes, 'no' or false otherwise
* `todo($todo)` * `param bool|string` $todo 'yes' or true to document tasks, 'no' or false otherwise
* `sourceCode($src)` * `param bool|string` $src 'yes' or true to generate highlighted source code, 'no' or false otherwise
* `download($zipped)` * `param bool|string` $zipped 'yes' or true to generate downloadable documentation, 'no' or false otherwise
* `report($path)`
* `wipeout($wipeout)` * `param bool|string` $wipeout 'yes' or true to clear out the destination directory, 'no' or false otherwise
* `quiet($quiet)` * `param bool|string` $quiet 'yes' or true for quiet, 'no' or false otherwise
* `progressbar($bar)` * `param bool|string` $bar 'yes' or true to display a progress bar, 'no' or false otherwise
* `colors($colors)` * `param bool|string` $colors 'yes' or true colorize the output, 'no' or false otherwise
* `updateCheck($check)` * `param bool|string` $check 'yes' or true to check for updates, 'no' or false otherwise
* `debug($debug)` * `param bool|string` $debug 'yes' or true to enable debug mode, 'no' or false otherwise
* `autocomplete($types)` * `param array|string` $types
* `accessLevels($levels)` * `param array|string` $levels
* `internal($internal)` * `param boolean|string` $internal
* `php($php)` * `param bool|string` $php
* `tree($tree)` * `param bool|string` $tree
* `deprecated($dep)` * `param bool|string` $dep
* `todo($todo)` * `param bool|string` $todo
* `sourceCode($src)` * `param bool|string` $src
* `download($zipped)` * `param bool|string` $zipped
* `report($path)` * `param string` $path
* `wipeout($wipeout)` * `param bool|string` $wipeout
* `quiet($quiet)` * `param bool|string` $quiet
* `progressbar($bar)` * `param bool|string` $bar
* `colors($colors)` * `param bool|string` $colors
* `updateCheck($check)` * `param bool|string` $check
* `debug($debug)` * `param bool|string` $debug
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `rawArg($arg)` Pass the provided string in its raw (as provided) form as an argument to executable.
Expand Down
2 changes: 1 addition & 1 deletion docs/tasks/Assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Please install additional dependencies to use:
* `type($type)` Sets type with validation.
* `singleLine($singleLine)` Single line option for the JS minimisation.
* `keepImportantComments($keepImportantComments)` keepImportantComments option for the JS minimisation.
* `specialVarRx($specialVarRx)` specialVarRx option for the JS minimisation.
* `specialVarRx($specialVarRx)` Set specialVarRx option for the JS minimisation.
* `__toString()` @return string

## Scss
Expand Down
18 changes: 18 additions & 0 deletions docs/tasks/Base.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,5 +127,23 @@ $this->taskWatch()
?>
```

Pass through the changed file to the callable function

```
$this
->taskWatch()
->monitor(
'filename',
function ($event) {
$resource = $event->getResource();
... do something with (string)$resource ...
},
FilesystemEvent::ALL
)
->run();
```

The $event parameter is a [standard Symfony file resource object](https://api.symfony.com/3.1/Symfony/Component/Config/Resource/FileResource.html)

* `monitor($paths, $callable, $events = null)` * `param string|string[]` $paths

82 changes: 41 additions & 41 deletions docs/tasks/Composer.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ $this->taskComposerConfig()->set('bin-dir', 'bin/')->run();
?>
```

* `set($key, $value)` Set a configuration value
* `set($key, $value)` Set a configuration value.
* `useGlobal($useGlobal = null)` Operate on the global repository
* `repository($id, $uri, $repoType = null)` * `return` $this
* `removeRepository($id)` * `return` $this
* `disableRepository($id)` * `return` $this
* `enableRepository($id)` * `return` $this
* `repository($id, $uri, $repoType = null)` * `param string` $id
* `removeRepository($id)` * `param string` $id
* `disableRepository($id)` * `param string` $id
* `enableRepository($id)` * `param string` $id
* `preferDist($preferDist = null)` adds `prefer-dist` option to composer
* `preferSource()` adds `prefer-source` option to composer
* `dev($dev = null)` adds `dev` option to composer
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -52,21 +52,21 @@ $this->taskComposerCreateProject()->source('foo/bar')->target('myBar')->run();
?>
```

* `source($source)` * `return` $this
* `target($target)` * `return` $this
* `version($version)` * `return` $this
* `keepVcs($keep = null)`
* `noInstall($noInstall = null)`
* `repository($repository)` * `return` $this
* `stability($stability)` * `return` $this
* `buildCommand()` Copy class fields into command options as directed.
* `source($source)` * `param string` $source
* `target($target)` * `param string` $target
* `version($version)` * `param string` $version
* `keepVcs($keep = null)` * `param bool` $keep
* `noInstall($noInstall = null)` * `param bool` $noInstall
* `repository($repository)` * `param string` $repository
* `stability($stability)` * `param string` $stability
* `buildCommand()` {@inheritdoc}
* `preferDist($preferDist = null)` adds `prefer-dist` option to composer
* `preferSource()` adds `prefer-source` option to composer
* `dev($dev = null)` adds `dev` option to composer
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -109,14 +109,14 @@ $this->taskComposerDumpAutoload('path/to/my/composer.phar')
?>
```

* `optimize($optimize = null)` * `return` $this
* `optimize($optimize = null)` * `param bool` $optimize
* `preferDist($preferDist = null)` adds `prefer-dist` option to composer
* `preferSource()` adds `prefer-source` option to composer
* `dev($dev = null)` adds `dev` option to composer
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -144,22 +144,22 @@ $this->taskComposerInit()->run();
?>
```

* `projectName($projectName)` * `return` $this
* `description($description)` * `return` $this
* `author($author)` * `return` $this
* `projectType($type)` * `return` $this
* `homepage($homepage)` * `return` $this
* `projectName($projectName)` * `param string` $projectName
* `description($description)` * `param string` $description
* `author($author)` * `param string` $author
* `projectType($type)` * `param string` $type
* `homepage($homepage)` * `param string` $homepage
* `dependency($project, $version = null)` 'require' is a keyword, so it cannot be a method name.
* `stability($stability)` * `return` $this
* `license($license)` * `return` $this
* `repository($repository)` * `return` $this
* `stability($stability)` * `param string` $stability
* `license($license)` * `param string` $license
* `repository($repository)` * `param string` $repository
* `preferDist($preferDist = null)` adds `prefer-dist` option to composer
* `preferSource()` adds `prefer-source` option to composer
* `dev($dev = null)` adds `dev` option to composer
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -203,7 +203,7 @@ $this->taskComposerInstall('path/to/my/composer.phar')
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -231,17 +231,17 @@ $this->taskComposerRemove()->run();
?>
```

* `dev($dev = null)` * `return` $this
* `noProgress($noProgress = null)` * `return` $this
* `noUpdate($noUpdate = null)` * `return` $this
* `updateNoDev($updateNoDev = null)` * `return` $this
* `noUpdateWithDependencies($updateWithDependencies = null)` * `return` $this
* `dev($dev = null)` * `param bool` $dev
* `noProgress($noProgress = null)` * `param bool` $noProgress
* `noUpdate($noUpdate = null)` * `param bool` $noUpdate
* `updateNoDev($updateNoDev = null)` * `param bool` $updateNoDev
* `noUpdateWithDependencies($updateWithDependencies = null)` * `param bool` $updateWithDependencies
* `preferDist($preferDist = null)` adds `prefer-dist` option to composer
* `preferSource()` adds `prefer-source` option to composer
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -276,7 +276,7 @@ $this->taskComposerRequire()->dependency('foo/bar', '^.2.4.8')->run();
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -320,7 +320,7 @@ $this->taskComposerUpdate('path/to/my/composer.phar')
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down Expand Up @@ -348,18 +348,18 @@ $this->taskComposerValidate()->run();
?>
```

* `noCheckAll($noCheckAll = null)` * `return` $this
* `noCheckLock($noCheckLock = null)` * `return` $this
* `noCheckPublish($noCheckPublish = null)` * `return` $this
* `withDependencies($withDependencies = null)` * `return` $this
* `strict($strict = null)` * `return` $this
* `noCheckAll($noCheckAll = null)` * `param bool` $noCheckAll
* `noCheckLock($noCheckLock = null)` * `param bool` $noCheckLock
* `noCheckPublish($noCheckPublish = null)` * `param bool` $noCheckPublish
* `withDependencies($withDependencies = null)` * `param bool` $withDependencies
* `strict($strict = null)` * `param bool` $strict
* `preferDist($preferDist = null)` adds `prefer-dist` option to composer
* `preferSource()` adds `prefer-source` option to composer
* `dev($dev = null)` adds `dev` option to composer
* `noDev()` adds `no-dev` option to composer
* `ansi($ansi = null)` adds `ansi` option to composer
* `noAnsi()` adds `no-ansi` option to composer
* `interaction($interaction = null)`
* `interaction($interaction = null)` * `param bool` $interaction
* `noInteraction()` adds `no-interaction` option to composer
* `optimizeAutoloader($optimize = null)` adds `optimize-autoloader` option to composer
* `ignorePlatformRequirements($ignore = null)` adds `ignore-platform-reqs` option to composer
Expand Down
8 changes: 4 additions & 4 deletions docs/tasks/Development.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ $this->taskChangelog()
* `changes(array $data)` * `param array` $data
* `change($change)` * `param string` $change
* `getChanges()` @return array
* `processLogRow($i)` * `param` $i
* `processLogRow($i)` * `param string` $i

## GenerateMarkdownDoc

Expand Down Expand Up @@ -137,8 +137,8 @@ $this->taskGitHubRelease('0.1.0')
* `owner($owner)` * `param string` $owner
* `uri($uri)` * `param string` $uri
* `user($user)` * `param string` $user
* `password($password)` * `param` $password
* `accessToken($token)` * `param` $accessToken
* `password($password)` * `param string` $password
* `accessToken($token)` * `param string` $token

## OpenBrowser

Expand Down Expand Up @@ -251,7 +251,7 @@ $this->taskSemVer('.semver')


* `__toString()` @return string
* `version($version)`
* `version($version)` * `param string` $version
* `setFormat($format)` * `param string` $format
* `setMetadataSeparator($separator)` * `param string` $separator
* `setPrereleaseSeparator($separator)` * `param string` $separator
Expand Down
2 changes: 1 addition & 1 deletion docs/tasks/Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ $task->dockerCommit($result)
->run();
```

* `name($name)` * `param` $name
* `name($name)` * `param string` $name
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down
12 changes: 6 additions & 6 deletions docs/tasks/Testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ $this->taskBehat()

* `stopOnFail()` * `return` $this
* `noInteraction()` * `return` $this
* `config($config_file)` * `param` $config_file
* `config($config_file)` * `param string` $config_file
* `colors()` * `return` $this
* `noColors()` * `return` $this
* `suite($suite)` * `param string` $suite
Expand Down Expand Up @@ -156,11 +156,11 @@ $this->taskPhpspec()
* `stopOnFail()`
* `noCodeGeneration()`
* `quiet()`
* `verbose($level = null)`
* `noAnsi()`
* `noInteraction()`
* `config($config_file)`
* `format($formater)`
* `verbose($level = null)` * `param string` $level
* `noAnsi()` * `return` $this
* `noInteraction()` * `return` $this
* `config($config_file)` * `param string` $config_file
* `format($formater)` * `param string` $formater
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down
2 changes: 1 addition & 1 deletion src/Robo.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
class Robo
{
const APPLICATION_NAME = 'Robo';
const VERSION = '1.4.10-dev';
const VERSION = '1.4.10';

/**
* The currently active container object, or NULL if not initialized yet.
Expand Down

0 comments on commit e5a6ca6

Please sign in to comment.