xs-dev 0.9.0 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -9
- package/build/cli.js +2 -1
- package/build/commands/run.js +24 -13
- package/build/commands/setup.js +9 -2
- package/build/commands/teardown.js +3 -1
- package/build/toolbox/prompt/devices.js +14 -0
- package/build/toolbox/setup/pico.js +11 -11
- package/build/types/toolbox/prompt/devices.d.ts +2 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -9,12 +9,10 @@ The Moddable SDK and associated dev board tooling is incredibly empowering for e
|
|
|
9
9
|
- [X] [Moddable SDK install & setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/Moddable%20SDK%20-%20Getting%20Started.md)
|
|
10
10
|
- [X] [ESP32 SDK setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp32.md)
|
|
11
11
|
- [X] [ESP8266 SDK setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp8266.md)
|
|
12
|
-
- [
|
|
13
|
-
- [
|
|
12
|
+
- [X] [WASM simulator](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/wasm.md)
|
|
13
|
+
- [X] [Raspberry Pi Pico](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/pico.md)
|
|
14
14
|
- [X] Update Moddable SDK
|
|
15
15
|
- [X] Project management, including dependencies
|
|
16
|
-
- [X] WASM simulator
|
|
17
|
-
- [X] Raspberry Pi Pico
|
|
18
16
|
|
|
19
17
|
**Platform support:**
|
|
20
18
|
|
|
@@ -36,6 +34,12 @@ Setup commands rely on [`ssh-askpass`](https://packages.ubuntu.com/bionic/ssh-as
|
|
|
36
34
|
npm install -g xs-dev
|
|
37
35
|
```
|
|
38
36
|
|
|
37
|
+
## Update
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
npm update -g xs-dev@latest
|
|
41
|
+
```
|
|
42
|
+
|
|
39
43
|
## Features
|
|
40
44
|
|
|
41
45
|
### Moddable SDK setup / update / teardown
|
|
@@ -82,7 +86,7 @@ xs-dev run --example helloworld --device=esp32
|
|
|
82
86
|
|
|
83
87
|
Flags:
|
|
84
88
|
|
|
85
|
-
- `device`: `esp8266` | `esp32` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
89
|
+
- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
86
90
|
- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)
|
|
87
91
|
|
|
88
92
|
### ESP8266 SDK install / setup
|
|
@@ -103,7 +107,7 @@ xs-dev run --example helloworld --device=esp8266
|
|
|
103
107
|
|
|
104
108
|
Flags:
|
|
105
109
|
|
|
106
|
-
- `device`: `esp8266` | `esp32` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
110
|
+
- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
107
111
|
- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)
|
|
108
112
|
|
|
109
113
|
### Wasm Simulator install / setup
|
|
@@ -125,6 +129,27 @@ Run script to confirm the setup:
|
|
|
125
129
|
xs-dev run --example helloworld --device=wasm
|
|
126
130
|
```
|
|
127
131
|
|
|
132
|
+
### Raspberry Pi Pico SDK install / setup
|
|
133
|
+
|
|
134
|
+
This process automates the instructions for downloading all the dependencies for the Pico SDK. These dependencies will be placed in the `~/.local/share/pico` directory, which will be created if it doesn't exist.
|
|
135
|
+
|
|
136
|
+
Run script for platform setup:
|
|
137
|
+
|
|
138
|
+
```
|
|
139
|
+
xs-dev setup --device=pico
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Run script to confirm the setup:
|
|
143
|
+
|
|
144
|
+
```
|
|
145
|
+
xs-dev run --example helloworld --device=pico
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Flags:
|
|
149
|
+
|
|
150
|
+
- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
151
|
+
- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)
|
|
152
|
+
|
|
128
153
|
### Run Moddable examples
|
|
129
154
|
|
|
130
155
|
While it is still possible to run the Moddable example projects in the documented workflow:
|
|
@@ -141,14 +166,14 @@ List available examples:
|
|
|
141
166
|
xs-dev run --list-examples
|
|
142
167
|
```
|
|
143
168
|
|
|
144
|
-
Run an example
|
|
169
|
+
Run an example:
|
|
145
170
|
```
|
|
146
171
|
xs-dev run --example helloworld
|
|
147
172
|
```
|
|
148
173
|
|
|
149
174
|
Flags:
|
|
150
175
|
|
|
151
|
-
- `device`: `esp8266` | `esp32` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
176
|
+
- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
152
177
|
- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)
|
|
153
178
|
|
|
154
179
|
## Project management
|
|
@@ -183,7 +208,7 @@ xs-dev run path/to/project
|
|
|
183
208
|
|
|
184
209
|
Flags:
|
|
185
210
|
|
|
186
|
-
- `device`: `esp8266` | `esp32` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
211
|
+
- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)
|
|
187
212
|
- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)
|
|
188
213
|
|
|
189
214
|
### Add a Moddable module
|
package/build/cli.js
CHANGED
|
@@ -11,6 +11,7 @@ async function run(argv) {
|
|
|
11
11
|
.src(__dirname)
|
|
12
12
|
.help() // provides default for help, h, --help, -h
|
|
13
13
|
.version() // provides default for version, v, --version, -v
|
|
14
|
+
.checkForUpdates(25)
|
|
14
15
|
.create();
|
|
15
16
|
// enable the following method if you'd like to skip loading one of these core extensions
|
|
16
17
|
// this can improve performance if they're not necessary for your project:
|
|
@@ -19,4 +20,4 @@ async function run(argv) {
|
|
|
19
20
|
return await cli.run(argv);
|
|
20
21
|
}
|
|
21
22
|
module.exports = { run };
|
|
22
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
23
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLHFDQUErQjtBQUUvQjs7R0FFRztBQUNILEtBQUssVUFBVSxHQUFHLENBQUMsSUFBYztJQUMvQix1QkFBdUI7SUFDdkIsTUFBTSxHQUFHLEdBQUcsSUFBQSxlQUFLLEdBQUU7U0FDaEIsS0FBSyxDQUFDLFFBQVEsQ0FBQztTQUNmLEdBQUcsQ0FBQyxTQUFTLENBQUM7U0FDZCxJQUFJLEVBQUUsQ0FBQywyQ0FBMkM7U0FDbEQsT0FBTyxFQUFFLENBQUMsaURBQWlEO1NBQzNELGVBQWUsQ0FBQyxFQUFFLENBQUM7U0FDbkIsTUFBTSxFQUFFLENBQUE7SUFDWCx5RkFBeUY7SUFDekYsMEVBQTBFO0lBQzFFLHdJQUF3STtJQUN4SSxhQUFhO0lBQ2IsT0FBTyxNQUFNLEdBQUcsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUE7QUFDNUIsQ0FBQztBQUVELE1BQU0sQ0FBQyxPQUFPLEdBQUcsRUFBRSxHQUFHLEVBQUUsQ0FBQSJ9
|
package/build/commands/run.js
CHANGED
|
@@ -7,16 +7,7 @@ const os_1 = require("os");
|
|
|
7
7
|
const serve_handler_1 = __importDefault(require("serve-handler"));
|
|
8
8
|
const http_1 = require("http");
|
|
9
9
|
const choices_1 = require("../toolbox/prompt/choices");
|
|
10
|
-
const
|
|
11
|
-
esp8266: 'esp',
|
|
12
|
-
darwin: 'mac',
|
|
13
|
-
windows_nt: 'win',
|
|
14
|
-
linux: 'lin',
|
|
15
|
-
esp: 'esp',
|
|
16
|
-
esp32: 'esp32',
|
|
17
|
-
wasm: 'wasm',
|
|
18
|
-
pico: 'pico',
|
|
19
|
-
});
|
|
10
|
+
const devices_1 = require("../toolbox/prompt/devices");
|
|
20
11
|
const command = {
|
|
21
12
|
name: 'run',
|
|
22
13
|
description: 'Build and launch project on target device or simulator',
|
|
@@ -24,7 +15,7 @@ const command = {
|
|
|
24
15
|
var _a, _b, _c;
|
|
25
16
|
const currentPlatform = (0, os_1.type)().toLowerCase();
|
|
26
17
|
const { device = currentPlatform, port, example, listExamples = false, listDevices = false, } = parameters.options;
|
|
27
|
-
let targetPlatform = (_a = DEVICE_ALIAS[device]) !== null && _a !== void 0 ? _a : device;
|
|
18
|
+
let targetPlatform = (_a = devices_1.DEVICE_ALIAS[device]) !== null && _a !== void 0 ? _a : device;
|
|
28
19
|
let projectPath = filesystem.resolve((_b = parameters.first) !== null && _b !== void 0 ? _b : '.');
|
|
29
20
|
if (listDevices) {
|
|
30
21
|
const choices = [
|
|
@@ -52,6 +43,18 @@ const command = {
|
|
|
52
43
|
'esp32/saola_wroom',
|
|
53
44
|
'esp32/saola_wrover',
|
|
54
45
|
'wasm',
|
|
46
|
+
'pico',
|
|
47
|
+
'pico/ili9341',
|
|
48
|
+
'pico/pico_display',
|
|
49
|
+
'pico/pico_display_2',
|
|
50
|
+
'simulator/moddable_one',
|
|
51
|
+
'simulator/moddable_two',
|
|
52
|
+
'simulator/moddable_three',
|
|
53
|
+
'simulator/m5stickc',
|
|
54
|
+
'simulator/m5paper',
|
|
55
|
+
'simulator/nodemcu',
|
|
56
|
+
'simulator/pico_display',
|
|
57
|
+
'simulator/pico_display_2',
|
|
55
58
|
];
|
|
56
59
|
const { device: selectedDevice } = await prompt.ask([
|
|
57
60
|
{
|
|
@@ -94,6 +97,11 @@ const command = {
|
|
|
94
97
|
}
|
|
95
98
|
if (example !== undefined) {
|
|
96
99
|
const exampleProjectPath = filesystem.resolve(String(process.env.MODDABLE), 'examples', example);
|
|
100
|
+
if (filesystem.exists(exampleProjectPath) === false) {
|
|
101
|
+
print.error('Example project does not exist.');
|
|
102
|
+
print.info(`Lookup the available examples: xs-dev run --list-examples`);
|
|
103
|
+
process.exit(1);
|
|
104
|
+
}
|
|
97
105
|
if (filesystem.exists(filesystem.resolve(exampleProjectPath, 'manifest.json')) === false) {
|
|
98
106
|
print.error('Example project must contain a manifest.json.');
|
|
99
107
|
print.info(`Lookup the available examples: xs-dev run --list-examples`);
|
|
@@ -108,7 +116,7 @@ const command = {
|
|
|
108
116
|
spinner.start(`Building and running project ${projectPath} on ${targetPlatform}`);
|
|
109
117
|
await system.exec(`mcconfig -d -m -p ${targetPlatform}`, {
|
|
110
118
|
cwd: projectPath,
|
|
111
|
-
|
|
119
|
+
process,
|
|
112
120
|
});
|
|
113
121
|
spinner.stop();
|
|
114
122
|
if (targetPlatform === 'wasm') {
|
|
@@ -120,7 +128,10 @@ const command = {
|
|
|
120
128
|
print.info('Started server on port 8080, go to http://localhost:8080 in your browser to view the simulator');
|
|
121
129
|
});
|
|
122
130
|
}
|
|
131
|
+
else {
|
|
132
|
+
process.exit(0);
|
|
133
|
+
}
|
|
123
134
|
},
|
|
124
135
|
};
|
|
125
136
|
exports.default = command;
|
|
126
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
137
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicnVuLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbW1hbmRzL3J1bi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUNBLDJCQUF5QztBQUN6QyxrRUFBbUM7QUFDbkMsK0JBQW1DO0FBRW5DLHVEQUFrRTtBQUNsRSx1REFBd0Q7QUFVeEQsTUFBTSxPQUFPLEdBQWlDO0lBQzVDLElBQUksRUFBRSxLQUFLO0lBQ1gsV0FBVyxFQUFFLHdEQUF3RDtJQUNyRSxHQUFHLEVBQUUsS0FBSyxFQUFFLEVBQUUsVUFBVSxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUUsVUFBVSxFQUFFLE1BQU0sRUFBRSxFQUFFLEVBQUU7O1FBQy9ELE1BQU0sZUFBZSxHQUFXLElBQUEsU0FBWSxHQUFFLENBQUMsV0FBVyxFQUFZLENBQUE7UUFDdEUsTUFBTSxFQUNKLE1BQU0sR0FBRyxlQUFlLEVBQ3hCLElBQUksRUFDSixPQUFPLEVBQ1AsWUFBWSxHQUFHLEtBQUssRUFDcEIsV0FBVyxHQUFHLEtBQUssR0FDcEIsR0FBZSxVQUFVLENBQUMsT0FBTyxDQUFBO1FBQ2xDLElBQUksY0FBYyxHQUFXLE1BQUEsc0JBQVksQ0FBQyxNQUFNLENBQUMsbUNBQUksTUFBTSxDQUFBO1FBQzNELElBQUksV0FBVyxHQUFHLFVBQVUsQ0FBQyxPQUFPLENBQUMsTUFBQSxVQUFVLENBQUMsS0FBSyxtQ0FBSSxHQUFHLENBQUMsQ0FBQTtRQUU3RCxJQUFJLFdBQVcsRUFBRTtZQUNmLE1BQU0sT0FBTyxHQUFHO2dCQUNkLEtBQUs7Z0JBQ0wsbUJBQW1CO2dCQUNuQixrQkFBa0I7Z0JBQ2xCLG9CQUFvQjtnQkFDcEIsYUFBYTtnQkFDYixPQUFPO2dCQUNQLG9CQUFvQjtnQkFDcEIsZUFBZTtnQkFDZixlQUFlO2dCQUNmLHFCQUFxQjtnQkFDckIsb0JBQW9CO2dCQUNwQixtQkFBbUI7Z0JBQ25CLG1CQUFtQjtnQkFDbkIscUJBQXFCO2dCQUNyQixlQUFlO2dCQUNmLGtCQUFrQjtnQkFDbEIsMEJBQTBCO2dCQUMxQixtQkFBbUI7Z0JBQ25CLHdCQUF3QjtnQkFDeEIsa0JBQWtCO2dCQUNsQixjQUFjO2dCQUNkLG1CQUFtQjtnQkFDbkIsb0JBQW9CO2dCQUNwQixNQUFNO2dCQUNOLE1BQU07Z0JBQ04sY0FBYztnQkFDZCxtQkFBbUI7Z0JBQ25CLHFCQUFxQjtnQkFDckIsd0JBQXdCO2dCQUN4Qix3QkFBd0I7Z0JBQ3hCLDBCQUEwQjtnQkFDMUIsb0JBQW9CO2dCQUNwQixtQkFBbUI7Z0JBQ25CLG1CQUFtQjtnQkFDbkIsd0JBQXdCO2dCQUN4QiwwQkFBMEI7YUFDM0IsQ0FBQTtZQUNELE1BQU0sRUFBRSxNQUFNLEVBQUUsY0FBYyxFQUFFLEdBQUcsTUFBTSxNQUFNLENBQUMsR0FBRyxDQUFDO2dCQUNsRDtvQkFDRSxJQUFJLEVBQUUsY0FBYztvQkFDcEIsSUFBSSxFQUFFLFFBQVE7b0JBQ2QsT0FBTyxFQUFFLHdDQUF3QztvQkFDakQsT0FBTztpQkFDUjthQUNGLENBQUMsQ0FBQTtZQUVGLElBQUksY0FBYyxLQUFLLEVBQUUsSUFBSSxjQUFjLEtBQUssU0FBUyxFQUFFO2dCQUN6RCxjQUFjLEdBQUcsY0FBYyxDQUFBO2FBQ2hDO2lCQUFNO2dCQUNMLEtBQUssQ0FBQyxPQUFPLENBQUMsc0NBQXNDLENBQUMsQ0FBQTtnQkFDckQsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQTthQUNoQjtTQUNGO1FBRUQsSUFBSSxZQUFZLEVBQUU7WUFDaEIsTUFBTSxrQkFBa0IsR0FBRyxVQUFVLENBQUMsT0FBTyxDQUMzQyxNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsRUFDNUIsVUFBVSxDQUNYLENBQUE7WUFDRCxNQUFNLFFBQVEsR0FBRyxNQUFBLFVBQVUsQ0FBQyxXQUFXLENBQUMsa0JBQWtCLENBQUMsMENBQUUsUUFBUSxDQUFBO1lBQ3JFLE1BQU0sT0FBTyxHQUNYLFFBQVEsS0FBSyxTQUFTO2dCQUNwQixDQUFDLENBQUMsUUFBUSxDQUFDLEdBQUcsQ0FBQyxDQUFDLE9BQU8sRUFBRSxFQUFFLENBQUMsSUFBQSxnQ0FBc0IsRUFBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLElBQUksRUFBRTtnQkFDbkUsQ0FBQyxDQUFDLEVBQUUsQ0FBQTtZQUNSLE1BQU0sRUFBRSxPQUFPLEVBQUUsZUFBZSxFQUFFLEdBQUcsTUFBTSxNQUFNLENBQUMsR0FBRyxDQUFDO2dCQUNwRDtvQkFDRSxJQUFJLEVBQUUsY0FBYztvQkFDcEIsSUFBSSxFQUFFLFNBQVM7b0JBQ2YsT0FBTyxFQUFFLGtDQUFrQztvQkFDM0MsT0FBTztpQkFDUjthQUNGLENBQUMsQ0FBQTtZQUVGLElBQUksZUFBZSxLQUFLLEVBQUUsSUFBSSxlQUFlLEtBQUssU0FBUyxFQUFFO2dCQUMzRCxLQUFLLENBQUMsSUFBSSxDQUNSLDZDQUE2QyxlQUFlLEVBQUUsQ0FDL0QsQ0FBQTtnQkFDRCxXQUFXLEdBQUcsVUFBVSxDQUFDLE9BQU8sQ0FBQyxrQkFBa0IsRUFBRSxlQUFlLENBQUMsQ0FBQTthQUN0RTtpQkFBTTtnQkFDTCxLQUFLLENBQUMsT0FBTyxDQUFDLGtDQUFrQyxDQUFDLENBQUE7Z0JBQ2pELE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUE7YUFDaEI7U0FDRjtRQUVELElBQUksT0FBTyxLQUFLLFNBQVMsRUFBRTtZQUN6QixNQUFNLGtCQUFrQixHQUFHLFVBQVUsQ0FBQyxPQUFPLENBQzNDLE1BQU0sQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxFQUM1QixVQUFVLEVBQ1YsT0FBTyxDQUNSLENBQUE7WUFDRCxJQUFJLFVBQVUsQ0FBQyxNQUFNLENBQUMsa0JBQWtCLENBQUMsS0FBSyxLQUFLLEVBQUU7Z0JBQ25ELEtBQUssQ0FBQyxLQUFLLENBQUMsaUNBQWlDLENBQUMsQ0FBQTtnQkFDOUMsS0FBSyxDQUFDLElBQUksQ0FBQywyREFBMkQsQ0FBQyxDQUFBO2dCQUN2RSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFBO2FBQ2hCO1lBQ0QsSUFDRSxVQUFVLENBQUMsTUFBTSxDQUNmLFVBQVUsQ0FBQyxPQUFPLENBQUMsa0JBQWtCLEVBQUUsZUFBZSxDQUFDLENBQ3hELEtBQUssS0FBSyxFQUNYO2dCQUNBLEtBQUssQ0FBQyxLQUFLLENBQUMsK0NBQStDLENBQUMsQ0FBQTtnQkFDNUQsS0FBSyxDQUFDLElBQUksQ0FBQywyREFBMkQsQ0FBQyxDQUFBO2dCQUN2RSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFBO2FBQ2hCO1lBQ0QsV0FBVyxHQUFHLGtCQUFrQixDQUFBO1NBQ2pDO1FBRUQsSUFBSSxJQUFJLEtBQUssU0FBUyxFQUFFO1lBQ3RCLE9BQU8sQ0FBQyxHQUFHLENBQUMsV0FBVyxHQUFHLElBQUksQ0FBQTtTQUMvQjtRQUVELE1BQU0sT0FBTyxHQUFHLEtBQUssQ0FBQyxJQUFJLEVBQUUsQ0FBQTtRQUU1QixPQUFPLENBQUMsS0FBSyxDQUNYLGdDQUFnQyxXQUFXLE9BQU8sY0FBYyxFQUFFLENBQ25FLENBQUE7UUFFRCxNQUFNLE1BQU0sQ0FBQyxJQUFJLENBQUMscUJBQXFCLGNBQWMsRUFBRSxFQUFFO1lBQ3ZELEdBQUcsRUFBRSxXQUFXO1lBQ2hCLE9BQU87U0FDUixDQUFDLENBQUE7UUFFRixPQUFPLENBQUMsSUFBSSxFQUFFLENBQUE7UUFFZCxJQUFJLGNBQWMsS0FBSyxNQUFNLEVBQUU7WUFDN0IsTUFBTSxTQUFTLEdBQUcsTUFBTSxDQUFDLFdBQVcsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQTtZQUN0RCxNQUFNLFNBQVMsR0FBRyxVQUFVLENBQUMsT0FBTyxDQUNsQyxNQUFNLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsRUFDNUIsT0FBTyxFQUNQLEtBQUssRUFDTCxNQUFNLEVBQ04sT0FBTyxFQUNQLFNBQVMsQ0FDVixDQUFBO1lBQ0QsSUFBQSxtQkFBWSxFQUFDLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxFQUFFO2dCQUN4QixLQUFLLElBQUEsdUJBQU8sRUFBQyxHQUFHLEVBQUUsR0FBRyxFQUFFLEVBQUUsTUFBTSxFQUFFLFNBQVMsRUFBRSxDQUFDLENBQUE7WUFDL0MsQ0FBQyxDQUFDLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxHQUFHLEVBQUU7Z0JBQ25CLEtBQUssQ0FBQyxJQUFJLENBQ1IsZ0dBQWdHLENBQ2pHLENBQUE7WUFDSCxDQUFDLENBQUMsQ0FBQTtTQUNIO2FBQU07WUFDTCxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFBO1NBQ2hCO0lBQ0gsQ0FBQztDQUNGLENBQUE7QUFFRCxrQkFBZSxPQUFPLENBQUEifQ==
|
package/build/commands/setup.js
CHANGED
|
@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
const os_1 = require("os");
|
|
7
7
|
const fontbm_1 = __importDefault(require("../toolbox/setup/fontbm"));
|
|
8
|
+
const devices_1 = require("../toolbox/prompt/devices");
|
|
8
9
|
const command = {
|
|
9
10
|
name: 'setup',
|
|
10
11
|
description: 'Download and build Moddable tooling for various platform targets',
|
|
@@ -13,7 +14,13 @@ const command = {
|
|
|
13
14
|
const { device, listDevices = false, tool, } = parameters.options;
|
|
14
15
|
let target = device !== null && device !== void 0 ? device : currentPlatform;
|
|
15
16
|
if (device === undefined && listDevices) {
|
|
16
|
-
const choices = [
|
|
17
|
+
const choices = [
|
|
18
|
+
'esp8266',
|
|
19
|
+
'esp32',
|
|
20
|
+
'pico',
|
|
21
|
+
'wasm',
|
|
22
|
+
devices_1.DEVICE_ALIAS[currentPlatform],
|
|
23
|
+
];
|
|
17
24
|
const { device: selectedDevice } = await prompt.ask([
|
|
18
25
|
{
|
|
19
26
|
type: 'autocomplete',
|
|
@@ -42,4 +49,4 @@ const command = {
|
|
|
42
49
|
},
|
|
43
50
|
};
|
|
44
51
|
exports.default = command;
|
|
45
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
52
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2V0dXAuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tbWFuZHMvc2V0dXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFDQSwyQkFBeUM7QUFFekMscUVBQWlEO0FBQ2pELHVEQUF3RDtBQVF4RCxNQUFNLE9BQU8sR0FBaUM7SUFDNUMsSUFBSSxFQUFFLE9BQU87SUFDYixXQUFXLEVBQ1Qsa0VBQWtFO0lBQ3BFLEdBQUcsRUFBRSxLQUFLLEVBQUUsRUFBRSxVQUFVLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxLQUFLLEVBQUUsRUFBRSxFQUFFO1FBQ2xELE1BQU0sZUFBZSxHQUFXLElBQUEsU0FBWSxHQUFFLENBQUMsV0FBVyxFQUFZLENBQUE7UUFDdEUsTUFBTSxFQUNKLE1BQU0sRUFDTixXQUFXLEdBQUcsS0FBSyxFQUNuQixJQUFJLEdBQ0wsR0FBaUIsVUFBVSxDQUFDLE9BQU8sQ0FBQTtRQUNwQyxJQUFJLE1BQU0sR0FBVyxNQUFNLGFBQU4sTUFBTSxjQUFOLE1BQU0sR0FBSSxlQUFlLENBQUE7UUFFOUMsSUFBSSxNQUFNLEtBQUssU0FBUyxJQUFJLFdBQVcsRUFBRTtZQUN2QyxNQUFNLE9BQU8sR0FBRztnQkFDZCxTQUFTO2dCQUNULE9BQU87Z0JBQ1AsTUFBTTtnQkFDTixNQUFNO2dCQUNOLHNCQUFZLENBQUMsZUFBZSxDQUFDO2FBQzlCLENBQUE7WUFDRCxNQUFNLEVBQUUsTUFBTSxFQUFFLGNBQWMsRUFBRSxHQUFHLE1BQU0sTUFBTSxDQUFDLEdBQUcsQ0FBQztnQkFDbEQ7b0JBQ0UsSUFBSSxFQUFFLGNBQWM7b0JBQ3BCLElBQUksRUFBRSxRQUFRO29CQUNkLE9BQU8sRUFBRSx3Q0FBd0M7b0JBQ2pELE9BQU87aUJBQ1I7YUFDRixDQUFDLENBQUE7WUFFRixJQUFJLGNBQWMsS0FBSyxFQUFFLElBQUksY0FBYyxLQUFLLFNBQVMsRUFBRTtnQkFDekQsTUFBTSxHQUFHLGNBQXdCLENBQUE7YUFDbEM7aUJBQU07Z0JBQ0wsS0FBSyxDQUFDLE9BQU8sQ0FBQyxzQ0FBc0MsQ0FBQyxDQUFBO2dCQUNyRCxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFBO2FBQ2hCO1NBQ0Y7UUFFRCxJQUFJLElBQUksS0FBSyxTQUFTLEVBQUU7WUFDdEIsSUFBSSxJQUFJLEtBQUssUUFBUSxFQUFFO2dCQUNyQixLQUFLLENBQUMsT0FBTyxDQUFDLGdCQUFnQixJQUFJLEVBQUUsQ0FBQyxDQUFBO2dCQUNyQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFBO2FBQ2hCO1lBQ0QsTUFBTSxJQUFBLGdCQUFXLEdBQUUsQ0FBQTtZQUNuQixPQUFNO1NBQ1A7UUFFRCxNQUFNLEtBQUssQ0FBQyxNQUFNLENBQUMsRUFBRSxDQUFBO0lBQ3ZCLENBQUM7Q0FDRixDQUFBO0FBRUQsa0JBQWUsT0FBTyxDQUFBIn0=
|
|
@@ -13,6 +13,8 @@ const command = {
|
|
|
13
13
|
filesystem.remove(filesystem.resolve(constants_1.INSTALL_DIR, 'wasm'));
|
|
14
14
|
filesystem.remove(filesystem.resolve(constants_1.INSTALL_DIR, 'esp32'));
|
|
15
15
|
filesystem.remove(filesystem.resolve(constants_1.INSTALL_DIR, 'esp'));
|
|
16
|
+
filesystem.remove(filesystem.resolve(constants_1.INSTALL_DIR, 'pico'));
|
|
17
|
+
filesystem.remove(filesystem.resolve(constants_1.INSTALL_DIR, 'fontbm'));
|
|
16
18
|
await patching.patch(PROFILE_PATH, {
|
|
17
19
|
delete: `source ${constants_1.EXPORTS_FILE_PATH}`,
|
|
18
20
|
});
|
|
@@ -20,4 +22,4 @@ const command = {
|
|
|
20
22
|
},
|
|
21
23
|
};
|
|
22
24
|
exports.default = command;
|
|
23
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
25
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVhcmRvd24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tbWFuZHMvdGVhcmRvd24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSwwREFJbUM7QUFFbkMsTUFBTSxPQUFPLEdBQW1CO0lBQzlCLElBQUksRUFBRSxVQUFVO0lBQ2hCLFdBQVcsRUFDVCwwRUFBMEU7SUFDNUUsR0FBRyxFQUFFLEtBQUssRUFBRSxFQUFFLEtBQUssRUFBRSxVQUFVLEVBQUUsUUFBUSxFQUFFLEVBQUUsRUFBRTtRQUM3QyxNQUFNLFlBQVksR0FBRyxJQUFBLDBCQUFjLEdBQUUsQ0FBQTtRQUNyQyxNQUFNLE9BQU8sR0FBRyxLQUFLLENBQUMsSUFBSSxFQUFFLENBQUE7UUFDNUIsT0FBTyxDQUFDLEtBQUssQ0FBQyx1REFBdUQsQ0FBQyxDQUFBO1FBRXRFLFVBQVUsQ0FBQyxNQUFNLENBQUMsNkJBQWlCLENBQUMsQ0FBQTtRQUNwQyxVQUFVLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsdUJBQVcsRUFBRSxVQUFVLENBQUMsQ0FBQyxDQUFBO1FBQzlELFVBQVUsQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyx1QkFBVyxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUE7UUFDMUQsVUFBVSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLHVCQUFXLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQTtRQUMzRCxVQUFVLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsdUJBQVcsRUFBRSxLQUFLLENBQUMsQ0FBQyxDQUFBO1FBQ3pELFVBQVUsQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyx1QkFBVyxFQUFFLE1BQU0sQ0FBQyxDQUFDLENBQUE7UUFDMUQsVUFBVSxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsT0FBTyxDQUFDLHVCQUFXLEVBQUUsUUFBUSxDQUFDLENBQUMsQ0FBQTtRQUU1RCxNQUFNLFFBQVEsQ0FBQyxLQUFLLENBQUMsWUFBWSxFQUFFO1lBQ2pDLE1BQU0sRUFBRSxVQUFVLDZCQUFpQixFQUFFO1NBQ3RDLENBQUMsQ0FBQTtRQUVGLE9BQU8sQ0FBQyxPQUFPLENBQUMsb0JBQW9CLENBQUMsQ0FBQTtJQUN2QyxDQUFDO0NBQ0YsQ0FBQTtBQUVELGtCQUFlLE9BQU8sQ0FBQSJ9
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DEVICE_ALIAS = void 0;
|
|
4
|
+
exports.DEVICE_ALIAS = Object.freeze({
|
|
5
|
+
esp8266: 'esp',
|
|
6
|
+
darwin: 'mac',
|
|
7
|
+
windows_nt: 'win',
|
|
8
|
+
linux: 'lin',
|
|
9
|
+
esp: 'esp',
|
|
10
|
+
esp32: 'esp32',
|
|
11
|
+
wasm: 'wasm',
|
|
12
|
+
pico: 'pico',
|
|
13
|
+
});
|
|
14
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGV2aWNlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy90b29sYm94L3Byb21wdC9kZXZpY2VzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUVhLFFBQUEsWUFBWSxHQUF1QyxNQUFNLENBQUMsTUFBTSxDQUFDO0lBQzVFLE9BQU8sRUFBRSxLQUFLO0lBQ2QsTUFBTSxFQUFFLEtBQUs7SUFDYixVQUFVLEVBQUUsS0FBSztJQUNqQixLQUFLLEVBQUUsS0FBSztJQUNaLEdBQUcsRUFBRSxLQUFLO0lBQ1YsS0FBSyxFQUFFLE9BQU87SUFDZCxJQUFJLEVBQUUsTUFBTTtJQUNaLElBQUksRUFBRSxNQUFNO0NBQ2IsQ0FBQyxDQUFBIn0=
|
|
@@ -15,9 +15,9 @@ async function default_1() {
|
|
|
15
15
|
const PICO_SDK_REPO = 'https://github.com/raspberrypi/pico-sdk';
|
|
16
16
|
const PICO_EXAMPLES_REPO = 'https://github.com/raspberrypi/pico-examples';
|
|
17
17
|
const PICO_DIR = gluegun_1.filesystem.resolve(constants_1.INSTALL_DIR, 'pico');
|
|
18
|
-
const
|
|
18
|
+
const PICO_SDK_DIR = gluegun_1.filesystem.resolve(PICO_DIR, 'pico-sdk');
|
|
19
19
|
const PICO_EXAMPLES_PATH = gluegun_1.filesystem.resolve(PICO_DIR, 'pico-examples');
|
|
20
|
-
const PICO_SDK_BUILD_DIR = gluegun_1.filesystem.resolve(
|
|
20
|
+
const PICO_SDK_BUILD_DIR = gluegun_1.filesystem.resolve(PICO_SDK_DIR, 'build');
|
|
21
21
|
const spinner = gluegun_1.print.spin();
|
|
22
22
|
spinner.start('Starting pico tooling setup');
|
|
23
23
|
// 0. ensure pico instal directory and Moddable exists
|
|
@@ -46,13 +46,13 @@ async function default_1() {
|
|
|
46
46
|
}
|
|
47
47
|
spinner.succeed();
|
|
48
48
|
// 2. Install the pico sdk and examples:
|
|
49
|
-
if (gluegun_1.filesystem.exists(
|
|
49
|
+
if (gluegun_1.filesystem.exists(PICO_SDK_DIR) === false) {
|
|
50
50
|
spinner.start('Cloning pico-sdk repo');
|
|
51
|
-
await gluegun_1.system.exec(`git clone -b master ${PICO_SDK_REPO} ${
|
|
51
|
+
await gluegun_1.system.exec(`git clone -b master ${PICO_SDK_REPO} ${PICO_SDK_DIR}`, {
|
|
52
52
|
stdout: process.stdout,
|
|
53
53
|
});
|
|
54
54
|
await gluegun_1.system.exec(`git submodule update --init`, {
|
|
55
|
-
cwd:
|
|
55
|
+
cwd: PICO_SDK_DIR,
|
|
56
56
|
stdout: process.stdout,
|
|
57
57
|
});
|
|
58
58
|
spinner.succeed();
|
|
@@ -63,13 +63,13 @@ async function default_1() {
|
|
|
63
63
|
spinner.succeed();
|
|
64
64
|
}
|
|
65
65
|
// 3. Set the PICO_SDK_PATH environment variable to point to the Pico SDK directory
|
|
66
|
-
if (process.env.
|
|
67
|
-
spinner.info('Setting
|
|
68
|
-
process.env.
|
|
69
|
-
await (0, upsert_1.default)(constants_1.EXPORTS_FILE_PATH, `export
|
|
66
|
+
if (process.env.PICO_SDK_DIR === undefined) {
|
|
67
|
+
spinner.info('Setting PICO_SDK_DIR');
|
|
68
|
+
process.env.PICO_SDK_DIR = PICO_SDK_DIR;
|
|
69
|
+
await (0, upsert_1.default)(constants_1.EXPORTS_FILE_PATH, `export PICO_SDK_DIR=${PICO_SDK_DIR}`);
|
|
70
70
|
}
|
|
71
71
|
else {
|
|
72
|
-
spinner.info(`Using existing $
|
|
72
|
+
spinner.info(`Using existing $PICO_SDK_DIR: ${process.env.PICO_SDK_DIR}`);
|
|
73
73
|
}
|
|
74
74
|
// 4. Build some pico tools:
|
|
75
75
|
if (gluegun_1.filesystem.exists(PICO_SDK_BUILD_DIR) === false ||
|
|
@@ -95,4 +95,4 @@ Then run: xs-dev run --example helloworld --device pico
|
|
|
95
95
|
`);
|
|
96
96
|
}
|
|
97
97
|
exports.default = default_1;
|
|
98
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
98
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGljby5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy90b29sYm94L3NldHVwL3BpY28udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxxQ0FBbUQ7QUFDbkQsMkJBQXlDO0FBQ3pDLDJDQUE0RDtBQUM1RCxnRUFBdUM7QUFDdkMsb0NBQTBEO0FBQzFELHdDQUE4RDtBQUUvQyxLQUFLOztJQUNsQixNQUFNLEVBQUUsR0FBRyxJQUFBLFNBQVksR0FBRSxDQUFDLFdBQVcsRUFBRSxDQUFBO0lBQ3ZDLE1BQU0sYUFBYSxHQUFHLHlDQUF5QyxDQUFBO0lBQy9ELE1BQU0sa0JBQWtCLEdBQUcsOENBQThDLENBQUE7SUFDekUsTUFBTSxRQUFRLEdBQUcsb0JBQVUsQ0FBQyxPQUFPLENBQUMsdUJBQVcsRUFBRSxNQUFNLENBQUMsQ0FBQTtJQUN4RCxNQUFNLFlBQVksR0FBRyxvQkFBVSxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsVUFBVSxDQUFDLENBQUE7SUFDN0QsTUFBTSxrQkFBa0IsR0FBRyxvQkFBVSxDQUFDLE9BQU8sQ0FBQyxRQUFRLEVBQUUsZUFBZSxDQUFDLENBQUE7SUFDeEUsTUFBTSxrQkFBa0IsR0FBRyxvQkFBVSxDQUFDLE9BQU8sQ0FBQyxZQUFZLEVBQUUsT0FBTyxDQUFDLENBQUE7SUFFcEUsTUFBTSxPQUFPLEdBQUcsZUFBSyxDQUFDLElBQUksRUFBRSxDQUFBO0lBQzVCLE9BQU8sQ0FBQyxLQUFLLENBQUMsNkJBQTZCLENBQUMsQ0FBQTtJQUU1QyxzREFBc0Q7SUFDdEQsSUFDRSxPQUFPLENBQUMsR0FBRyxDQUFDLFFBQVEsS0FBSyxTQUFTO1FBQ2xDLG9CQUFVLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsUUFBUSxDQUFDLEtBQUssS0FBSyxFQUNqRDtRQUNBLE9BQU8sQ0FBQyxJQUFJLENBQ1YsNkVBQTZFLENBQzlFLENBQUE7UUFDRCxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFBO0tBQ2hCO0lBQ0QsT0FBTyxDQUFDLElBQUksQ0FBQyx5QkFBeUIsQ0FBQyxDQUFBO0lBQ3ZDLG9CQUFVLENBQUMsR0FBRyxDQUFDLFFBQVEsQ0FBQyxDQUFBO0lBRXhCLGlDQUFpQztJQUNqQyxJQUFJLEVBQUUsS0FBSyxRQUFRLEVBQUU7UUFDbkIsSUFBSSxnQkFBTSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsS0FBSyxJQUFJLEVBQUU7WUFDbEMsT0FBTyxDQUFDLEtBQUssQ0FBQywwQ0FBMEMsQ0FBQyxDQUFBO1lBQ3pELE1BQU0sZ0JBQU0sQ0FBQyxJQUFJLENBQUMsb0JBQW9CLENBQUMsQ0FBQTtZQUN2QyxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUE7U0FDbEI7UUFFRCxPQUFPLENBQUMsS0FBSyxDQUFDLHVEQUF1RCxDQUFDLENBQUE7UUFDdEUsTUFBTSxJQUFBLGlCQUFjLEVBQUMsT0FBTyxDQUFDLENBQUE7S0FDOUI7SUFFRCxJQUFJLEVBQUUsS0FBSyxPQUFPLEVBQUU7UUFDbEIsT0FBTyxDQUFDLEtBQUssQ0FBQyx3Q0FBd0MsQ0FBQyxDQUFBO1FBQ3ZELE1BQU0sSUFBQSxtQkFBZ0IsRUFBQyxPQUFPLENBQUMsQ0FBQTtRQUMvQixPQUFPLENBQUMsR0FBRyxDQUFDLGFBQWEsR0FBRyxNQUFNLENBQUE7UUFDbEMsTUFBTSxJQUFBLGdCQUFNLEVBQUMsNkJBQWlCLEVBQUUsMkJBQTJCLENBQUMsQ0FBQTtLQUM3RDtJQUNELE9BQU8sQ0FBQyxPQUFPLEVBQUUsQ0FBQTtJQUVqQix3Q0FBd0M7SUFDeEMsSUFBSSxvQkFBVSxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsS0FBSyxLQUFLLEVBQUU7UUFDN0MsT0FBTyxDQUFDLEtBQUssQ0FBQyx1QkFBdUIsQ0FBQyxDQUFBO1FBQ3RDLE1BQU0sZ0JBQU0sQ0FBQyxJQUFJLENBQUMsdUJBQXVCLGFBQWEsSUFBSSxZQUFZLEVBQUUsRUFBRTtZQUN4RSxNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU07U0FDdkIsQ0FBQyxDQUFBO1FBQ0YsTUFBTSxnQkFBTSxDQUFDLElBQUksQ0FBQyw2QkFBNkIsRUFBRTtZQUMvQyxHQUFHLEVBQUUsWUFBWTtZQUNqQixNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU07U0FDdkIsQ0FBQyxDQUFBO1FBQ0YsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFBO0tBQ2xCO0lBRUQsSUFBSSxvQkFBVSxDQUFDLE1BQU0sQ0FBQyxrQkFBa0IsQ0FBQyxLQUFLLEtBQUssRUFBRTtRQUNuRCxPQUFPLENBQUMsS0FBSyxDQUFDLDJCQUEyQixDQUFDLENBQUE7UUFDMUMsTUFBTSxnQkFBTSxDQUFDLElBQUksQ0FDZix1QkFBdUIsa0JBQWtCLElBQUksa0JBQWtCLEVBQUUsRUFDakUsRUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDLE1BQU0sRUFBRSxDQUMzQixDQUFBO1FBQ0QsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFBO0tBQ2xCO0lBRUQsbUZBQW1GO0lBQ25GLElBQUksT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLEtBQUssU0FBUyxFQUFFO1FBQzFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsc0JBQXNCLENBQUMsQ0FBQTtRQUNwQyxPQUFPLENBQUMsR0FBRyxDQUFDLFlBQVksR0FBRyxZQUFZLENBQUE7UUFDdkMsTUFBTSxJQUFBLGdCQUFNLEVBQUMsNkJBQWlCLEVBQUUsdUJBQXVCLFlBQVksRUFBRSxDQUFDLENBQUE7S0FDdkU7U0FBTTtRQUNMLE9BQU8sQ0FBQyxJQUFJLENBQUMsaUNBQWlDLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxFQUFFLENBQUMsQ0FBQTtLQUMxRTtJQUVELDRCQUE0QjtJQUM1QixJQUNFLG9CQUFVLENBQUMsTUFBTSxDQUFDLGtCQUFrQixDQUFDLEtBQUssS0FBSztRQUMvQyxDQUFBLE1BQUEsb0JBQVUsQ0FBQyxJQUFJLENBQUMsa0JBQWtCLENBQUMsMENBQUUsTUFBTSxNQUFLLENBQUMsRUFDakQ7UUFDQSxPQUFPLENBQUMsS0FBSyxDQUFDLHVCQUF1QixDQUFDLENBQUE7UUFDdEMsb0JBQVUsQ0FBQyxHQUFHLENBQUMsa0JBQWtCLENBQUMsQ0FBQTtRQUNsQyxNQUFNLGdCQUFNLENBQUMsSUFBSSxDQUFDLFVBQVUsRUFBRTtZQUM1QixLQUFLLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFLO1lBQ3hCLE1BQU0sRUFBRSxPQUFPLENBQUMsTUFBTTtZQUN0QixHQUFHLEVBQUUsa0JBQWtCO1NBQ3hCLENBQUMsQ0FBQTtRQUNGLE1BQU0sZ0JBQU0sQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFO1lBQ3hCLEtBQUssRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDLEtBQUs7WUFDeEIsTUFBTSxFQUFFLE9BQU8sQ0FBQyxNQUFNO1lBQ3RCLEdBQUcsRUFBRSxrQkFBa0I7U0FDeEIsQ0FBQyxDQUFBO1FBQ0YsT0FBTyxDQUFDLE9BQU8sRUFBRSxDQUFBO0tBQ2xCO0lBRUQsT0FBTyxDQUFDLE9BQU8sQ0FBQzs7OztHQUlmLENBQUMsQ0FBQTtBQUNKLENBQUM7QUFyR0QsNEJBcUdDIn0=
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "xs-dev",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.11.0",
|
|
4
4
|
"description": "CLI for automating the setup and usage of Moddable XS tools",
|
|
5
5
|
"types": "build/types/types.d.ts",
|
|
6
6
|
"bin": {
|
|
@@ -71,5 +71,5 @@
|
|
|
71
71
|
"snapupdate": "jest --updateSnapshot",
|
|
72
72
|
"coverage": "jest --coverage"
|
|
73
73
|
},
|
|
74
|
-
"readme": "# CLI for automating the setup and usage of [Moddable XS tools](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/Moddable%20SDK%20-%20Getting%20Started.md)\n\nThe Moddable SDK and associated dev board tooling is incredibly empowering for embedded JS hardware development, however the set up process can be tedious to follow when getting started. This project aims to streamline the install and environment configuration requirements across platforms in just a few commands.\n\n**This project is a work in progress and should be considered pre-1.0.**\n\n**Feature support:**\n\n- [X] [Moddable SDK install & setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/Moddable%20SDK%20-%20Getting%20Started.md)\n- [X] [ESP32 SDK setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp32.md)\n- [X] [ESP8266 SDK setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp8266.md)\n- [
|
|
74
|
+
"readme": "# CLI for automating the setup and usage of [Moddable XS tools](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/Moddable%20SDK%20-%20Getting%20Started.md)\n\nThe Moddable SDK and associated dev board tooling is incredibly empowering for embedded JS hardware development, however the set up process can be tedious to follow when getting started. This project aims to streamline the install and environment configuration requirements across platforms in just a few commands.\n\n**This project is a work in progress and should be considered pre-1.0.**\n\n**Feature support:**\n\n- [X] [Moddable SDK install & setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/Moddable%20SDK%20-%20Getting%20Started.md)\n- [X] [ESP32 SDK setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp32.md)\n- [X] [ESP8266 SDK setup](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/esp8266.md)\n- [X] [WASM simulator](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/wasm.md)\n- [X] [Raspberry Pi Pico](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/pico.md)\n- [X] Update Moddable SDK\n- [X] Project management, including dependencies\n\n**Platform support:**\n\n- [X] Mac\n- [ ] Windows\n- [X] Linux\n\n## Requirements\n\n[Node.js >= v12](https://nodejs.org/en/)\n\n**On Linux:**\n\nSetup commands rely on [`ssh-askpass`](https://packages.ubuntu.com/bionic/ssh-askpass) to prompt for permission when installing other tools and dependencies.\n\n## Install\n\n```\nnpm install -g xs-dev\n```\n\n## Update\n\n```\nnpm update -g xs-dev@latest\n```\n\n## Features\n\n### Moddable SDK setup / update / teardown\n\nThis process mostly automates the instructions provided by Moddable's \"Getting Started\" documentation with a few exceptions:\n\n- it will not install XCode, just ensures the command line tools are available\n- the `moddable` git repo is cloned into `~/.local/share` instead of a new/existing `~/Projects` directory\n- a symlink for `xsbug.app` is created in `/Applications` for easy access through Launchpad (on Mac)\n\nRun script for initial setup:\n\n```\nxs-dev setup\n```\n\nRun script for updating SDK:\n\n```\nxs-dev update\n```\n\nRemove all setup and environment changes with teardown command:\n\n```\nxs-dev teardown\n```\n\n### ESP32 SDK install / setup\n\nThis process automates the instructions for downloading and building the esp-idf SDK tooling. This tooling will be placed in the `~/.local/share/esp32` directory, which will be created if it doesn't exist.\n\nRun script for platform setup:\n\n```\nxs-dev setup --device=esp32\n```\n\nRun script to confirm the setup:\n\n```\nxs-dev run --example helloworld --device=esp32\n```\n\nFlags:\n\n- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)\n- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)\n\n### ESP8266 SDK install / setup\n\nThis process automates the instructions for downloading all the dependencies for the ESP8266 RTOS SDK. These dependencies will be placed in the `~/.local/share/esp` directory, which will be created if it doesn't exist.\n\nRun script for platform setup:\n\n```\nxs-dev setup --device=esp8266\n```\n\nRun script to confirm the setup:\n\n```\nxs-dev run --example helloworld --device=esp8266\n```\n\nFlags:\n\n- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)\n- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)\n\n### Wasm Simulator install / setup\n\nThis process automates the instructions for downloading all the dependencies for the [wasm simulator](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/devices/wasm.md) and building the Moddable tooling. These dependencies will be placed in `~/.local/share/wasm`, which will be created if it doesn't exist.\n\nRun script for platform setup:\n\n```\nxs-dev setup --device=wasm\n```\n\n_If there are issues building the Moddable wasm tools, please try running `eval $SHELL` or starting a new shell insance before running the setup script again._\n\n\nRun script to confirm the setup:\n\n```\nxs-dev run --example helloworld --device=wasm\n```\n\n### Raspberry Pi Pico SDK install / setup\n\nThis process automates the instructions for downloading all the dependencies for the Pico SDK. These dependencies will be placed in the `~/.local/share/pico` directory, which will be created if it doesn't exist.\n\nRun script for platform setup:\n\n```\nxs-dev setup --device=pico\n```\n\nRun script to confirm the setup:\n\n```\nxs-dev run --example helloworld --device=pico\n```\n\nFlags:\n\n- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)\n- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)\n\n### Run Moddable examples\n\nWhile it is still possible to run the Moddable example projects in the documented workflow:\n\n```\ncd $MODDABLE/examples/<example directory>\nmcconfig -d -m -p <platform here>\n```\n\nThis tool aims to simplify that process.\n\nList available examples:\n```\nxs-dev run --list-examples\n```\n\nRun an example:\n```\nxs-dev run --example helloworld\n```\n\nFlags:\n\n- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)\n- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)\n\n## Project management\n\n### Start a project\n\n\n```\nxs-dev init my-project\n```\n\nCreates a `main.js` and base configured `manifest.json` for running in the simulator.\n\nFlags:\n\n- `typescript`: includes typings and creates `main.ts` (experimental)\n- `io`: includes [TC53 IO manifest](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/io/io.md)\n\n### Build and run a project\n\nIn the project directory:\n\n```\nxs-dev run\n```\n\nWhen not in the project directory:\n\n```\nxs-dev run path/to/project\n```\n\nFlags:\n\n- `device`: `esp8266` | `esp32` | `pico` | [any of the allowed platform identifiers](https://github.com/Moddable-OpenSource/moddable/blob/public/documentation/tools/tools.md#arguments) (defaults to current OS platform)\n- `port`: path to port for connected device (defaults to: `UPLOAD_PORT` environment variable)\n\n### Add a Moddable module\n\n```\nxs-dev include network/wifi\n```\n\nOr select from available modules:\n\n```\nxs-dev include\n```\n\nUpdates the `manifest.json` with the path to the dependency.\n\n### Scan for available devices\n\nIf the default device discovery is having trouble finding the correct port when running a project, use this command to find available ports to pass through the `--port` flag:\n\n```\n$ xs-dev scan\n\n✔ Found the following available devices!\n Port Device Features\n /dev/cu.usbserial-0001 ESP8266EX WiFi\n /dev/cu.usbserial-DN02N5XK ESP32-D0WDQ6 (revision 0) WiFi, BT, Dual Core, Coding Scheme None\n\n$ xs-dev run --port /dev/cu.usbserial-0001 --device esp8266\n```\n\n\n### Add a remote dependency (Coming soon)\n\n```\nxs-dev get dtex/j5e\n```\n\nAssumes the dependency is a GitHub repo, clones it to `~/.local/share`, creates an environment variable with the name of the repo, and updates the `manifest.json` with the path to that dependency.\n\nTo include a specific module for the installed dependency:\n\n```\nxs-dev include j5e/lib/led\n```\n\n### Remove a dependency\n\n```\nxs-dev remove network/wifi\n```\n\nUpdates the `manifest.json` to remove the dependency.\n\n## Development\n\nClone the project and install dependencies. We're using [pnpm](https://pnpm.io/) and [volta](https://volta.sh/) to manage packages and Node.\n\n```\ngit clone https://github.com/HipsterBrown/xs-dev.git\ncd xs-dev\npnpm install\n```\n\nLink dev version of CLI using `pnpm`, which will override any other globally installed version:\n\n```\npnpm link --global\npnpm link --global xs-dev\n```\n\nOr create an alias to clearly denote the local version of the CLI:\n\n```\nalias local-xs-dev=$PWD/bin/xs-dev\n```\n\nTo maintain the alias between shell sessions, for example I use zsh:\n\n```\necho \"alias local-xs-dev=$PWD/bin/xs-dev\" >> ~/.zshrc\n```\n"
|
|
75
75
|
}
|