Skip to content
This repository was archived by the owner on Feb 8, 2019. It is now read-only.

Commit 941f03f

Browse files
committed
chore(): generated Readme.md
1 parent e91c85b commit 941f03f

File tree

1 file changed

+52
-28
lines changed

1 file changed

+52
-28
lines changed

README.md

+52-28
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ So, you can use all your favorites tools keeping it under control and versioned.
3737
# Main Index:
3838

3939
- [Plugins](#plugins)
40-
- from **piscosour v.0.6.8**
40+
- from **piscosour v.0.6.11**
4141
- [context](#context)
4242
- [fsutils](#fsutils)
4343
- [inquirer](#inquirer)
@@ -52,7 +52,7 @@ So, you can use all your favorites tools keeping it under control and versioned.
5252
- [Contexts](#contexts)
5353
- [Recipes](#recipes)
5454
- [All Commands Availables](#all-commands-availables)
55-
- from **piscosour v.0.6.8**
55+
- from **piscosour v.0.6.11**
5656
- [node-module:convert (Convert any module into a piscosour recipe)](#node-moduleconvert-convert-any-module-into-a-piscosour-recipe)
5757
- [recipe:add-shot (Add a shot to a piscosour recipe)](#recipeadd-shot-add-a-shot-to-a-piscosour-recipe)
5858
- [recipe:add-straw (Add a straw to a piscosour recipe)](#recipeadd-straw-add-a-straw-to-a-piscosour-recipe)
@@ -88,7 +88,7 @@ General info:
8888

8989
```
9090
Contexts: node-module
91-
From: piscosour (0.6.8)
91+
From: piscosour (0.6.11)
9292
```
9393
shot convert
9494

@@ -107,7 +107,7 @@ General info:
107107

108108
```
109109
Contexts: recipe
110-
From: piscosour (0.6.8)
110+
From: piscosour (0.6.11)
111111
```
112112
shot shots
113113

@@ -126,7 +126,7 @@ General info:
126126

127127
```
128128
Contexts: recipe
129-
From: piscosour (0.6.8)
129+
From: piscosour (0.6.11)
130130
```
131131
shot straws
132132

@@ -145,7 +145,7 @@ General info:
145145

146146
```
147147
Contexts: recipe
148-
From: piscosour (0.6.8)
148+
From: piscosour (0.6.11)
149149
```
150150
shot piscosour
151151

@@ -177,7 +177,7 @@ General info:
177177

178178
```
179179
Contexts: recipe
180-
From: piscosour (0.6.8)
180+
From: piscosour (0.6.11)
181181
```
182182
shot scaffolding
183183

@@ -204,7 +204,7 @@ General info:
204204

205205
```
206206
Contexts: recipe
207-
From: piscosour (0.6.8)
207+
From: piscosour (0.6.11)
208208
```
209209
shot generate-docs
210210

@@ -220,7 +220,7 @@ General info:
220220

221221
```
222222
Contexts: all
223-
From: piscosour (0.6.8)
223+
From: piscosour (0.6.11)
224224
```
225225
shot npm
226226

@@ -236,7 +236,7 @@ General info:
236236

237237
```
238238
Contexts: node-module
239-
From: piscosour (0.6.8)
239+
From: piscosour (0.6.11)
240240
```
241241
shot convert
242242

@@ -252,7 +252,7 @@ General info:
252252

253253
```
254254
Contexts: recipe
255-
From: piscosour (0.6.8)
255+
From: piscosour (0.6.11)
256256
```
257257
shot shots
258258

@@ -268,7 +268,7 @@ General info:
268268

269269
```
270270
Contexts: recipe
271-
From: piscosour (0.6.8)
271+
From: piscosour (0.6.11)
272272
```
273273
shot straws
274274

@@ -284,7 +284,7 @@ General info:
284284

285285
```
286286
Contexts: recipe
287-
From: piscosour (0.6.8)
287+
From: piscosour (0.6.11)
288288
```
289289
shot piscosour
290290

@@ -300,7 +300,7 @@ General info:
300300

301301
```
302302
Contexts: recipe
303-
From: piscosour (0.6.8)
303+
From: piscosour (0.6.11)
304304
```
305305
shot generate-docs
306306

@@ -316,7 +316,7 @@ General info:
316316

317317
```
318318
Contexts: recipe
319-
From: piscosour (0.6.8)
319+
From: piscosour (0.6.11)
320320
```
321321
shot scaffolding
322322

@@ -332,7 +332,7 @@ General info:
332332

333333
```
334334
Contexts: recipe
335-
From: piscosour (0.6.8)
335+
From: piscosour (0.6.11)
336336
```
337337
### Update version of recipe
338338

@@ -343,7 +343,7 @@ This shot execute npm install -g **recipeName**. recipeName has to be in params.
343343

344344

345345
## context
346-
from: **piscosour (0.6.8)** [Go Index](#main-index)
346+
from: **piscosour (0.6.11)** [Go Index](#main-index)
347347

348348
### Context for the pisco execution
349349

@@ -450,7 +450,7 @@ let repos = this.ctxWhoami();
450450

451451
repos is an Array of types that match the place where your recipe was executed.
452452
## fsutils
453-
from: **piscosour (0.6.8)** [Go Index](#main-index)
453+
from: **piscosour (0.6.11)** [Go Index](#main-index)
454454

455455
### fs plugin (fs addons for piscosour)
456456

@@ -497,19 +497,43 @@ from: **piscosour (0.6.8)** [Go Index](#main-index)
497497
| | |
498498

499499
## inquirer
500-
from: **piscosour (0.6.8)** [Go Index](#main-index)
500+
from: **piscosour (0.6.11)** [Go Index](#main-index)
501501

502502
### Inquirer plugin
503503

504504
This plugin use inquirer library [Inquirer documentation](https://www.npmjs.com/package/inquirer)
505505

506+
set type
507+
508+
params.json
509+
```
510+
"prompts": [
511+
{
512+
"type": "#setType()",
513+
"name": "doDefault",
514+
"required": true,
515+
"message": "Do you want to set default repository type?"
516+
}
517+
],
518+
```
519+
520+
- '#' indicate that is necesary to use a function in the shot in order to resolve the type value.
521+
- '()' set that pisco needs to execute this function on order to get the value.
522+
523+
shot.js
524+
```
525+
setType: function() {
526+
return 'confirm';
527+
},
528+
```
529+
506530
#### this.inquire
507531

508532
| Param | Description |
509533
| --- | --- |
510534
| | |
511535
## launcher
512-
from: **piscosour (0.6.8)** [Go Index](#main-index)
536+
from: **piscosour (0.6.11)** [Go Index](#main-index)
513537

514538
### Execute any command with pisco.
515539

@@ -555,7 +579,7 @@ Syncronous method use to execute any command in your environment.
555579
| --- | --- |
556580
| | |
557581
## os
558-
from: **piscosour (0.6.8)** [Go Index](#main-index)
582+
from: **piscosour (0.6.11)** [Go Index](#main-index)
559583

560584

561585
Plugins used to check Operating System where pisco is running
@@ -570,7 +594,7 @@ return true if the Operation System where pisco is executed is Windows.
570594

571595
return true if the Operation System where pisco is executed is MacOS.
572596
## piscosour
573-
from: **piscosour (0.6.8)** [Go Index](#main-index)
597+
from: **piscosour (0.6.11)** [Go Index](#main-index)
574598

575599
### Expose piscosour config
576600

@@ -590,14 +614,14 @@ return the literal: 'package.json'
590614

591615

592616
## skipper
593-
from: **piscosour (0.6.8)** [Go Index](#main-index)
617+
from: **piscosour (0.6.11)** [Go Index](#main-index)
594618

595619
### Skipper plugin
596620

597621
Skips the shot execution when receiving the param "\_skip": true
598622

599623
## stream-write-hook
600-
from: **piscosour (0.6.8)** [Go Index](#main-index)
624+
from: **piscosour (0.6.11)** [Go Index](#main-index)
601625

602626
### Intercepts any stream flow in order to be able to manage the information inside.
603627

@@ -648,7 +672,7 @@ stops the hook
648672

649673

650674
## system-checker
651-
from: **piscosour (0.6.8)** [Go Index](#main-index)
675+
from: **piscosour (0.6.11)** [Go Index](#main-index)
652676

653677
### How to check system requirements of a piscosour command.
654678

@@ -796,7 +820,7 @@ this is the result of the execution for every shot that would have system requir
796820

797821
If any system requirement is not satisfied the command will throw an error and stops...
798822
## system-saver
799-
from: **piscosour (0.6.8)** [Go Index](#main-index)
823+
from: **piscosour (0.6.11)** [Go Index](#main-index)
800824

801825
### Write the requirements into a global file 'requirements.json'
802826

@@ -838,7 +862,7 @@ this is the file resulting of the execution: the mix of all system requirements
838862
}
839863
```
840864
## test
841-
from: **piscosour (0.6.8)** [Go Index](#main-index)
865+
from: **piscosour (0.6.11)** [Go Index](#main-index)
842866

843867
Testing plugin. NO FUNCTIONALITY.
844868
# Contexts
@@ -860,6 +884,6 @@ Testing plugin. NO FUNCTIONALITY.
860884

861885
|Name|Version|Description|
862886
|---|---|---|
863-
|piscosour|0.6.8|Get all your devops tools wrapped-up!|
887+
|piscosour|0.6.11|Get all your devops tools wrapped-up!|
864888

865889

0 commit comments

Comments
 (0)