3b4afc0346
|
||
|---|---|---|
| .. | ||
| cmd | ||
| lib | ||
| tests | ||
| .gitignore | ||
| Makefile | ||
| README.md | ||
| lumijs | ||
| package.json | ||
| tsconfig.json | ||
| tslint.json | ||
| yarn.lock | ||
README.md
LumiJS
This directory contains Lumi's JavaScript compiler.
It implements a subset of JavaScript, with optional TypeScript-style type annotations, and compiles that subset into LumiPack/IL.
Building and Testing
LumiJS is built independent from the overall Lumi toolchain. First clone and cd to the right place:
$ git clone git@github.com:pulumi/lumi
$ cd lumi/cmd/lumijs
Next, install dependencies, ideally using Yarn:
$ yarn install
(NPM can be used instead, but Yarn offers better performance, reliability, and security, so it's what we use below.)
From there, to build:
$ yarn run build
It's possible to simply run the TypeScript compiler using tsc, however the Yarn build step performs a couple extra
steps; namely, it runs TSLint and also copies some test baseline files into the right place.
Next, to test, simply run:
$ yarn run test
It will be obvious if the tests passed or failed and, afterwards, code coverage data will be output to the console.
After building, a typical developer setup would be to add cmd/lumijs/ to your $PATH; there is a lumijs
executable in the root directory that conveniently wraps invocation of the compiler, passing through any arguments.
Libraries
In order to use the Lumi libraries -- including the standard library -- you will need to do a few additional steps to prepare your developer workspace. Please see this document for details on how to do this.