https://github.com/williams-cs/swell

Swell Williams Entry-Level Language
https://github.com/williams-cs/swell

Last synced: about 2 months ago
JSON representation

Swell Williams Entry-Level Language

• Host: GitHub
• URL: https://github.com/williams-cs/swell
• Owner: williams-cs
• License: bsd-3-clause
• Created: 2018-06-15T16:54:27.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-01-27T15:12:20.000Z (about 3 years ago)
• Last Synced: 2024-11-05T19:06:03.383Z (3 months ago)
• Language: HTML
• Homepage:
• Size: 11.7 MB
• Stars: 3
• Watchers: 5
• Forks: 0
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[Link to documentation](https://williams-cs.github.io/swell/)

## About

This repository hosts both the language components for the SWELL language as well as the SWELL integrated development environment with prodirect manipulation features.

## Building

Type `make` in the terminal and hit enter. `make` will, if necessary, install the npm modules, remove the compiled files, recompile, and generate documentation.

`make clean` will remove all the compiled files, documentation, and npm modules. If you're having any sort of issues, run this and then `make`. 

After building, you can open `index.html` in your web browser.

If you're still having issues and you're using VSC, close VSC, `make clean`, then `make`. 

If you're still having issues, Google.

## Testing

`make test` will compile and run all tests. Currently, two tests (both called *A draw test should evaluate to an error*) should evaluate to errors. All others should pass.

Note that module and UI tests must be written in the UI test folder. The UI can be tested manually or with Selenium Webdriver. To use the debugger, Webdriver is best... if you can get it to work.

## Contributing to SWELL

Please [read the following instructions](https://github.com/williams-cs/swell/blob/master/tutorials/editdemo.md) for submitting changes to SWELL.  It is _very important_ that you not commit breaking changes to the `master` branch!

## SWELL syntax

We have an [informal syntax specification here](https://github.com/williams-cs/swell/blob/master/tutorials/swell-cheatsheet.md).  Please update this document if you add or modify syntax.

## Modules

**How to Build a Module**

1. Come up with a goal: draw a circle, write text, make a scene, etc, and a clever name for the module.

2. Figure out how to check if these goals are complete. This will be the `checkGoal()` method in the module. 

  * Since there's no way to check what is on the canvas, this will mainly involve regex parsing of the input text, which you can read from the 'input' element of the document.

  * You will likely have multiple components to check; each of these will be their own goal boolean

  * `checkGoal()` should be run when the Run button is pressed, but you may need to incorporate a delay, since for the Circle module it verifies it when the button is hit but before it actually paints anything.

3. Develop instructions and/or starter code.

  * Currently this shows up in a prompt at the beginning of the module, but if you decide to include starter code you may want to work out how to put it somewhere in the UI so the students can reference it... or print it directly in the input space!

4. `checkGoal()` is the bulk of the module, but you may want additional helper methods based on how complicated the goal is to check. [CircleMod](./lib/modules/CircleMod.ts) can provide a good reference for a basic goal check.