Skip to content

Commit 9f911e8

Browse files
Dale-Blackclaude
andcommitted
Transpiler terminology, build_playground path fix, docs updates
- README + docs: "compiler" → "transpiler" throughout - build_playground: fix index.html source path (docs/src/playground/) - Docs routes: consistent transpiler language Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 8447993 commit 9f911e8

4 files changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# JavaScriptTarget.jl
44

5-
Compile Julia functions to JavaScript.
5+
Julia-to-JavaScript transpiler.
66

77
[![CI](https://github.com/GroupTherapyOrg/JavaScriptTarget.jl/actions/workflows/ci.yml/badge.svg)](https://github.com/GroupTherapyOrg/JavaScriptTarget.jl/actions/workflows/ci.yml)
88
[![Docs](https://github.com/GroupTherapyOrg/JavaScriptTarget.jl/actions/workflows/docs.yml/badge.svg)](https://grouptherapyorg.github.io/JavaScriptTarget.jl/)
@@ -24,7 +24,7 @@ println(result.js)
2424

2525
Includes a self-hosted [browser playground](https://grouptherapyorg.github.io/JavaScriptTarget.jl/) — type Julia, run it as JS, no server needed.
2626

27-
## What Compiles
27+
## What Transpiles
2828

2929
| Julia | JavaScript |
3030
|---|---|
@@ -72,7 +72,7 @@ JST auto-detects when `optimize=false` is needed (when the optimized IR contains
7272

7373
## Package Compilation Registry
7474

75-
JST can compile calls to registered Julia packages into their JavaScript equivalents — instead of compiling the package's internal implementation.
75+
JST can transpile calls to registered Julia packages into their JavaScript equivalents — instead of transpiling the package's internal implementation.
7676

7777
### Registering a Package
7878

@@ -150,7 +150,7 @@ js("console.log('value:', \$1)", my_value) # $1 substituted with compiled expre
150150

151151
## Related
152152

153-
- [Therapy.jl](https://github.com/GroupTherapyOrg/Therapy.jl) — Signals-based web framework using JST for compilation
153+
- [Therapy.jl](https://github.com/GroupTherapyOrg/Therapy.jl) — Signals-based web framework using JST for transpilation
154154
- [Sessions.jl](https://github.com/GroupTherapyOrg/Sessions.jl) — Notebook IDE with JST-powered export
155155

156156
## License

docs/src/routes/api/index.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
Div(:class => "space-y-4",
1111
Div(:class => card,
1212
H3(:class => "font-mono font-semibold text-warm-900 dark:text-warm-100", "compile(f, arg_types; kwargs...)"),
13-
P(:class => "text-sm text-warm-600 dark:text-warm-400", "Compile a Julia function to JavaScript. Returns a ", Code(:class => "text-accent-500", "JSOutput"), " with the JS code, TypeScript declarations, and exports."),
13+
P(:class => "text-sm text-warm-600 dark:text-warm-400", "Transpile a Julia function to JavaScript. Returns a ", Code(:class => "text-accent-500", "JSOutput"), " with the JS code, TypeScript declarations, and exports."),
1414
Pre(:class => code_block, Code(:class => "language-julia", """result = compile(sin, (Float64,))
1515
println(result.js) # JavaScript code
1616
println(result.exports) # ["sin"]"""))),

docs/src/routes/getting-started.jl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@
77
Pkg.add(url="https://github.com/GroupTherapyOrg/JavaScriptTarget.jl")""")),
88

99
H2(:class => "text-xl font-semibold text-warm-800 dark:text-warm-200", "Basic Usage"),
10-
P(:class => "text-warm-600 dark:text-warm-400", "Write a Julia function with typed arguments, then compile it to JavaScript:"),
10+
P(:class => "text-warm-600 dark:text-warm-400", "Write a Julia function with typed arguments, then transpile it to JavaScript:"),
1111
Pre(:class => "bg-warm-900 dark:bg-warm-950 p-4 rounded border border-warm-800", Code(:class => "language-julia", """using JavaScriptTarget
1212
1313
# Define a Julia function with typed arguments
1414
function add(a::Int32, b::Int32)::Int32
1515
return a + b
1616
end
1717
18-
# Compile to JavaScript
18+
# Transpile to JavaScript
1919
result = compile(add, (Int32, Int32))
2020
println(result.js)
2121
# Output: function add(a, b) { return (a + b) | 0; }""")),
@@ -65,6 +65,6 @@ println(result.js)
6565
Span(count)
6666
)
6767
end
68-
# → Compiles to ~500 bytes of inline JavaScript"""))
68+
# → Transpiles to ~500 bytes of inline JavaScript"""))
6969
)
7070
end

docs/src/routes/index.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
"Julia → JavaScript"
77
),
88
H1(:class => "no-rule text-5xl md:text-6xl font-serif font-bold text-accent-500",
9-
"Compiler"
9+
"Transpiler"
1010
),
1111
P(:class => "text-lg text-warm-600 dark:text-warm-400 max-w-2xl mx-auto leading-relaxed",
12-
"Compile Julia functions to JavaScript via typed IR. ",
13-
"Arrays, strings, math, closures, structs — all compile to clean, efficient JS."
12+
"Transpile Julia functions to JavaScript via typed IR. ",
13+
"Arrays, strings, math, closures, structs — all transpile to clean, efficient JS."
1414
),
1515
Div(:class => "flex gap-4 justify-center pt-4",
1616
A(:href => "./getting-started/",
@@ -44,7 +44,7 @@ println(result.js) # Clean JS output""")
4444
# Live Playground
4545
Div(:class => "space-y-4",
4646
H2(:class => "text-xl font-semibold text-warm-800 dark:text-warm-200 text-center", "Try it Live"),
47-
P(:class => "text-sm text-warm-600 dark:text-warm-400 text-center", "Write Julia in the left panel — see compiled JavaScript on the right. Runs entirely in your browser."),
47+
P(:class => "text-sm text-warm-600 dark:text-warm-400 text-center", "Write Julia in the left panel — see transpiled JavaScript on the right. Runs entirely in your browser."),
4848
Div(:class => "w-full rounded-lg overflow-hidden border border-warm-200 dark:border-warm-800",
4949
RawHtml("""<iframe src="./playground/index.html" style="width:100%;height:500px;border:none;" title="JST Playground"></iframe>""")
5050
)

0 commit comments

Comments
 (0)