Wollok-TS

TypeScript based Wollok language implementation

Usage

For an in-dept explanation of the API and how to use it please refer to the documentation page.

Contributing

All contributions are welcome! Feel free to report issues on the project's issue tracker, or fork the project and create a Pull Request. If you've never collaborated with an open source project before, you might want to read this guide.

If you plan to contribute with code, here are some hints to help you start:

Working Environment

Before anything else, you will need a TypeScript editor. We recomend Visual Studio Code along with the following plugins:

• TSLint
• TypeScript Importer
• Move TS
• Wollok Highlight

Node

You need to install node > 11, which provides VM environment, and nvm - Node Version Manager. Before anything make sure you'll use the right version of node by running this command:

nvm use

Expected output is the node version that will be used, for example:

Found '/home/dodain/workspace/wollok-dev/wollok-ts/.nvmrc' with version <v11.15.0>
Now using node v11.15.0 (npm v6.7.0)

NPM

You will also need to install NPM. (Node.js version 8 or greater) If you are not familiar with dependency manager tools, you can think of this program as the entry point for all the important tasks development-related tasks, like installing dependencies and running tests. After installing the client, go to the project root folder and run:

# This will install all the project dependencies. Give it some time.
npm install

After that, you are ready to start working. You can run the tests and style checks by typing:

# This will run tests for all the modules. Try to do this often and avoid commiting changes if any test fails.
npm test

A full list of the available scripts is listed on the package.json file, on the root folder.

File Description

[[TODO]]: Describe what is each file

• src/model.ts: It has all the type declarations of the nodes in each stage.
• src/parser.ts: Parsing stage functions.
• src/filler.ts: Filling stage functions.
• src/log.ts and src/cache.ts: logging and optimization.
• src/tools.ts: Utils for managing the tree structure.

Dependencies

[[TODO]]: Describe what we are usinng, give links, and explain what docs to read based on what you will be touching.