1 | # Yo Code - Extension and Customization Generator
|
2 |
|
3 | [![Build Status](https://dev.azure.com/ms/vscode-generator-code/_apis/build/status/Microsoft.vscode-generator-code)](https://dev.azure.com/ms/vscode-generator-code/_build/latest?definitionId=17)
|
4 |
|
5 | We have written a Yeoman generator to help get you started. We plan to add templates for most extension/customization types into this.
|
6 |
|
7 | ## Install the Generator
|
8 |
|
9 | Install Yeoman and the VS Code Extension generator:
|
10 |
|
11 | ```bash
|
12 | npm install -g yo generator-code
|
13 | ```
|
14 |
|
15 | ## Run Yo Code
|
16 | The Yeoman generator will walk you through the steps required to create your customization or extension prompting for the required information.
|
17 |
|
18 | To launch the generator simply type:
|
19 |
|
20 | ```bash
|
21 | yo code
|
22 | ```
|
23 |
|
24 | ![The command generator](yocode.png)
|
25 |
|
26 | ## Generator Output
|
27 |
|
28 | These templates will
|
29 | * Create a base folder structure
|
30 | * Template out a rough `package.json`
|
31 | * Import any assets required for your extension e.g. tmBundles or the VS Code Library
|
32 | * For Extensions: Set-up `launch.json` for running your extension and attaching to a process
|
33 |
|
34 | ## Run Generator using Docker
|
35 | If you don't want to install nodejs or any node packages, use this method to containerize the generator. \
|
36 | \
|
37 | Go into your project directory
|
38 | ```bash
|
39 | cd <project directory>
|
40 | ```
|
41 | Build the docker image from the docker file
|
42 | ```bash
|
43 | docker build -t vscode-generator-code .
|
44 | ```
|
45 | Create a docker container with volumes
|
46 | ```bash
|
47 | docker run -v $(pwd):/usr/src/app vscode-generator-code
|
48 | ```
|
49 |
|
50 | ## History
|
51 |
|
52 | * 1.0.0: Generates a VS Code extension for TypeScript 2.0.3
|
53 | * 0.10.x: Generates a VS Code extension for TypeScript 1.8.10
|
54 |
|
55 | ## License
|
56 |
|
57 | [MIT](LICENSE)
|