Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slye3d/esy-language
Esy is a new JS preprocessor allows you to use custom block structures.
https://github.com/slye3d/esy-language
blocks code-structure compiler esy javascript language preprocessor slye
Last synced: about 1 month ago
JSON representation
Esy is a new JS preprocessor allows you to use custom block structures.
- Host: GitHub
- URL: https://github.com/slye3d/esy-language
- Owner: Slye3D
- License: mit
- Created: 2017-06-12T13:59:24.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-06T13:24:17.000Z (over 7 years ago)
- Last Synced: 2024-10-16T20:01:42.299Z (2 months ago)
- Topics: blocks, code-structure, compiler, esy, javascript, language, preprocessor, slye
- Language: JavaScript
- Homepage:
- Size: 261 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Esy
[](https://npmjs.org/package/esy-language)
[](https://circleci.com/gh/Slye-team/esy-language/tree/master)
[](https://badge.fury.io/js/esy-language)
[](https://www.npmjs.com/package/badges)
[](https://www.npmjs.com/package/badges)
[](./LICENSE)
[](https://gitter.im/Slye-team/esy-language?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Esy is a new JS preprocessor allows you to use custom block structures.
# What does it mean?
Right now in JavaScript and many other languages that support the [block structure](https://en.wikipedia.org/wiki/Scope_(computer_science)#Block_scope), you're only able to use some predefined structures like:
1. if (){...}
2. for (){...}
3. while (){...}
4. do {...} while();
5. switch (){...}
6. else {...}
7. try {...}
8. catch (){...}
9. finally (){...}
10. etc...
Those are all familiar structures to you, but have you ever thought about the following structure?
```esy
timeout 200 {
console.log("Hello World!");
}
```
Certainly, it's easier than what we have in `JS` right now:
```js
setTimeout(function() {
console.log("Hello World!");
}, 200);
```
Or even with `arrow functions`:
```js
setTimeout(() => {
console.log("Hello World!");
}, 200);
```
That why `Esy` comes from `Easy`
# Install
You can install this package globally by running:
```bash
npm install esy-language -g
```
but if you're interested in the core API and wants to use it in your own package just run:
```bash
npm install esy-language --save
```
# Example
After installing the `Esy`, save this file as `ex.esy`
```esy
// Cache sum for 500ms
cache 500 sum(a,b){
console.log('Computing...');
return a+b;
} key (c,d){
// We don't care about numbers order in sum function (a+b=b+a)
return [c, d].sort();
}
// Compute 5+7 once
console.log(sum(5,7))
// Load theme from cache without computing
console.log(sum(5,7))
console.log(sum(7,5))
// Wait 100ms more than cache's lifetime.
timeout 600{
// It should compute 5+7 again
console.log(sum(7,5))
}
```
and then cd to the directory that your file is and run this command to run program:
```
esy ex.esy
```
for saving result to a file run:
```
esy compile ex.esy -s
```
# Docs
Read [official docs](https://github.com/Slye-team/esy-language/tree/master/docs) for more details.
# Testing
To run tests just run:
```bash
git clone https://github.com/Slye-team/esy-language.git
cd esy-language
npm run test
```