Tools

Everything you need to write, run, format and ship Salam programs lives in one command and a handful of editor plugins.

Online editor

The Salam compiler is compiled to WebAssembly and runs entirely in your browser. Write code, run it and browse the examples with nothing installed.

Open the editor

VS Code plugin

Highlighting for English and Persian code, plus errors as you type, completion, hover, go to definition, rename and formatting through the Salam language server, directly in Visual Studio Code.

Install from the VS Code marketplace

Code translator

Turn an English program into a Persian one or the other way round. Keywords, types and the entry point are rewritten for you.

salam translate fa program.salam

The salam command

The compiler, runner, formatter and documentation generator are all subcommands of one executable. The ones you will use most:

Command What it does
salam check app.salamFind errors fast: everything salam build does before code generation, imported packages included, with exit code 1 when any are printed. Errors from code generation, the C compiler or the linker still need a build
salam check app.salam --fixApply the safe fixes the compiler suggests (missing or unused imports, a needless mut, return written for ret, a misspelled name with exactly one close match) in place, then check again; a fix with more than one possible answer stays a suggestion
salam add github.com/owner/repoAdd a package to the project; the package manager also covers remove, update, search and publishing your own
salam testRun the test_ functions in every *_test.salam file, each file in its own process
salam run app.salamCompile and run, without keeping the executable
salam exec app.salamRun on the interpreter, with no C compiler needed
salam build app.salamBuild a native executable; add --target to cross compile
salam build app.salam --backend=nativeBuild with Salam's own x86-64 code generator, with no C compiler or LLVM involved
salam new myappCreate a new project directory, with --lang=fa for a Persian one
salam format .Format every Salam file in the directory
salam docGenerate API documentation as an HTML page
salam lspThe language server editors talk to for errors, completion and navigation as you type
salam serveServe a folder over HTTP, or with --config=FILE run several sites from one config file (virtual hosts, redirects, caching, PHP); --test only checks the file
salam sql check src --schema=migrationsCheck every SQL query against the schema, without a database
salam sql generate q --schema=dbGenerate typed query functions from annotated SQL files
salam web page.salamBuild a web page from the layout language and Salam scripts
salam js app.salamCompile to JavaScript to run in the browser
salam cliAn interactive prompt for trying out snippets
salam debug app.salamBuild with debug information and open the debugger

Editors

The Salam plugins highlight both the English and the Persian keyword set, and their word lists are generated from the compiler's own tables. Editors with a language server client, among them VS Code, Neovim, Emacs, Sublime Text, Kate and the JetBrains IDEs, also get errors, completion and navigation as you type from salam lsp, the language server built into the compiler.

  • VS Code
  • Vim and Neovim
  • Sublime Text
  • Emacs
  • JetBrains
  • Kate and KDevelop
  • Geany
  • gedit and GNOME
  • Notepad++
  • GNU nano
  • micro

Standard library

More than 170 packages ship with the language, and every one of them has a Persian name too. A sample:

  • Strings and Unicode
  • Files and directories
  • JSON, XML, YAML, TOML and CSV
  • HTTP, TLS and SSH
  • Cryptography and JWT
  • Databases
  • Time and calendars
  • Regular expressions
  • Images and OpenCV
  • Tensors, machine learning and ONNX
  • Concurrency and channels
  • Testing