Getting Started

This section will help you get the ArcScript transpiler up and running.

Installation

ArcScript is a Python script that uses the lark library for parsing.

1. Ensure you have Python 3 and PIP installed.

2. Install ArcScript using pip:

   pip install arcscript
   

3. Alternatively, you can clone the repository and install the dependencies:

   git clone https://github.com/aditya-tiwari108/ArcScript
   pip install -r requirements.txt
   

Usage

To transpile an ArcScript file (e.g., input.arc) to JavaScript (e.g., output.js), run the script from your terminal

If you have install the package using pip

arcscript input.arc output.js

If you have cloned repo locally and are in the root directory of the repo:

python main.py input.arc output.js

This will generate an output.js file containing the transpiled JavaScript code.

File Modes

ArcScript supports two modes of operation for flexibility.

Pure ArcScript Mode

If your file contains only ArcScript code, the transpiler will convert the entire file. This is the default and most common way to use ArcScript.

Example ``app.arc``:

print("Hello from ArcScript!")

Mixed Code Mode

For situations where you need to include raw JavaScript alongside ArcScript, you can use special headers.

• [JS]: Any code written below this header will be treated as raw JavaScript and will be prepended to the final output file as-is.

• [ARC]: Code below this header will be treated as ArcScript and transpiled.

This is useful for including libraries or writing complex JavaScript functions that are not yet supported by ArcScript.

Example ``app.arc``:

[JS]
// This is raw JavaScript
function showAlert(message) {
  alert(message);
}

[ARC]
# This is ArcScript
print("This message is from the console.")

Resulting ``app.js``:

// This is raw JavaScript
function showAlert(message) {
  alert(message);
}

console.log("This message is from the console.");