Skip to content

Commit 4fcf216

Browse files
repo: add updated information to build
The commit updates the generator by: - setting the `engines` for the repo and templates to allowed node versions - updating the `prerequisites` documentation to point to the original source found in the main repository so it does not get outdated. Signed-off-by: vince-fugnitto <[email protected]>
1 parent 163c610 commit 4fcf216

File tree

3 files changed

+10
-13
lines changed

3 files changed

+10
-13
lines changed

package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{
22
"name": "generator-theia-extension",
33
"version": "0.1.32",
4+
"engines": {
5+
"yarn": ">=1.7.0 <2",
6+
"node": ">=14.18.0"
7+
},
48
"description": "Helps to setup the project structure for developing extensions to the Theia IDE",
59
"repository": {
610
"type": "git",

templates/README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,7 @@ The example of how to build the Theia-based applications with the <%= params.ext
33

44
## Getting started
55

6-
Install [nvm](https://github.com/creationix/nvm#install-script).
7-
8-
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
9-
10-
Install npm and node.
11-
12-
nvm install 10
13-
nvm use 10
14-
15-
Install yarn.
16-
17-
npm install -g yarn
6+
Please install all necessary [prerequisites](https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md#prerequisites).
187

198
## Running the browser example
209

@@ -51,7 +40,7 @@ Open http://localhost:3000 in the browser.
5140

5241
cd <%= params.extensionPath %>
5342
yarn test
54-
43+
5544
<%}%>
5645
## Developing with the browser example
5746

templates/root-package.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
22
"private": true,
3+
"engines": {
4+
"yarn": ">=1.7.0 <2",
5+
"node": ">=14.18.0"
6+
},
37
"scripts": {
48
"prepare": "lerna run prepare",
59
"rebuild:browser": "theia rebuild:browser",

0 commit comments

Comments
 (0)