Add support for multi-part questions (#33)

* Document schema, generate JSON schema in CI

* Run CI on branch push

* Install Aquascope in CI

* Add frontend support for multi-part questions

* Only include json schema stuff if needed

* Revert to old example

.github/workflows/main.yml

@@ -3,7 +3,7 @@ name: Tests
 on:
   push:
     branches:
-      - "main"
+      - "**"
     tags-ignore:
       - "v*"
   pull_request:
@@ -17,3 +17,16 @@ jobs:
       - uses: actions/checkout@v2
       - name: Setup
         uses: ./.github/workflows/setup
+      - name: Install Aquascope
+        # tag should match mdbook-aquascope version
+        run: |          
+          git clone -b v0.3.0 https://github.com/cognitive-engineering-lab/aquascope
+          cd aquascope
+          cargo make install-mdbook
+      - name: Test Rust package
+        run: cargo test --all-features --locked
+      - name: Lint Rust package
+        run: cargo clippy --all-features --locked -- -D warnings
+      - name: Test JS package
+        run: depot test
+        working-directory: js

.github/workflows/release.yml

@@ -35,22 +35,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - name: Setup
+        uses: ./.github/workflows/setup
         with:
-          toolchain: stable
           target: ${{ matrix.target }}
-          profile: minimal
-          override: true
-      - name: Install cargo-make
-        uses: baptiste0928/cargo-install@v2
-        with:
-          crate: cargo-make
-      - name: Install Depot
-        run: |
-          curl https://raw.githubusercontent.com/cognitive-engineering-lab/depot/main/scripts/install.sh | sh
-          echo "PATH=$HOME/.local/bin:$PATH" >> $GITHUB_ENV
-      - name: Initialize TS bindings
-        run: cargo make init-bindings
       - name: Build Rust package
         run: cargo build -p mdbook-quiz --release --locked ${{ matrix.kind == 'full' && '--features rust-editor --features aquascope' || '' }}
       - name: Package artifact
@@ -60,9 +48,22 @@ jobs:
         with:
           name: ${{ matrix.target }}_${{ matrix.kind }}
           path: target/release/mdbook-quiz_${{ matrix.target }}_${{ matrix.kind }}.tar.gz
+
+  build-schema:
+    runs-on: ubuntu-latest
+    steps: 
+      - uses: actions/checkout@v2
+      - name: Setup
+        uses: ./.github/workflows/setup  
+      - name: Build schema
+        run: cargo run --bin gen-json-schema --features json-schema > mdbook-quiz.schema.json
+      - uses: actions/upload-artifact@v2
+        with:
+          name: schema
+          path: mdbook-quiz.schema.json
 
   publish-artifacts:
-    needs: build-artifacts
+    needs: [build-artifacts, build-schema]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/download-artifact@v2
@@ -74,6 +75,7 @@ jobs:
             x86_64-apple-darwin_bare/mdbook-quiz_x86_64-apple-darwin_bare.tar.gz
             aarch64-unknown-linux-gnu_bare/mdbook-quiz_aarch64-unknown-linux-gnu_bare.tar.gz
             aarch64-apple-darwin_bare/mdbook-quiz_aarch64-apple-darwin_bare.tar.gz      
+            schema/mdbook-quiz.schema.json
     
   publish-crate:
     needs: publish-artifacts

.github/workflows/setup/action.yaml

@@ -1,4 +1,9 @@
 name: Setup
+
+inputs:
+  target:
+    default: x86_64-unknown-linux-gnu
+
 runs:
   using: composite
   steps:
@@ -7,6 +12,8 @@ runs:
         profile: minimal
         toolchain: stable
         components: clippy
+        target: ${{ inputs.target }}
+        override: true
     - uses: Swatinem/rust-cache@v1
     - name: Install cargo-make
       uses: baptiste0928/cargo-install@v2
@@ -15,17 +22,6 @@ runs:
     - name: Install Depot
       run: curl https://raw.githubusercontent.com/cognitive-engineering-lab/depot/main/scripts/install.sh | sh
       shell: bash
-    # Note: we have to build before test so the build script is executed
     - name: Initialize TS bindings
       run: cargo make init-bindings
-      shell: bash
-    - name: Test Rust package
-      run: cargo test --locked
-      shell: bash
-    - name: Lint Rust package
-      run: cargo clippy --locked -- -D warnings
-      shell: bash
-    - name: Test JS package
-      run: depot test
-      working-directory: js
       shell: bash

Makefile.toml

@@ -3,7 +3,6 @@ skip_core_tasks = true
 default_to_workspace = false
 
 
-# Precommit
 [tasks.precommit-cargo]
 script = "cargo fmt && cargo clippy"
 
@@ -13,20 +12,10 @@ script = "cd js && depot fmt"
 [tasks.precommit.run_task]
 name = ["precommit-js", "precommit-cargo"]
 
-[tasks.init-bindings]
-script = """
-cargo test -p mdbook-quiz-schema --locked export_bindings
-mkdir -p js/packages/quiz/src/bindings
-cp crates/mdbook-quiz-schema/bindings/* js/packages/quiz/src/bindings
-"""
 
-# Watch
 [tasks.watch]
-script = "cargo watch -x 'install --path crates/mdbook-quiz --debug --offline --features rust-editor --features source-map' -w src -w js/packages/quiz-embed/dist --ignore-nothing"
+script = "cargo watch -x 'install --path crates/mdbook-quiz --debug --offline --features rust-editor --features source-map' -w crates -w js/packages/quiz-embed/dist --ignore-nothing"
 
-[tasks.watch.run_task]
-name = ["watch-cargo"]
-parallel = true
 
 [tasks.clean]
 script = """
@@ -35,6 +24,14 @@ cd js && depot clean && cd ..
 rm -rf js/packages/quiz/src/bindings crates/mdbook-quiz-schema/bindings
 """
 
+
+[tasks.init-bindings]
+script = """
+cargo test -p mdbook-quiz-schema --locked export_bindings
+mkdir -p js/packages/quiz/src/bindings
+cp crates/mdbook-quiz-schema/bindings/* js/packages/quiz/src/bindings
+"""
+
 [tasks.install]
 dependencies = ["init-bindings"]
 script = """

crates/mdbook-quiz-schema/Cargo.toml

@@ -7,9 +7,14 @@ license = "MIT OR Apache-2.0"
 edition = "2021"
 repository = "https://github.com/cognitive-engineering-lab/mdbook-quiz"
 
+[features]
+json-schema = ["dep:schemars", "dep:serde_json"]
+
 [dependencies]
 serde = {version = "1.0.188", features = ["derive"]}
 ts-rs = "7.0.0"
+schemars = {version = "0.8.15", optional = true}
+serde_json = {version = "1.0.107", optional = true}
 
 [dev-dependencies]
-toml = { workspace = true }
+toml = { workspace = true }

crates/mdbook-quiz-schema/src/bin/gen-json-schema.rs

@@ -0,0 +1,15 @@
+fn main() {
+  #[cfg(feature = "json-schema")]
+  {
+    use mdbook_quiz_schema::Quiz;
+    use schemars::schema_for;
+
+    let schema = schema_for!(Quiz);
+    println!("{}", serde_json::to_string_pretty(&schema).unwrap());
+  }
+
+  #[cfg(not(feature = "json-schema"))]
+  {
+    panic!("Must run with --feature json-schema")
+  }
+}