Add Rust language support

README.md

@@ -13,7 +13,7 @@ A [feature-rich](https://livecodes.io/docs/features/), open-source, **client-sid
 [![LiveCodes: npm version](https://img.shields.io/npm/v/livecodes)](https://www.npmjs.com/package/livecodes)
 [![LiveCodes: npm downloads](https://img.shields.io/npm/dm/livecodes)](https://www.npmjs.com/package/livecodes)
 [![LiveCodes: jsdelivr downloads](https://data.jsdelivr.com/v1/package/npm/livecodes/badge?style=rounded)](https://www.jsdelivr.com/package/npm/livecodes)
-[![LiveCodes: languages](https://img.shields.io/badge/languages-101-blue)](https://livecodes.io/docs/languages/)
+[![LiveCodes: languages](https://img.shields.io/badge/languages-102-blue)](https://livecodes.io/docs/languages/)
 [![LiveCodes: docs](https://img.shields.io/badge/Documentation-575757?logo=gitbook&logoColor=white)](https://livecodes.io/docs/)
 [![LiveCodes: llms.txt](https://img.shields.io/badge/llms.txt-575757?logo=googledocs&logoColor=white)](https://livecodes.io/docs/llms.txt)
 [![LiveCodes: llms-full.txt](https://img.shields.io/badge/llms--full.txt-575757?logo=googledocs&logoColor=white)](https://livecodes.io/docs/llms-full.txt)

docs/docs/languages/rust-wasm.mdx

@@ -0,0 +1,101 @@
+# Rust (Wasm)
+
+Rust is a general-purpose programming language designed for performance and safety.
+
+In LiveCodes, Rust runs in the browser by interpreting the source with [Miri](https://github.com/rust-lang/miri)
+(the Rust mid-level IR interpreter) compiled to WebAssembly. No backend is involved.
+
+## Usage
+
+Demo:
+
+import LiveCodes from '../../src/components/LiveCodes.tsx';
+export const rustConfig = {
+  activeEditor: 'script',
+  script: {
+    language: 'rust-wasm',
+    content: `use std::collections::HashMap;\n
+fn main() {
+    let text = "the quick brown fox jumps over the lazy dog";\n
+    let mut counts: HashMap<&str, u32> = HashMap::new();
+    for word in text.split_whitespace() {
+        *counts.entry(word).or_insert(0) += 1;
+    }\n
+    let mut words: Vec<(&str, u32)> = counts.into_iter().collect();
+    words.sort_by(|a, b| b.1.cmp(&a.1).then(a.0.cmp(b.0)));\n
+    for (word, count) in &words {
+        println!("{word:<6} {count}");
+    }
+}`,
+  },
+  mode: 'simple',
+  editor: 'auto',
+  tools: {
+    status: 'full',
+  },
+};
+
+<LiveCodes config={rustConfig}></LiveCodes>
+
+### Communication with JavaScript
+
+The Rust code runs in the context of the result page. A few helper properties and methods are available in the browser global `livecodes.rust` object:
+
+- `livecodes.rust.input`: The standard input passed to the Rust program. It can be set before the initial run, or passed to `run` for subsequent runs.
+- `livecodes.rust.loaded`: A promise that resolves when the Rust environment (WebAssembly interpreter and standard library) is fully loaded (and rejects if it fails to load). Other helpers should be used after this promise resolves.
+- `livecodes.rust.output`: The standard output from the Rust code execution.
+- `livecodes.rust.exitCode`: The exit code of the last run.
+- `livecodes.rust.run`: A function that runs the Rust code again with new input. It takes a string as input and returns a promise that resolves with an object containing the `output`, `error`, and `exitCode` properties.
+
+Example:
+
+<LiveCodes template="rust-wasm" params={{ activeEditor: 'markup' }} height="80vh"></LiveCodes>
+
+## Language Info
+
+### Name
+
+`rust-wasm`
+
+### Aliases / Extensions
+
+`rust`, `rs`, `rust-wasm`, `rs-wasm`, `wasm.rs`
+
+### Editor
+
+`script`
+
+## Compiler
+
+[Miri](https://github.com/rust-lang/miri), the Rust mid-level IR interpreter, compiled to WebAssembly.
+
+### Version
+
+Miri built against Rust 1.79 (2024-06-15).
+
+## Code Formatting
+
+Using [Prettier](https://prettier.io) with the [Prettier Rust plugin](https://github.com/live-codes/prettier-plugin-rust).
+
+## Limitations
+
+- Programs are single-file. Crates and external dependencies are not supported.
+- Execution is interpreted, so it is considerably slower than native Rust.
+- Threads (`std::thread`) are not supported.
+- Undefined-behaviour checks are disabled in this build, because a playground is interested in whether a program works rather than whether it is sound.
+
+## Live Reload
+
+By default, new code changes are sent to the result page for re-evaluation without a full page reload, avoiding the need to reinitialize the Rust WebAssembly environment. This behavior can be disabled by adding the code comment `// __livecodes_reload__` to the Rust code, which forces a full page reload.
+
+This comment can be added in the `hiddenContent` property of the editor for embedded playgrounds.
+
+## Starter Template
+
+https://livecodes.io/?template=rust-wasm
+
+## Links
+
+- [Rust](https://www.rust-lang.org/)
+- [The Rust Book](https://doc.rust-lang.org/book/)
+- [Miri](https://github.com/rust-lang/miri)

docs/src/components/LanguageSliders.tsx

@@ -88,6 +88,8 @@ export default function Sliders() {
       { name: 'php-wasm', title: 'PHP (Wasm)' },
       { name: 'cpp', title: 'C++' },
       { name: 'cpp-wasm', title: 'C++ (Wasm)' },
+      { name: 'rust-wasm', title: 'Rust (Wasm)' },
+      { name: 'zig-wasm', title: 'Zig (Wasm)' },
       { name: 'java', title: 'Java' },
       { name: 'csharp-wasm', title: 'C# (Wasm)' },
       { name: 'fsharp', title: 'F#' },
@@ -110,7 +112,6 @@ export default function Sliders() {
       { name: 'prolog', title: 'Prolog' },
       { name: 'minizinc', title: 'MiniZinc' },
       { name: 'blockly', title: 'Blockly' },
-      { name: 'zig-wasm', title: 'Zig (Wasm)' },
     ],
   };
   const slides = ['markup', 'style', 'script'];

docs/src/components/TemplateList.tsx

@@ -47,6 +47,8 @@ const templates = [
   { name: 'php-wasm', title: 'PHP (Wasm) Starter', thumbnail: 'php.svg' },
   { name: 'cpp', title: 'C++ Starter', thumbnail: 'cpp.svg' },
   { name: 'cpp-wasm', title: 'C++ (Wasm) Starter', thumbnail: 'cpp.svg' },
+  { name: 'rust-wasm', title: 'Rust (Wasm) Starter', thumbnail: 'rust.svg' },
+  { name: 'zig-wasm', title: 'Zig (Wasm) Starter', thumbnail: 'zig.svg' },
   { name: 'java', title: 'Java Starter', thumbnail: 'java.svg' },
   { name: 'csharp-wasm', title: 'C# (Wasm)', thumbnail: 'csharp.svg' },
   { name: 'fsharp', title: 'F# Starter', thumbnail: 'fsharp.svg' },
@@ -71,7 +73,6 @@ const templates = [
   { name: 'minizinc', title: 'MiniZinc Starter', thumbnail: 'minizinc.png' },
   { name: 'blockly', title: 'Blockly Starter', thumbnail: 'blockly.svg' },
   { name: 'diagrams', title: 'Diagrams Starter', thumbnail: 'diagrams.svg' },
-  { name: 'zig-wasm', title: 'Zig (Wasm) Starter', thumbnail: 'zig.svg' },
 ];
 
 export default function TemplateList() {

e2e/specs/starter.spec.ts

@@ -242,6 +242,34 @@ test.describe('Starter Templates from UI', () => {
     expect(counterText).toBe('You clicked 3 times.');
   });
 
+  test('rust-wasm Starter', async ({ page, getTestUrl, editor }) => {
+    // the interpreter and the stdlib sysroot are downloaded on the first run
+    test.setTimeout(300_000);
+
+    await page.goto(getTestUrl());
+
+    const { app, getResult, waitForResultUpdate } = await getLoadedApp(page);
+
+    await app.click('[aria-label="Project"]');
+    await app.click('text=New');
+    await app.click('text=Rust (Wasm) Starter');
+
+    await waitForEditorFocus(app);
+    await waitForResultUpdate();
+
+    // the counter stays disabled until the runtime has loaded and run once
+    await expect(getResult().locator('#counter-button')).toBeEnabled({ timeout: 280_000 });
+
+    await getResult().click('text=Click me');
+    await getResult().click('text=Click me');
+    await getResult().click('text=Click me');
+
+    await expect(getResult().locator('h1')).toHaveText('Hello, Rust!');
+    // Each click triggers an asynchronous run, so the counter is asserted with
+    // retries rather than read once.
+    await expect(getResult().locator('text=You clicked')).toHaveText('You clicked 3 times.');
+  });
+
   test('d3 Starter', async ({ page, getTestUrl, editor }) => {
     test.slow();
 

functions/vendors/templates.js

@@ -46,6 +46,7 @@ export const starterTemplates = {
   "php-wasm": "PHP (Wasm) Starter",
   "cpp": "C++ Starter",
   "cpp-wasm": "C++ (Wasm) Starter",
+  "rust-wasm": "Rust (Wasm) Starter",
   "zig-wasm": "Zig (Wasm) Starter",
   "java": "Java Starter",
   "csharp-wasm": "C# (Wasm) Starter",

scripts/build.js

@@ -257,6 +257,7 @@ const iifeBuild = () =>
       'languages/rescript/lang-rescript-formatter.ts',
       'languages/riot/lang-riot-compiler.ts',
       'languages/ruby-wasm/lang-ruby-wasm-script.ts',
+      'languages/rust-wasm/lang-rust-wasm-script.ts',
       'languages/scss/lang-scss-compiler.ts',
       'languages/solid/lang-solid-compiler.ts',
       'languages/sql/lang-sql-compiler.ts',

server/php/inc/starter-templates.json

@@ -46,6 +46,7 @@
   "php-wasm": "PHP (Wasm) Starter",
   "cpp": "C++ Starter",
   "cpp-wasm": "C++ (Wasm) Starter",
+  "rust-wasm": "Rust (Wasm) Starter",
   "zig-wasm": "Zig (Wasm) Starter",
   "java": "Java Starter",
   "csharp-wasm": "C# (Wasm) Starter",

src/livecodes/UI/command-menu-actions.ts

@@ -302,6 +302,7 @@ export const getCommandMenuActions = ({
         'php-wasm',
         'cpp',
         'cpp-wasm',
+        'rust-wasm',
         'zig-wasm',
         'java',
         'csharp-wasm',

src/livecodes/editor/codejar/codejar.ts

@@ -262,7 +262,7 @@ export const createEditor = async (options: EditorOptions): Promise<CodeEditor>
     const newValue = await formatter(oldValue, offset, getFormatterConfig());
     setValue(newValue.formatted);
     const newOffset =
-      newValue.cursorOffset != null && newValue.cursorOffset >= 0 ? newValue.cursorOffset : 0;
+      newValue.cursorOffset != null && newValue.cursorOffset >= 0 ? newValue.cursorOffset : offset;
     codejar?.restore({ start: newOffset, end: newOffset });
   };
 

src/livecodes/editor/codemirror/codemirror.ts

@@ -435,7 +435,7 @@ export const createEditor = async (options: EditorOptions): Promise<CodeEditor>
     const newValue = await formatter(oldValue, offset, getFormatterConfig());
     setValue(newValue.formatted, false);
     const newOffset =
-      newValue.cursorOffset != null && newValue.cursorOffset >= 0 ? newValue.cursorOffset : 0;
+      newValue.cursorOffset != null && newValue.cursorOffset >= 0 ? newValue.cursorOffset : offset;
     view.dispatch({ selection: { anchor: newOffset } });
   };
 

src/livecodes/html/language-info.html

@@ -1137,6 +1137,37 @@ <h3 data-i18n="language-info:nunjucks.name">Nunjucks</h3>
     </li>
   </ul>
 </section>
+<section data-lang="rust-wasm">
+  <h3 data-i18n="language-info:rustWasm.name">Rust (Wasm)</h3>
+  <div data-i18n="language-info:rustWasm.desc" data-i18n-prop="innerHTML">
+    Rust is interpreted by
+    <a href="https://github.com/rust-lang/miri" target="_blank" rel="noopener">Miri</a> (the Rust
+    mid-level IR interpreter) compiled to WebAssembly, running entirely in the browser.
+  </div>
+  <ul data-i18n="language-info:rustWasm.link" data-i18n-prop="innerHTML">
+    <li>
+      <a href="https://www.rust-lang.org/" target="_blank" rel="noopener">Rust official website</a>
+    </li>
+    <li>
+      <a href="https://doc.rust-lang.org/book/" target="_blank" rel="noopener">The Rust Book</a>
+    </li>
+    <li>
+      <a href="https://learnxinyminutes.com/rust/" target="_blank" rel="noopener"
+        >Learn X in Y minutes, where X=Rust</a
+      >
+    </li>
+    <li>
+      <a href="{{DOCS_BASE_URL}}languages/rust-wasm" target="_blank" rel="noopener"
+        >LiveCodes Documentation</a
+      >
+    </li>
+    <li>
+      <a href="?template=rust-wasm" class="button" target="_parent" data-template="rust-wasm"
+        >Load starter template</a
+      >
+    </li>
+  </ul>
+</section>
 <section data-lang="twig">
   <h3 data-i18n="language-info:twig.name">Twig</h3>
   <div data-i18n="language-info:twig.desc" data-i18n-prop="innerHTML">

src/livecodes/i18n/locales/en/language-info.lokalise.json

@@ -836,6 +836,18 @@
     "notes": "",
     "translation": "Ruby (WASM)"
   },
+  "rustWasm.desc": {
+    "notes": "### <tag-1> ###\n<a href=\"https://github.com/rust-lang/miri\" target=\"_blank\" rel=\"noopener\" />\n\n",
+    "translation": "Rust is interpreted by <tag-1>Miri</tag-1> (the Rust mid-level IR interpreter) compiled to WebAssembly, running entirely in the browser."
+  },
+  "rustWasm.link": {
+    "notes": "### <tag-1> ###\n<li  />\n\n### <tag-2> ###\n<a href=\"https://www.rust-lang.org/\" target=\"_blank\" rel=\"noopener\" />\n\n### <tag-3> ###\n<li  />\n\n### <tag-4> ###\n<a href=\"https://doc.rust-lang.org/book/\" target=\"_blank\" rel=\"noopener\" />\n\n### <tag-5> ###\n<li  />\n\n### <tag-6> ###\n<a href=\"https://learnxinyminutes.com/rust/\" target=\"_blank\" rel=\"noopener\" />\n\n### <tag-7> ###\n<li  />\n\n### <tag-8> ###\n<a href=\"{{DOCS_BASE_URL}}languages/rust-wasm\" target=\"_blank\" rel=\"noopener\" />\n\n### <tag-9> ###\n<li  />\n\n### <tag-10> ###\n<a href=\"?template=rust-wasm\" class=\"button\" target=\"_parent\" data-template=\"rust-wasm\" />\n\n",
+    "translation": "<tag-1> <tag-2>Rust official website</tag-2> </tag-1> <tag-3> <tag-4>The Rust Book</tag-4> </tag-3> <tag-5> <tag-6>Learn X in Y minutes, where X=Rust</tag-6> </tag-5> <tag-7> <tag-8>LiveCodes Documentation</tag-8> </tag-7> <tag-9> <tag-10>Load starter template</tag-10> </tag-9>"
+  },
+  "rustWasm.name": {
+    "notes": "",
+    "translation": "Rust (Wasm)"
+  },
   "sass.desc": {
     "notes": "",
     "translation": "Syntactically Awesome Style Sheets."

src/livecodes/i18n/locales/en/language-info.ts

@@ -360,6 +360,11 @@ const languageInfo = {
     link: '<1> <2>Ruby official website</2> </1> <3> <4>Ruby documentation</4> </3> <5> <6>ruby.wasm website</6> </5> <7><8>CRuby</8></7> <9> <10>Learn X in Y minutes, where X=ruby</10> </9> <11> <12>LiveCodes Documentations</12> </11> <13> <14>Load starter template</14> </13>',
     name: 'Ruby (WASM)',
   },
+  rustWasm: {
+    desc: 'Rust is interpreted by <1>Miri</1> (the Rust mid-level IR interpreter) compiled to WebAssembly, running entirely in the browser.',
+    link: '<1> <2>Rust official website</2> </1> <3> <4>The Rust Book</4> </3> <5> <6>Learn X in Y minutes, where X=Rust</6> </5> <7> <8>LiveCodes Documentation</8> </7> <9> <10>Load starter template</10> </9>',
+    name: 'Rust (Wasm)',
+  },
   sass: {
     desc: 'Syntactically Awesome Style Sheets.',
     link: '<1> <2>Sass official website</2> </1> <3> <4>Sass documentation</4> </3> <5> <6>Sass (the indented) syntax</6> </5> <7> <8>Learn X in Y minutes, where X=sass</8> </7>',

src/livecodes/i18n/locales/en/translation.lokalise.json

@@ -2784,6 +2784,10 @@
     "notes": "",
     "translation": "Ruby (Wasm) Starter"
   },
+  "templates.starter.rust-wasm": {
+    "notes": "",
+    "translation": "Rust (Wasm) Starter"
+  },
   "templates.starter.scheme": {
     "notes": "",
     "translation": "Scheme Starter"

src/livecodes/i18n/locales/en/translation.ts

@@ -1042,6 +1042,7 @@ const translation = {
       riot: 'Riot.js Starter',
       ruby: 'Ruby Starter',
       'ruby-wasm': 'Ruby (Wasm) Starter',
+      'rust-wasm': 'Rust (Wasm) Starter',
       scheme: 'Scheme Starter',
       shadcnui: 'shadcn/ui Starter',
       solid: 'Solid Starter',

src/livecodes/languages/languages.ts

@@ -65,6 +65,7 @@ import { richtext } from './richtext';
 import { riot } from './riot';
 import { ruby } from './ruby';
 import { rubyWasm } from './ruby-wasm';
+import { rustWasm } from './rust-wasm';
 import { scheme } from './scheme';
 import { sass, scss } from './scss';
 import { solid, solidTsx } from './solid';
@@ -153,6 +154,7 @@ export const languages: LanguageSpecs[] = [
   phpWasm,
   cpp,
   cppWasm,
+  rustWasm,
   zigWasm,
   java,
   csharpWasm,

src/livecodes/languages/prettier.ts

@@ -1,4 +1,10 @@
-import { prettierBaseUrl, prettierMinizincUrl, prettierPhpUrl, vendorsBaseUrl } from '../vendors';
+import {
+  prettierBaseUrl,
+  prettierMinizincUrl,
+  prettierPhpUrl,
+  prettierRustUrl,
+  vendorsBaseUrl,
+} from '../vendors';
 
 export const prettierUrl = prettierBaseUrl + 'standalone.js';
 export const parserPlugins = {
@@ -12,4 +18,5 @@ export const parserPlugins = {
   minizinc: prettierMinizincUrl,
   pug: vendorsBaseUrl + 'prettier/parser-pug.js',
   java: vendorsBaseUrl + 'prettier/parser-java.js',
+  rust: prettierRustUrl,
 };

src/livecodes/languages/rust-wasm/index.ts

@@ -0,0 +1 @@
+export * from './lang-rust-wasm';