Skip to content

Commit

Permalink
Update README.md (#143)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* "version": "0.0.38"
  • Loading branch information
tomer-epstein authored Feb 12, 2020
1 parent 2f2b785 commit 26ac052
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 12 deletions.
9 changes: 0 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,22 +65,13 @@ To get more help, support and information please open a github issue.
Contributing information can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

## TODO
* error handling
* promise rejects while performing rpc calls
* ensure callback of `Generator.run()` is called when user aborts during conflict resolution and when exceptions occur.
* support 3 default themes (vscode-black, vscode-white, non-vscode) ( pending Theia 13 adoption)
* provide yeoman generator best practice guide (also provide example)
* use debounce when watching changes to input fields
* cleanup code
* remove redundant css
* implement ability for yeoman-ui to call methods in vscode extensions
* support hook for executing commands after finish
* support open workspace in destination
* support open readme.md file by default (with turn off setting)

* support back
* support start over
* support async functions in generator
* enable configuring destination root
* support custom question rendering: generator set the ui renderer, example: tiles instead of dropdown, radio buttons instead of
* support extensible question type custom user interfaces for complex operations (e.g. choose odata source)
Expand Down
2 changes: 1 addition & 1 deletion backend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "Apache 2.0",
"description": "Provide rich user experience for Yeoman generators using VSCode extension or the browser",
"repository": "https://github.com/SAP/yeoman-ui",
"version": "0.0.37",
"version": "0.0.38",
"engines": {
"vscode": "^1.39.2"
},
Expand Down
16 changes: 14 additions & 2 deletions generator-foodq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,20 @@ If you write your own generator and you want it to render well in Yeoman UI, fol

```js
this.getPrompts = function() {
return [{name:"Prompt 1"},{name: "Prompt 2"},{name: "Registration"}];
return [
{ name: "Prompt 1", description: "Prompt 1 Description" },
{ name: "Prompt 2", description: "Prompt 2 Description" },
{ name: "Registration", description: "Please enter user cresentials" }
];
}
```

* Place a `yeoman.png` file in the same location as your `package.json` file, and Yeoman UI will show it when it shows the user the list of all available generators.
* Update the target folder (your project root path) in the 'writing()' method

```javascript
writing() {
this.destinationRoot(path.join(this.destinationRoot(), _.get(this, "answers.food", "")));
}
```

* Place a `yeoman.png` file in the same location as your `package.json` file, and Yeoman UI will show it when it shows the user the list of all available generators.

0 comments on commit 26ac052

Please sign in to comment.