History

qucchia aee02b93e3 TypeScript: Add JSDoc comments		2022-07-22 11:27:08 +02:00
..
types	TypeScript: Add JSDoc comments	2022-07-22 11:27:08 +02:00
.gitignore	move package back within typescript	2021-12-10 20:52:17 +01:00
README.md	Update types from new script	2022-07-21 12:30:15 +02:00
package-lock.json	Start auto-generating types	2022-07-20 15:07:21 +02:00
package.json	TypeScript: remove build:types	2022-07-22 09:59:16 +02:00
tsconfig.json	Include all types, overriding JS defaults	2022-07-22 08:21:47 +02:00

README.md

Bangle.ts

A generic project setup for compiling apps from Typescript to Bangle.js ready, readable JavaScript. The types are now automatically generated by a script (see below), although they are still a work-in-progress.

Compilation

Install npm and node.js if you haven't already. We recommend using a version manager like nvm, which is also referenced in the linked documentation. Make sure you are using node version 16 by running nvm use 16 and npm version ^8 by running npm -v. If the latter version is incorrect, run npm i -g npm@^8.

After having installed npm for your platform, open a terminal, and navigate into the /typescript folder. Then run:

npm ci

to install the project's build tools, and:

npm run build

To build all Typescript apps and widgets. The last command will generate the app.js files containing the transpiled code for the Bangle.js.

Generating types

To generate the types, ensure this repository and Espruino are in the same folder. From the Espruino folder run:

node scripts/build_types.js

This will update the file in types/main.d.ts.