-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into POC-unicode-identifiers
- Loading branch information
Showing
31 changed files
with
1,765 additions
and
372 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,9 +12,9 @@ jobs: | |
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: webfactory/[email protected] | ||
with: | ||
ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }} | ||
# - uses: webfactory/[email protected] | ||
# with: | ||
# ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }} | ||
- name: Read .nvmrc | ||
run: echo "##[set-output name=NVMRC;]$(cat .nvmrc)" | ||
id: nvm | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,20 @@ | ||
# Wollok-TS [![npm version](https://badge.fury.io/js/wollok-ts.svg)](https://badge.fury.io/js/wollok-ts) [![codecov](https://codecov.io/gh/uqbar-project/wollok-ts/graph/badge.svg?token=4U99G67xRT)](https://codecov.io/gh/uqbar-project/wollok-ts) | ||
# Wollok-TS | ||
|
||
[![npm version](https://badge.fury.io/js/wollok-ts.svg)](https://badge.fury.io/js/wollok-ts) [![Node.js CI](https://github.com/uqbar-project/wollok-ts/actions/workflows/node.js.yml/badge.svg)](https://github.com/uqbar-project/wollok-ts/actions/workflows/node.js.yml) [![codecov](https://codecov.io/gh/uqbar-project/wollok-ts/graph/badge.svg?token=4U99G67xRT)](https://codecov.io/gh/uqbar-project/wollok-ts) ![GitHub License](https://img.shields.io/github/license/uqbar-project/wollok-ts) | ||
|
||
|
||
TypeScript based Wollok language implementation | ||
|
||
## Usage | ||
## 📖 Usage | ||
|
||
For an in-dept explanation of the API and how to use it please refer to [the documentation page](https://uqbar-project.github.io/wollok-ts/). | ||
|
||
|
||
## Contributing | ||
## 👩💻 Contributing | ||
|
||
All contributions are welcome! Feel free to report issues on [the project's issue tracker](https://github.com/uqbar-project/wollok-ts/issues), or fork the project and [create a *Pull Request*](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). If you've never collaborated with an open source project before, you might want to read [this guide](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/). | ||
|
||
All contributions are welcome! Feel free to report issues on [the project's issue tracker](https://github.com/uqbar-project/wollok-ts/issues), or fork the project and [create a *Pull Request*](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). If you've never collaborated with an open source project before, you might want to read [this guide](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/). | ||
If you plan to contribute with code, please refer to [this page](https://uqbar-project.github.io/wollok-ts/pages/How-To-Contribute/). There is a list of [good first issues](https://github.com/uqbar-project/wollok-ts/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), if you have any question please reach out us [in our Discord channel](https://discord.gg/ZstgCPKEaa). | ||
|
||
If you plan to contribute with code, please refer to [this page](https://uqbar-project.github.io/wollok-ts/pages/How-To-Contribute/). | ||
**Powered by [Uqbar](https://uqbar.org/)** | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
|
||
## Base environment | ||
|
||
Please take a look at [the developer environment page](./Developer-environment.md) in order to install all required components. | ||
|
||
## Testing | ||
|
||
We use [BDD chai unit testing style](https://www.chaijs.com/api/bdd/), in particular | ||
|
||
- [should](http://shouldjs.github.io/) | ||
- expect | ||
|
||
They are located in `test` folder. | ||
|
||
You can run all the project tests from the console by executing: | ||
|
||
```bash | ||
npm test | ||
``` | ||
|
||
We also have specific tests for each component of Wollok-TS: | ||
|
||
```bash | ||
npm run test:dynamicDiagram | ||
npm run test:validations | ||
... | ||
``` | ||
|
||
Please refer to the `package.json` file or just run `npm run` command to see a list of alternatives. | ||
|
||
## Debugging | ||
|
||
The folder `.vscode` has a `launch.json` file which configures everything for running tests in an embedded VSCode environment. You can set a breakpoint and run the tests: | ||
|
||
![ezgif com-video-to-gif](https://user-images.githubusercontent.com/4549002/71355164-00925e00-255d-11ea-9a83-c37f420d4e61.gif) | ||
|
||
More on debugging: | ||
|
||
- [Debugging in Visual Studio Code](https://code.visualstudio.com/docs/editor/debugging) | ||
- [Debugging Typescript in VS Code](https://code.visualstudio.com/docs/typescript/typescript-debugging) | ||
- [How to debug Typescript in VS Code](https://medium.com/@PhilippKief/how-to-debug-typescript-with-vs-code-9cec93b4ae56) | ||
|
||
### Debugging a single test | ||
|
||
You can use **Test Explorer with Mocha**, if you follow current instructions and install plugins Test Explorer and Mocha Test Explorer. Then, you can go to the Test Explorer tab and run/debug a single test from the left sidebar: | ||
|
||
![debuggingWollokTs2](https://user-images.githubusercontent.com/4549002/71355441-cd040380-255d-11ea-82b6-1cb7c19c1c7a.gif) | ||
|
||
Or, if you prefer using the console: | ||
|
||
```bash | ||
npm run test:unit -- -f <test> | ||
``` | ||
|
||
### Building it locally | ||
|
||
If you are developing a dependency of Wollok-TS (for instance Wollok-TS CLI or Wollok Web Tools), you might need to run a local build. To do so, just run: | ||
|
||
```bash | ||
npm run build | ||
``` | ||
|
||
### We, the People | ||
|
||
If you need some human interaction, you're always welcome at [our Discord channel](https://discord.gg/ZstgCPKEaa). We also have [a list of first good issues](https://github.com/uqbar-project/wollok-ts/labels/good%20first%20issue) you can take a look and ask for help to get more information. | ||
|
||
### Deploying / Publishing | ||
|
||
If you need to deploy or publish a new version, please refer to [this page](../Publish-Instructions.md) | ||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.