This is the official BluePrint Compiler (bpc) It can be used to compile the BluePrint lisp flavour to javascript https://blueprint.ccw.icu/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3.4 KiB

BluePrint

BluePrint Logo

SchemeScript is now called BluePrint, no need to worry though - it only changed its name.

The official BluePrint Git Repository is hosted on codeberg.org, but it is also mirrored to GitLab and GitHub.

Github Pages is used to host the official Webpage.

About

Being inspired to write my own programming language converter/compiler, after watching retroedge.techs video about fennel, I decided that I wanted to write a program to compile a lisp flavour to javascript.

Use Cases

Technically you could use BluePrint to write your code, anywhere, where you would normally write javascript code.

Note that most BluePrint features have not been implemented at this point, thus making production use impossible.

Features

  • nearly full Javascript Compatibility: You should be able to generate all the required javascript code from your BluePrint code
  • Zero dependencies: As your BluePrint code has to be converted to javascript before exeecution, exeecuting the javascript code no longer requires BluePrint to be installed (Note that some platforms might require additional tooling to execute javascript files)
  • Write your own: Unsatisfied by the default BluePrint commandset? - just use the library in your own project and add your own commands, keywords and macros!

Gettting Started

Requirements

  • Rustc, Cargo
  • Git

Installation

NOTE: At this point there are no prebuild binaries available.

To install the BluePrint Compiler (bps) you have to download or clone the git repository, on Linux this can be achived by running the following command: git clone https://codeberg.org/comcloudway/blueprint

(NOTE: Some distros don't ship with git installed by default, so you have to install it yourself)

After successfully cloning the sources, it is time to build the bps binary.

This is as simple as running cargo build --release.

Your basically good to go now and your binary can be found in the newly created ./target/ folder, but the bps command is not available system-wide yet.

To achive this you have to put the file in your $PATH.

Assuming that you have added ~/.local/bin/ to your path, the command could look something like this: ln $PWD/target/release/blueprint ~/.local/bin/bps

Now you should be able to run bps an get an errror message, explaining you that you are missing some arguments.

The next chapter is going to focus on the basic usage of the command line utility

Using the BluePrint Compiler


BluePrint Language Documentation

Most BluePrint commands are either inspired by javascript or one of thousands of lisp flavours.

The following article will focus on non-standard implementations.

API Documentation

The rust code is documented using rustdoc and a partially up-to-date version of the generated documentation can be found in the doc/ folder.

The hosted Version can be found hosted on Github Pages