Skip to content

Commit

Permalink
feat: pkl and compat pages
Browse files Browse the repository at this point in the history
  • Loading branch information
sgammon committed May 20, 2024
1 parent 54359b9 commit 655856e
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Writerside/e.tree
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
<toc-element topic="Installation.md"/>
<toc-element topic="GettingStarted.md"/>
<toc-element topic="Language-Guides.topic">
<toc-element topic="Compatibility.md"/>
<toc-element topic="Polyglot.md">
<toc-element topic="101-Environment.md"/>
<toc-element topic="101-Filesystem.md"/>
Expand All @@ -24,6 +25,7 @@
</toc-element>
<toc-element toc-title="Guides by Language">
<toc-element topic="JavaScript.md">
<toc-element topic="TypeScript.md"/>
<toc-element topic="Node-API.md">
<toc-element topic="node-assert.md"/>
<toc-element toc-title="Async Hooks" />
Expand Down Expand Up @@ -66,9 +68,9 @@
<toc-element toc-title="Web Streams API" />
</toc-element>
</toc-element>
<toc-element topic="TypeScript.md"/>
<toc-element topic="Python.md"/>
<toc-element topic="Ruby.md"/>
<toc-element topic="Pkl.md"/>
<toc-element topic="Experimental.md"/>
</toc-element>
<toc-element topic="Container-Images.md"/>
Expand Down
20 changes: 20 additions & 0 deletions Writerside/topics/Compatibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Compatibility

%product% is **alpha-quality software**, meaning it has not yet reached a level of stability where correct operation is
guaranteed or even typical.

The language engines used by %product% are based on [GraalVM](https://graalvm.org)
[Truffle](https://www.graalvm.org/latest/graalvm-as-a-platform/language-implementation-framework/). Truffle engines
aren't necessarily compatible by default with their corresponding regular language engines.

Refer to the table below for resources regarding compatibility in each language.

| Language | Stability | %product%'s Engine | Stock Engine | Notes |
|--------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
| [JavaScript](JavaScript.md) | ![Beta](https://img.shields.io/badge/-beta-purple) | [GraalJs](https://github.com/oracle/graaljs) | [V8](https://v8.dev/) | ECMA2023-compatible. [Node API](Node-API.md) compat pending. |
| [WebAssembly](Experimental.md) | ![Alpha](https://img.shields.io/badge/-alpha-blue) | [GraalWasm](https://github.com/oracle/graal/blob/master/wasm/README.md) | [V8](https://v8.dev/) | |
| [Python](Python.md) | ![Alpha](https://img.shields.io/badge/-alpha-blue) | [GraalPython](https://github.com/oracle/graalpython) | [CPython](https://github.com/python/cpython) | Roughly **~48% compatible** with PyPI top 500. See [here](https://www.graalvm.org/python/compatibility/). |
| [Ruby](Ruby.md) | ![Alpha](https://img.shields.io/badge/-alpha-blue) | [TruffleRuby](https://github.com/oracle/truffleruby) | [MRI](https://rvm.io/interpreters/ruby) | Passes ~**97% of `ruby/spec`**. See [here](https://www.graalvm.org/latest/reference-manual/ruby/Compatibility/) |
| [LLVM](Experimental.md) | ![Experimental](https://img.shields.io/badge/-experimental-orange) | [Sulong](https://github.com/oracle/graal/tree/master/sulong) | [LLVM Runtime](https://llvm.org/) | |
| [TypesScript](TypeScript.md) | ![Experimental](https://img.shields.io/badge/-experimental-orange) | [TSC](https://github.com/microsoft/typescript) | [TSC](https://github.com/microsoft/typescript) | |
| [Pkl](Pkl.md) | ![Experimental](https://img.shields.io/badge/-experimental-orange) | [Apple Pkl](https://github.com/apple/pkl) | [Apple Pkl](https://github.com/apple/pkl) | |
1 change: 1 addition & 0 deletions Writerside/topics/Experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ construction upstream, as part of [GraalVM](https://graalvm.org).
| JVM | [Espresso](https://www.graalvm.org/latest/reference-manual/java-on-truffle/) | ![Experimental](https://img.shields.io/badge/-experimental-orange) **Linux amd64 only.** |
| LLVM | [Sulong](https://www.graalvm.org/latest/reference-manual/llvm/) | ![Experimental](https://img.shields.io/badge/-experimental-orange) |
| WebAssembly | [GraalWasm](https://www.graalvm.org/latest/reference-manual/wasm/) | ![Experimental](https://img.shields.io/badge/-experimental-orange) |
| Pkl | [Apple Pkl](https://github.com/apple/pkl) | ![Experimental](https://img.shields.io/badge/-experimental-orange) |

Several experimental engines support multiple dialects.

Expand Down
3 changes: 3 additions & 0 deletions Writerside/topics/Pkl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Pkl

Coming soon.

0 comments on commit 655856e

Please sign in to comment.