Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redstonewizard08/quickscript
A quick programming language with a compiler implemented in Rust.
https://github.com/redstonewizard08/quickscript
aot clap communityexchange compiler cranelift crates ghdesktop github github-codespaces github-copilot jit language learn pest quickscript rust
Last synced: 2 months ago
JSON representation
A quick programming language with a compiler implemented in Rust.
- Host: GitHub
- URL: https://github.com/redstonewizard08/quickscript
- Owner: RedstoneWizard08
- License: mit
- Created: 2023-05-02T17:33:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-06T19:46:31.000Z (5 months ago)
- Last Synced: 2024-11-07T08:51:30.600Z (3 months ago)
- Topics: aot, clap, communityexchange, compiler, cranelift, crates, ghdesktop, github, github-codespaces, github-copilot, jit, language, learn, pest, quickscript, rust
- Language: Rust
- Homepage:
- Size: 814 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# qsc: The QuickScript compiler.
)
&color=red)
[](https://nightly.link/RedstoneWizard08/QuickScript/workflows/build/main/binaries)
QuickScript is a language that I am creating to learn how to, well, create a language.
The syntax is very similar to Rust, and it is a semicolon-based language, or at least it will be (I think). The compiler is written in Rust, and uses Cranelift as a backend, with AOT and JIT modes supported, and allows any `libc` function to be called in code. The standard library is pretty nonexistent right now, but it'll get better in the future.
This can also serve as a way to learn how to create your own language with Rust.
## License
This project is licensed under the MIT license. Feel free to use the code for whatever you want.
## Installation
Installing QuickScript is incredibly easy!
Here's how you can do it:
**With Cargo:**
```sh
cargo install quickscript
```
**Via GitHub Releases:**
1. Head to https://github.com/RedstoneWizard08/QuickScript/releases
2. Download the correct binary for your platform
3. Run `chmod +x [path to binary here]`
4. Run the binary!
**Via GitHub Actions:**
1. Head to https://nightly.link/RedstoneWizard08/QuickScript/workflows/build/main/binaries
2. Download it
3. Run it!
## Usage
For usage details, run `qsc --help`
## Support
Currently, here is the support matrix:
| Version | i686 | x86_64 | armv7l | armhf | arm64 |
| ------- | ---- | ------ | ------ | ----- | ----- |
| 0.0.0 | 🔴 | 🔴 | 🔴 | 🔴 | 🟢 |
| 0.1.0 | 🔴 | 🟡 | 🔴 | 🔴 | 🟢 |
| 0.3.0 | 🟢 | 🟢 | 🔴 | 🔴 | 🟢 |
| 0.4.0 | 🟢 | 🟢 | 🔴 | 🔴 | 🟢 |
| 0.5.x | 🟢 | 🟢 | 🔴 | 🔴 | 🟢 |
| 0.6.x | 🟢 | 🟢 | 🔴 | 🔴 | 🟢 |
Note that armv7l and armhf support are dependent on Cranelift's support for it.
See [cranelift#1173](https://github.com/bytecodealliance/wasmtime/issues/1173)
for more details.
Musl builds for i686 are also not supported due to a bug in `cargo-zigbuild`.
See [cargo-zigbuild#96](https://github.com/rust-cross/cargo-zigbuild/issues/96)
for more details.
# Credits
Huge thanks to [Pixeled (@orosmatthew)](https://github.com/orosmatthew) and his
[Creating a Compiler](https://www.youtube.com/playlist?list=PLUDlas_Zy_qC7c5tCgTMYq2idyyT241qs)
series, as it helped me think about how to do this best and it gave me the
inspiration for this project.
Another huge thanks for the [cranelift-jit-demo](https://github.com/bytecodealliance/cranelift-jit-demo), as it helped me implement the code generator with Cranelift.
Massive thank you to [@cfallin](https://github.com/cfallin) and [@bjorn3](https://github.com/bjorn3) for helping me learn how to use Cranelift properly and help me fix some critical issues.
# Roadmap
Future plans for QuickScript:
- Add AST validation and errors
- Add `if` statements, `while` and `for` loops, function definitions as variables, constant (or static) variables, and more.
- Create a language server and syntax for VS Code.
- Port the [mold](https://github.com/rui314/mold) linker to Rust and use it internally (programmatically) instead of using an external command call.