|
1 |
| -# Pluggable Widgets Generator |
| 1 | +# Mendix Pluggable Widgets Generator |
2 | 2 |
|
3 | 3 | 
|
4 | 4 | 
|
|
7 | 7 | 
|
8 | 8 | 
|
9 | 9 |
|
10 |
| -> [Yeoman](http://yeoman.io) generator for Mendix Pluggable Widgets. |
11 |
| -
|
12 | 10 | ## About
|
13 | 11 |
|
14 |
| -This generator uses the Yeoman scaffolding tool to let you quickly create a [Mendix Pluggable Widget](https://docs.mendix.com/howto/extensibility/pluggable-widgets). |
| 12 | +The Mendix Pluggable Widget Generator is a scaffolding tool to let you quickly create a [Mendix Pluggable Widget](https://docs.mendix.com/howto/extensibility/pluggable-widgets). |
15 | 13 |
|
16 | 14 | ## Installation
|
17 | 15 |
|
18 |
| -1. Install [node.js](https://nodejs.org/) (version >= 12). |
19 |
| -1. Install [Yeoman](http://yeoman.io): |
20 |
| - |
21 |
| - ```bash |
22 |
| - npm install -g yo |
23 |
| - ``` |
24 |
| - |
25 |
| -1. Install Pluggable Widgets Generator: |
26 |
| - |
27 |
| - ```bash |
28 |
| - npm install -g @mendix/generator-widget |
29 |
| - ``` |
| 16 | +1. Install [node.js](https://nodejs.org/) (version >= 16). |
30 | 17 |
|
31 | 18 | ## Scaffold a widget project
|
32 | 19 |
|
33 | 20 | 1. Generate your new project inside an empty folder:
|
34 | 21 |
|
35 | 22 | ```bash
|
36 |
| - yo @mendix/widget |
| 23 | + npx @mendix/generator-widget |
37 | 24 | ```
|
38 | 25 |
|
39 | 26 | or automatically create the folder using:
|
40 | 27 |
|
41 | 28 | ```bash
|
42 |
| - yo @mendix/widget MyWidgetName |
| 29 | + npx @mendix/generator-widget MyWidgetName |
43 | 30 | ```
|
44 | 31 |
|
45 | 32 | Note that `MyWidgetName` can consist of space characters as well.
|
@@ -113,10 +100,6 @@ npm run release
|
113 | 100 | npm start
|
114 | 101 | ```
|
115 | 102 |
|
116 |
| -- If you are running the generator through multiple operating systems (e.g. running a virtualized OS with Parallels on MacOS or any other virtualization software), make sure you have the right privileges and use the same OS for generation and file manipulation. |
117 |
| - |
118 |
| -- If you want to test locally your changes to the Generator Widget, simply link the package running `npm link` inside the `packages/generator-widget/` folder and then you will be able to run `yo widget SomeWidgetName` |
119 |
| - |
120 | 103 | ## Issues
|
121 | 104 |
|
122 | 105 | Issues can be reported on [Github](https://github.com/mendix/widgets-tools/issues).
|
0 commit comments