xs-dev 0.33.1 β 0.33.2
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
CHANGED
|
@@ -132,6 +132,18 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|
|
132
132
|
<table>
|
|
133
133
|
<tr>
|
|
134
134
|
<td align="center"><a href="https://hipsterbrown.com/"><img src="https://avatars.githubusercontent.com/u/3051193?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nick Hehr</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=HipsterBrown" title="Documentation">π</a> <a href="#infra-HipsterBrown" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="https://github.com/HipsterBrown/xs-dev/commits?author=HipsterBrown" title="Code">π»</a></td>
|
|
135
|
+
<td align="center"><a href="https://moddable.com/"><img src="https://avatars.githubusercontent.com/u/1427817?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Andy Carle</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=andycarle" title="Code">π»</a></td>
|
|
136
|
+
<td align="center"><a href="https://moddable.com/"><img src="https://avatars.githubusercontent.com/u/6856458?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Peter Hoddie</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=phoddie" title="Code">π»</a></td>
|
|
137
|
+
<td align="center"><a href="https://github.com/stc1988"><img src="https://avatars.githubusercontent.com/u/11245747?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Satoshi Tanaka</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=stc1988" title="Code">π»</a></td>
|
|
138
|
+
<td align="center"><a href="https://linktr.ee/scr34mz"><img src="https://avatars.githubusercontent.com/u/6640835?v=4?s=100" width="100px;" alt=""/><br /><sub><b>AndrΓ©as Hanss</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=ScreamZ" title="Documentation">π</a></td>
|
|
139
|
+
<td align="center"><a href="https://github.com/intGus"><img src="https://avatars.githubusercontent.com/u/46197948?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Gustavo</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=intGus" title="Code">π»</a></td>
|
|
140
|
+
<td align="center"><a href="https://github.com/gibson042"><img src="https://avatars.githubusercontent.com/u/1199584?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Richard Gibson</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=gibson042" title="Documentation">π</a></td>
|
|
141
|
+
</tr>
|
|
142
|
+
<tr>
|
|
143
|
+
<td align="center"><a href="https://dev-portfolio-jay.netlify.app/"><img src="https://avatars.githubusercontent.com/u/115918351?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jay Kesarkar</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=jaykesarkar" title="Code">π»</a></td>
|
|
144
|
+
<td align="center"><a href="https://gustavo.is"><img src="https://avatars.githubusercontent.com/u/51838513?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Gustavo Gallegos</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=pricklywiggles" title="Documentation">π</a></td>
|
|
145
|
+
<td align="center"><a href="http://dtex.github.com"><img src="https://avatars.githubusercontent.com/u/854911?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Donovan Buck</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=dtex" title="Code">π»</a></td>
|
|
146
|
+
<td align="center"><a href="https://github.com/mkellner"><img src="https://avatars.githubusercontent.com/u/6822704?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michael Kellner</b></sub></a><br /><a href="https://github.com/HipsterBrown/xs-dev/commits?author=mkellner" title="Code">π»</a></td>
|
|
135
147
|
</tr>
|
|
136
148
|
</table>
|
|
137
149
|
|
package/build/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "xs-dev",
|
|
3
|
-
"version": "0.33.
|
|
3
|
+
"version": "0.33.2",
|
|
4
4
|
"description": "CLI for automating the setup and usage of Moddable XS tools",
|
|
5
5
|
"types": "build/types/types.d.ts",
|
|
6
6
|
"engines": {
|
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
"@types/unzip-stream": "^0.3.1",
|
|
76
76
|
"@typescript-eslint/eslint-plugin": "^8.1.0",
|
|
77
77
|
"@typescript-eslint/parser": "^8.1.0",
|
|
78
|
+
"all-contributors-cli": "^6.26.1",
|
|
78
79
|
"astro": "4.13.3",
|
|
79
80
|
"auto": "^11.2.1",
|
|
80
81
|
"eslint": "^8.57.0",
|
|
@@ -26,11 +26,13 @@ async function default_1() {
|
|
|
26
26
|
const PICOTOOL_PATH = gluegun_1.filesystem.resolve(PICO_ROOT, 'picotool');
|
|
27
27
|
const PICOTOOL_BUILD_DIR = gluegun_1.filesystem.resolve(PICOTOOL_PATH, 'build');
|
|
28
28
|
const PICO_SDK_BUILD_DIR = gluegun_1.filesystem.resolve(PICO_SDK_DIR, 'build');
|
|
29
|
-
const
|
|
29
|
+
const PIOASM_TOOL_PATH = gluegun_1.filesystem.resolve(PICO_SDK_DIR, 'tools', 'pioasm');
|
|
30
|
+
const PIOASM_BUILD_PATH = gluegun_1.filesystem.resolve(PICO_SDK_BUILD_DIR, 'pioasm');
|
|
31
|
+
const PIOASM_PATH = gluegun_1.filesystem.resolve(PIOASM_BUILD_PATH, 'pioasm');
|
|
30
32
|
await (0, exec_1.sourceEnvironment)();
|
|
31
33
|
const spinner = gluegun_1.print.spin();
|
|
32
34
|
spinner.start('Starting pico tooling setup');
|
|
33
|
-
// 0. ensure pico
|
|
35
|
+
// 0. ensure pico install directory and Moddable exists
|
|
34
36
|
if (!(0, moddable_1.moddableExists)()) {
|
|
35
37
|
spinner.fail('Moddable platform tooling required. Run `xs-dev setup` before trying again.');
|
|
36
38
|
process.exit(1);
|
|
@@ -83,7 +85,7 @@ async function default_1() {
|
|
|
83
85
|
}
|
|
84
86
|
if (gluegun_1.filesystem.exists(PICOTOOL_PATH) === false) {
|
|
85
87
|
spinner.start('Cloning picotool repo');
|
|
86
|
-
await gluegun_1.system.exec(`git clone --depth 1 --single-branch -b
|
|
88
|
+
await gluegun_1.system.exec(`git clone --depth 1 --single-branch -b ${PICO_BRANCH} ${PICOTOOL_REPO} ${PICOTOOL_PATH}`, {
|
|
87
89
|
stdout: process.stdout,
|
|
88
90
|
});
|
|
89
91
|
spinner.succeed();
|
|
@@ -120,6 +122,18 @@ async function default_1() {
|
|
|
120
122
|
stdout: process.stdout,
|
|
121
123
|
cwd: PICO_SDK_BUILD_DIR,
|
|
122
124
|
});
|
|
125
|
+
// Build pioasm
|
|
126
|
+
gluegun_1.filesystem.dir(PIOASM_BUILD_PATH);
|
|
127
|
+
await gluegun_1.system.exec(`cmake ${PIOASM_TOOL_PATH}`, {
|
|
128
|
+
shell: process.env.SHELL,
|
|
129
|
+
stdout: process.stdout,
|
|
130
|
+
cwd: PIOASM_BUILD_PATH,
|
|
131
|
+
});
|
|
132
|
+
await gluegun_1.system.exec('make', {
|
|
133
|
+
shell: process.env.SHELL,
|
|
134
|
+
stdout: process.stdout,
|
|
135
|
+
cwd: PIOASM_BUILD_PATH,
|
|
136
|
+
});
|
|
123
137
|
spinner.succeed();
|
|
124
138
|
}
|
|
125
139
|
// 5. Build _the_ picotool
|
|
@@ -162,4 +176,4 @@ Test out the setup by starting a new terminal session and putting the device int
|
|
|
162
176
|
Then run: xs-dev run --example helloworld --device pico
|
|
163
177
|
`);
|
|
164
178
|
}
|
|
165
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
179
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"pico.js","sourceRoot":"","sources":["../../../../src/toolbox/setup/pico.ts"],"names":[],"mappings":";;;;;AASA,4BAwMC;AAjND,qCAAmD;AACnD,2BAAyC;AACzC,2CAA4D;AAC5D,gEAAuC;AACvC,oCAA0D;AAC1D,wCAA8D;AAC9D,yCAA2C;AAC3C,yCAAkD;AAEnC,KAAK;IAClB,MAAM,EAAE,GAAG,IAAA,SAAY,GAAE,CAAC,WAAW,EAAE,CAAA;IACvC,MAAM,WAAW,GAAG,OAAO,CAAA;IAC3B,MAAM,aAAa,GAAG,yCAAyC,CAAA;IAC/D,MAAM,gBAAgB,GAAG,4CAA4C,CAAA;IACrE,MAAM,kBAAkB,GAAG,8CAA8C,CAAA;IACzE,MAAM,aAAa,GAAG,yCAAyC,CAAA;IAC/D,MAAM,SAAS,GACb,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,oBAAU,CAAC,OAAO,CAAC,uBAAW,EAAE,MAAM,CAAC,CAAA;IAClE,MAAM,YAAY,GAAG,oBAAU,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;IAC9D,MAAM,eAAe,GAAG,oBAAU,CAAC,OAAO,CAAC,SAAS,EAAE,aAAa,CAAC,CAAA;IACpE,MAAM,kBAAkB,GAAG,oBAAU,CAAC,OAAO,CAAC,SAAS,EAAE,eAAe,CAAC,CAAA;IACzE,MAAM,aAAa,GAAG,oBAAU,CAAC,OAAO,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;IAC/D,MAAM,kBAAkB,GAAG,oBAAU,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;IACrE,MAAM,kBAAkB,GAAG,oBAAU,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;IACpE,MAAM,gBAAgB,GAAG,oBAAU,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAA;IAC5E,MAAM,iBAAiB,GAAG,oBAAU,CAAC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAA;IAC1E,MAAM,WAAW,GAAG,oBAAU,CAAC,OAAO,CAAC,iBAAiB,EAAE,QAAQ,CAAC,CAAA;IAEnE,MAAM,IAAA,wBAAiB,GAAE,CAAA;IAEzB,MAAM,OAAO,GAAG,eAAK,CAAC,IAAI,EAAE,CAAA;IAC5B,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAA;IAE5C,uDAAuD;IACvD,IAAI,CAAC,IAAA,yBAAc,GAAE,EAAE,CAAC;QACtB,OAAO,CAAC,IAAI,CACV,6EAA6E,CAC9E,CAAA;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACvC,oBAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACzB,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACxC,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,oBAAoB,SAAS,EAAE,CAAC,CAAA;IAClE,CAAC;IAED,iCAAiC;IACjC,IAAI,EAAE,KAAK,QAAQ,EAAE,CAAC;QACpB,IAAI,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAA;YACzD,MAAM,gBAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;YACvC,OAAO,CAAC,OAAO,EAAE,CAAA;QACnB,CAAC;QAED,MAAM,IAAA,iBAAc,EAAC,OAAO,CAAC,CAAA;QAE7B,MAAM,UAAU,GAAG,MAAM,gBAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;QACpD,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,UAAU,CAAA;QACtC,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,wBAAwB,UAAU,EAAE,CAAC,CAAA;IACvE,CAAC;IAED,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;QACnB,OAAO,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAA;QACvD,MAAM,IAAA,mBAAgB,EAAC,OAAO,CAAC,CAAA;QAC/B,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,MAAM,CAAA;QAClC,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,2BAA2B,CAAC,CAAA;IAC9D,CAAC;IACD,OAAO,CAAC,OAAO,EAAE,CAAA;IAEjB,2DAA2D;IAC3D,IAAI,oBAAU,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,KAAK,EAAE,CAAC;QAC9C,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;QACtC,MAAM,gBAAM,CAAC,IAAI,CACf,0CAA0C,WAAW,IAAI,aAAa,IAAI,YAAY,EAAE,EACxF;YACE,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CACF,CAAA;QACD,MAAM,gBAAM,CAAC,IAAI,CAAC,6BAA6B,EAAE;YAC/C,GAAG,EAAE,YAAY;YACjB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC,CAAA;QACF,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC;IAED,IAAI,oBAAU,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,KAAK,EAAE,CAAC;QACjD,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAA;QACzC,MAAM,gBAAM,CAAC,IAAI,CACf,8CAA8C,WAAW,IAAI,gBAAgB,IAAI,eAAe,EAAE,EAClG,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAC3B,CAAA;QACD,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC;IAED,IAAI,oBAAU,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,KAAK,EAAE,CAAC;QACpD,OAAO,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAA;QAC3C,MAAM,gBAAM,CAAC,IAAI,CACf,8CAA8C,WAAW,IAAI,kBAAkB,IAAI,kBAAkB,EAAE,EACvG,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAC3B,CAAA;QACD,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC;IAED,IAAI,oBAAU,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,KAAK,EAAE,CAAC;QAC/C,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;QACtC,MAAM,gBAAM,CAAC,IAAI,CACf,0CAA0C,WAAW,IAAI,aAAa,IAAI,aAAa,EAAE,EACzF;YACE,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CACF,CAAA;QACD,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC;IAED,oIAAoI;IACpI,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;QAC3C,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAA;QACpC,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,YAAY,CAAA;QACvC,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,uBAAuB,YAAY,EAAE,CAAC,CAAA;IACxE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,iCAAiC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAA;IAC3E,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QAC9C,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;QACvC,OAAO,CAAC,GAAG,CAAC,eAAe,GAAG,eAAe,CAAA;QAC7C,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,0BAA0B,eAAe,EAAE,CAAC,CAAA;IAC9E,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CACV,oCAAoC,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,CAClE,CAAA;IACH,CAAC;IAED,4BAA4B;IAC5B,IACE,oBAAU,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,KAAK;QAC/C,oBAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,MAAM,KAAK,CAAC,EACjD,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;QACtC,oBAAU,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;QAClC,MAAM,gBAAM,CAAC,IAAI,CAAC,UAAU,EAAE;YAC5B,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,kBAAkB;SACxB,CAAC,CAAA;QACF,MAAM,gBAAM,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,kBAAkB;SACxB,CAAC,CAAA;QAEF,eAAe;QACf,oBAAU,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;QACjC,MAAM,gBAAM,CAAC,IAAI,CAAC,SAAS,gBAAgB,EAAE,EAAE;YAC7C,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,iBAAiB;SACvB,CAAC,CAAA;QACF,MAAM,gBAAM,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,iBAAiB;SACvB,CAAC,CAAA;QAEF,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC;IAED,0BAA0B;IAC1B,IAAI,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QAC5C,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAA;QACrC,OAAO,CAAC,GAAG,CAAC,aAAa,GAAG,YAAY,CAAA;QACxC,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,wBAAwB,YAAY,EAAE,CAAC,CAAA;IACzE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,kCAAkC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAA;IAC7E,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC9B,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,WAAW,CAAA;QAChC,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,iBAAiB,WAAW,EAAE,CAAC,CAAA;IACjE,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,2BAA2B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAA;IAC/D,CAAC;IAED,IACE,oBAAU,CAAC,MAAM,CAAC,kBAAkB,CAAC,KAAK,KAAK;QAC/C,oBAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE,MAAM,KAAK,CAAC,EACjD,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA;QACvC,oBAAU,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;QAClC,MAAM,gBAAM,CAAC,IAAI,CAAC,UAAU,EAAE;YAC5B,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,kBAAkB;SACxB,CAAC,CAAA;QACF,MAAM,gBAAM,CAAC,IAAI,CAAC,MAAM,EAAE;YACxB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,EAAE,kBAAkB;SACxB,CAAC,CAAA;QACF,MAAM,IAAA,gBAAM,EAAC,6BAAiB,EAAE,gBAAgB,kBAAkB,SAAS,CAAC,CAAA;QAC5E,OAAO,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC;IAED,OAAO,CAAC,OAAO,CAAC;;;;GAIf,CAAC,CAAA;AACJ,CAAC"}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Usage with TypeScript
|
|
3
|
+
description: Initialize a new project with TypeScript and start to interact with some hardware!
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import { Aside } from '@astrojs/starlight/components'
|
|
7
|
+
|
|
8
|
+
Using [TypeScript](https://www.typescriptlang.org/) is an industry standard in 2024. It provides a lot of benefits over JavaScript, such as static type checking, better code completion, and improved code readability. This guide will show you how to use TypeScript with the Moddable SDK.
|
|
9
|
+
|
|
10
|
+
# Prerequisites
|
|
11
|
+
|
|
12
|
+
There are various ways to start a new project with TypeScript. There are also many way to do it using the Moddable SDK. The following guide is opinionated and will use a specific setup. You can adapt it to your needs. But this looks like a good starting point close to the web development environment.
|
|
13
|
+
|
|
14
|
+
In the following statement of this guide we will use [pnpm](https://pnpm.io/installation) as our package manager. You can use any other while this is recommended. Adapt your commands accordingly if so.
|
|
15
|
+
|
|
16
|
+
## Let's get started
|
|
17
|
+
|
|
18
|
+
This starter project aim to build a single JS file that will be passed to XS. This helps developers coming from the web to have a more familiar environment and also to have a better development experience.
|
|
19
|
+
|
|
20
|
+
For this purpose, we will use a bundler tool which is very popular in the JavaScript community, especially in the web development where you want to reduce the number of network request and optimize the JS bundle from the server. There are many tools available to help you with this task. Tools like Webpack, Rollup, and esbuild are popular choices for bundling JavaScript code.
|
|
21
|
+
For this guide, as the bundler we will use [Bun](https://bun.sh/), which is a JavaScript Environment, but also a bundler/transpiler. It is a very simple tool that allows you to write your code in TypeScript and bundle it into a single file. If you use [mise-en-place](https://mise.jdx.dev/getting-started.html), you can install it with the following command:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
mise install bun
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Otherwise follow the instructions on the [Bun website](https://bun.sh/).
|
|
28
|
+
|
|
29
|
+
Now we will use a [starter template](https://github.com/ScreamZ/xs-dev-Typescript-template) that has setup everything for us upfront.
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
bunx tiged ScreamZ/xs-dev-TypeScript-template ts-xs-project
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
<Aside>
|
|
36
|
+
`tiged` is the CLI that wraps around git clone, while `bunx` allows for
|
|
37
|
+
running package commands without globally installing said package (similar to
|
|
38
|
+
npx, pnpx, and yarn dlx). This is useful when you want to start a new project
|
|
39
|
+
from a template.
|
|
40
|
+
</Aside>
|
|
41
|
+
|
|
42
|
+
## Specializing the starter template for your project
|
|
43
|
+
|
|
44
|
+
The first thing you need to do is to update the `package.json` file with your project details. You can do this by following those instructions:
|
|
45
|
+
|
|
46
|
+
1. Update `name` property with your project name.
|
|
47
|
+
2. Update `author` property with your name.
|
|
48
|
+
3. Follow the remaining instruction on the GitHub [https://github.com/ScreamZ/xs-dev-Typescript-template](https://github.com/ScreamZ/xs-dev-Typescript-template)
|
|
49
|
+
|
|
50
|
+
## How does it work?
|
|
51
|
+
|
|
52
|
+
The template is a simple project that uses Bun to bundle the TypeScript code into a single file. The TypeScript code is located in the `src` folder, and the bundled code is located in the `dist` folder.
|
|
53
|
+
|
|
54
|
+
The starter exposes a `pnpm dev` command that watch for changes in the `src` folder and automatically recompile the code. This is very useful when you are developing your project. You should keep this command running in a terminal window while you are working on your project.
|
|
55
|
+
|
|
56
|
+
When you need to try the code, simply run `xs-dev run` in the terminal. This will upload the bundled code from `dist/main.js` to the device and run it. The rest remains the same as the standard xs-dev workflow.
|
|
57
|
+
|
|
58
|
+
Take note that whenever you import some code from the Moddable SDK, you will need to add the following line in the `tsconfig.json` file:
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
"types": [
|
|
62
|
+
// ... Previous lines
|
|
63
|
+
"./node_modules/@moddable/typings/<path-to-the-file>"
|
|
64
|
+
]
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Those typings are provided by [`@moddable/typings` package](https://github.com/Moddable-OpenSource/moddable/tree/4142d4d353960ea7ede15d56864d841de692a68d/typings), and while at the moment this is a bit cumbersome, it's up to you to find the correct definition file for the module you are using.
|
|
68
|
+
|
|
69
|
+
As an example, the Timer and WiFi modules live in `./node_modules/@moddable/typings/wifi` and `./node_modules/@moddable/typings/timer`
|
|
70
|
+
|
|
71
|
+
The team is actively working on improving the development workflow.
|
|
72
|
+
|
|
73
|
+
<Aside>
|
|
74
|
+
As modules from the Moddable SDK are not available inside node_modules and
|
|
75
|
+
injected on build, the bundler do not bundle them thanks to the `--packages
|
|
76
|
+
external` argument.
|
|
77
|
+
</Aside>
|
|
78
|
+
|
|
79
|
+
# Deploying to production
|
|
80
|
+
|
|
81
|
+
When you are ready to deploy your project to production, you can run the following command:
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
pnpm run build:release
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
This will bundle the TypeScript code into a single file and minify it (compress into a single line of code and compress variables names). The bundled code will be located in the `dist` folder. You can then upload this code to your device following the [standard xs-dev workflow](/features/run#building-projects-for-release).
|
|
88
|
+
|
|
89
|
+
As an example to build for an ESP32 device:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
xs-dev build --device esp32
|
|
93
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "xs-dev",
|
|
3
|
-
"version": "0.33.
|
|
3
|
+
"version": "0.33.2",
|
|
4
4
|
"description": "CLI for automating the setup and usage of Moddable XS tools",
|
|
5
5
|
"types": "build/types/types.d.ts",
|
|
6
6
|
"engines": {
|
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
"@types/unzip-stream": "^0.3.1",
|
|
76
76
|
"@typescript-eslint/eslint-plugin": "^8.1.0",
|
|
77
77
|
"@typescript-eslint/parser": "^8.1.0",
|
|
78
|
+
"all-contributors-cli": "^6.26.1",
|
|
78
79
|
"astro": "4.13.3",
|
|
79
80
|
"auto": "^11.2.1",
|
|
80
81
|
"eslint": "^8.57.0",
|