Thanks to visit codestin.com
Credit goes to github.com

Skip to content

guillep/wollok-ts

 
 

Repository files navigation

Wollok-TS Build Status

TypeScript based Wollok language implementation

Usage

[[TODO]]

  • modules description
  • examples

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:

You might also want to copy the following configurations to your user settings (ctrl+,):

  "window.menuBarVisibility": "default",
  "workbench.activityBar.visible": false,
  "workbench.startupEditor": "none",
  "explorer.openEditors.visible": 0,
  "files.exclude": {
    "dist": true,
    ".vscode": true,
    "node_modules": true,
  },
  "git.enabled": false,
  "editor.tabSize": 2,
  "explorer.autoReveal": true,
  "editor.formatOnSave": true,
  "tslint.autoFixOnSave": true,
  "tslint.alwaysShowStatus": true,
  "workbench.statusBar.feedback.visible": false,
  "window.zoomLevel": 0,
  "workbench.colorTheme": "Visual Studio Dark",
  "typescript.updateImportsOnFileMove.enabled": "always",
  "editor.foldingStrategy": "indentation",

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. 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

Dependencies

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

About

TypeScript based Wollok language implementation

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.3%
  • Wollok 0.7%