feat: export to javascript using scala-js

.github/workflows/scalajs.yml

@@ -0,0 +1,24 @@
+# Build JS files using https://www.scala-js.org/
+name: ScalaJS
+on:
+  push:
+    branches: [master, main]
+  pull_request:
+    branches: [master, main]
+jobs:
+  build-scala-js:
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+    - name: Setup Scala
+      uses: olafurpg/setup-scala@v10
+      with:
+        java-version: "[email protected]"
+    - name: Build and Test
+      run: sbt -v -Dfile.encoding=UTF-8 +fullLinkJS
+    - name: Upload Artifact
+      uses: actions/upload-artifact@v2
+      with:
+         name: scala-js
+         path: target/scala-2.13/scala-tptp-parser-opt/

.gitignore

@@ -28,3 +28,7 @@ bin/*
 *.swp
 *~
 ext_config
+
+
+# OSX
+.DS_Store

README.md

@@ -45,6 +45,19 @@ libraryDependencies += "io.github.leoprover" %% "scala-tptp-parser" % "1.3"
 ### Non-sbt-projects
 In order to use the library with a non-sbt project, you can simply compile the library and use the class files as an unmanaged dependency/class path. The latest release JAR can also be downloaded from the Maven Central link above.
 
+#### ScalaJS
+This project supports very basic (and untested) export to JavaScript ESModule using [ScalaJS](https://www.scala-js.org/).
+
+To compile an unoptimized version use `sbt fastLinkJS`, for an optimized version `sbt fullLinkJS`.
+
+To use it in your code import the TPTPParser Object:
+
+```javascript
+    import {TPTPParser} from "./main.js";
+
+    console.log(TPTPParser.annotatedTHF("thf(f, axiom, ![X:$i]: (p @ X))."));
+```
+
 ## Usage
 The parser object `TPTPParser` offers several methods for parsing TPTP problems, annotated formulas or simple formulas. The input is transformed into an
 abstract syntax tree (AST) provided at `leo.datastructures.TPTP`. The ASTs are mostly case classes that can be further processed by pattern matching.

build.sbt

@@ -41,3 +41,6 @@ lazy val tptpParser = (project in file("."))
 
     libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.5" % "test"
   )
+  .enablePlugins(ScalaJSPlugin)
+
+scalaJSLinkerConfig ~= { _.withModuleKind(ModuleKind.ESModule) }

project/plugins.sbt

@@ -1 +1,2 @@
-addSbtPlugin("com.geirsson" % "sbt-ci-release" % "1.5.7")
+addSbtPlugin("com.geirsson" % "sbt-ci-release" % "1.5.7")
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.5.1")

src/main/scala/leo/modules/input/TPTPParser.scala

@@ -8,6 +8,7 @@ import leo.datastructures.TPTP.TCFAnnotated
 import java.util.NoSuchElementException
 import scala.annotation.tailrec
 import scala.io.Source
+import scala.scalajs.js.annotation.{JSExportAll, JSExportTopLevel}
 
 /**
  *
@@ -54,6 +55,8 @@ import scala.io.Source
  * @note Limitations: Currently, FOOL logic (i.e., TFX) cannot be parsed.
  * @since January 2021
  */
+@JSExportTopLevel("TPTPParser")
+@JSExportAll
 object TPTPParser {
   import datastructures.TPTP.{Problem, AnnotatedFormula, THFAnnotated, TFFAnnotated,
     FOFAnnotated, CNFAnnotated, TPIAnnotated}