Typst (#81)

* Working on adding kernel and LSP for typst

* Working on typst "kernel" for exporter

* typst: add package searcher

* typst: add test of tinymist diagnostics

* ci: add typst

* Working on typst packages

Closes #80

Author: thomasjm

.github/workflows/ci.yml

@@ -120,6 +120,7 @@ jobs:
         - name: rust
         - name: zsh
         - name: spellchecker
+        - name: typst
 
         - name: exporters
         - name: sample-environments

codedown.nix

@@ -57,6 +57,7 @@ rec {
   };
 
   kernels = everythingEnv.config.builtKernels;
+  exporters = everythingEnv.config.builtExporters;
 
   makeEnvironment = callPackage ./nix/makeEnvironment.nix {
     inherit pkgsStable pkgsMaster;

modules/exporters/typst/default.nix

@@ -1,4 +1,5 @@
 { callPackage
+, lib
 , pandoc
 , symlinkJoin
 , typst
@@ -7,7 +8,12 @@
 , settingsSchema
 }:
 
+with { inherit (settings) packages; };
+with { inherit (settings.interface) attrs extensions; };
+
 let
+  kernelName = "typst";
+
   common = callPackage ../../kernels/common.nix {};
 
   script = common.writeShellScriptBinWithAttrs {} "typst-export" ''
@@ -16,14 +22,27 @@ let
     echo_and_run ${typst}/bin/typst compile "$1" "$2"
   '';
 
+  typstToUse = typst.withPackages (ps: (map (x: ps.${x}) packages));
+
+  languageServers = lib.optionals settings.lsp.tinymist.enable
+    [(callPackage ./language_server_tinymist { inherit kernelName typstToUse; })];
+
+  packageOptions = typst.packages;
+  packageSearch = common.searcher packageOptions;
+
   icon = ./typst.png;
   iconMonochrome = ./typst.svg;
 
 in
 
 symlinkJoin {
   name = "codedown-exporter-typst";
-  paths = [script];
+  paths = [
+    (callPackage ./kernel.nix { inherit attrs extensions typstToUse; })
+    script
+  ]
+  ++ languageServers
+  ;
 
   passthru = {
     meta = {
@@ -46,12 +65,23 @@ symlinkJoin {
         input_extensions = ["typ"];
         pandoc = "${pandoc}/bin/pandoc";
       }];
+
+      hasPackages = packageOptions != {};
     };
 
     versions = {
       typst = typst.version;
     };
 
+    inherit packageOptions packageSearch;
+
     inherit settingsSchema settings;
+
+    modes = {
+      inherit attrs extensions;
+      code_mirror_mode = "typst";
+    };
+
+    languageServerNames = map (x: x.languageServerName) languageServers;
   };
 }

modules/exporters/typst/kernel.nix

@@ -0,0 +1,33 @@
+{ lib
+, callPackage
+, typst
+, typstToUse # TODO: should this kernel actually do something?
+
+, attrs
+, extensions
+}:
+
+let
+  common = callPackage ../../kernels/common.nix {};
+
+in
+
+common.makeJupyterKernel {
+  bash = {
+    displayName = "Typst";
+    argv = [
+      "echo"
+      "hi"
+    ];
+    language = lib.head attrs;
+    logo32 = ./typst.png; # TODO: resize to proper size
+    logo64 = ./typst.png; # TODO: resize to proper size
+    metadata = {
+      codedown = {
+        inherit attrs extensions;
+        language_version = typst.version;
+        priority = 10;
+      };
+    };
+  };
+}

modules/exporters/typst/language_server_tinymist/default.nix

@@ -0,0 +1,34 @@
+{ lib
+, callPackage
+
+, tinymist
+
+# TODO: how to make the typstToUse (i.e. Typst with some packages) available to tinymist?
+, typstToUse
+
+, kernelName
+}:
+
+let
+  common = callPackage ../../../kernels/common.nix {};
+
+  languageServerName = "tinymist";
+
+  passthru = {
+    inherit languageServerName;
+  };
+
+in
+
+common.writeTextDirWithMetaAndPassthru tinymist.meta passthru "lib/codedown/language-servers/typst-${kernelName}-tinymist-language-server.yaml" (lib.generators.toYAML {} [{
+  name = languageServerName;
+  version = tinymist.version;
+  extensions = ["typ"];
+  notebook_suffix = ".typ";
+  attrs = ["typst"];
+  type = "stream";
+  primary = true;
+  args = [
+    "${tinymist}/bin/tinymist"
+  ];
+}])

modules/exporters/typst/module.nix

@@ -1,7 +1,23 @@
-{ config, options, lib, nixosOptionsToSettingsSchema, ... }:
+{ config, options, lib, nixosOptionsToSettingsSchema, boilerplate, ... }:
 
 with lib;
 
+let
+  subPackage = types.submodule {
+    options = {
+      name = mkOption {
+        description = "Package name";
+        type = types.str;
+      };
+      outputs = mkOption {
+        example = "Package outputs to include";
+        type = types.listOf types.str;
+      };
+    };
+  };
+
+in
+
 {
   options = {
     exporters.typst = {
@@ -12,6 +28,32 @@ with lib;
         default = false;
         visible = false;
       };
+
+      packages = mkOption {
+        example = "List of packages";
+        type = types.listOf (types.either types.str subPackage);
+        default = [];
+        visible = false;
+      };
+
+      interface.attrs = mkOption {
+        example = boilerplate.attrsTitle;
+        description = boilerplate.attrsDescription;
+        type = types.listOf types.str;
+        default = ["typst"];
+      };
+      interface.extensions = mkOption {
+        example = boilerplate.extensionsTitle;
+        description = boilerplate.extensionsDescription;
+        type = types.listOf types.str;
+        default = ["typ"];
+      };
+
+      lsp.tinymist.enable = mkOption {
+        example = "Enable tinymist language server";
+        type = types.bool;
+        default = true;
+      };
     };
   };
 

nix/makeEnvironment.nix

@@ -82,6 +82,7 @@ symlinkJoin {
   paths =
     attrValues evaluated.config.builtKernels
     ++ attrValues evaluated.config.builtLanguageServers
+    ++ attrValues evaluated.config.builtExporters
     ++ lib.optionals (builtins.length exporters > 0) [(writeTextDir "lib/codedown/exporters.yaml" (lib.generators.toYAML {} exporters))]
     ++ attrValues evaluated.config.packages
     ++ lib.mapAttrsToList linkBinaries evaluated.config.extraBinDirs

sample_environments/exporters-typst.nix

@@ -6,4 +6,7 @@ codedown.makeEnvironment {
   name = "exporters-typst";
 
   exporters.typst.enable = true;
+  exporters.typst.packages = [
+    "aero-check"
+  ];
 }

tests/app/Spec/Tests/Typst.hs

@@ -0,0 +1,80 @@
+{-# LANGUAGE RankNTypes #-}
+{-# OPTIONS_GHC -fno-warn-unused-top-binds #-}
+{-# OPTIONS_GHC -fno-warn-incomplete-uni-patterns #-}
+
+module Spec.Tests.Typst (tests) where
+
+import Control.Lens hiding (List)
+import Control.Monad
+import Data.String.Interpolate
+import Data.Text as T
+import Language.LSP.Protocol.Lens hiding (diagnostics, hover, text)
+import Language.LSP.Protocol.Types
+import Language.LSP.Test hiding (message)
+import Test.Sandwich as Sandwich
+import TestLib.JupyterRunnerContext
+import TestLib.LSP
+import TestLib.NixEnvironmentContext
+import TestLib.NixTypes
+import TestLib.TestBuilding
+import TestLib.TestSearchers
+import TestLib.Types
+
+
+kernelName :: Text
+kernelName = "typst"
+
+tests :: LanguageSpec
+tests = describe [i|Typst|] $ introduceNixEnvironment [] config [i|Typst|] $ introduceJupyterRunner $ do
+  it "has expected fields" $ do
+    testEval [i|exporters.typst.settingsSchema|]
+    testEval [i|exporters.typst.modes|]
+    testEval [i|exporters.typst.settings|]
+    testEval [i|exporters.typst.args|]
+    testEval [i|exporters.typst.meta|]
+
+    -- Used to view all versions in codedown-languages
+    testEval [i|exporters.typst.versions|]
+
+  it "searcher builds" $ do
+    void $ testBuild [i|exporters.typst.packageSearch|]
+
+  describe "LSP" $ do
+    testDiagnosticsLabelDesired "simple" lsName "test.typ" (Just "typst")
+      [__i|\#loremz(45)|]
+      ((== [(Range (Position 0 1) (Position 0 7), Nothing, "unknown variable: loremz")]) . getDiagnosticRanges')
+
+
+documentHighlightCode :: Text
+documentHighlightCode = [__i|foo = "hello"
+                             println(foo)|]
+
+documentHighlightResults :: [DocumentHighlight]
+documentHighlightResults = [
+  DocumentHighlight (Range (Position 0 0) (Position 0 3)) (Just DocumentHighlightKind_Write)
+  , DocumentHighlight (Range (Position 1 8) (Position 1 11)) (Just DocumentHighlightKind_Read)
+  ]
+
+lsName :: Text
+lsName = "tinymist"
+
+-- kernelSpec :: NixKernelSpec
+-- kernelSpec = NixKernelSpec {
+--   nixKernelName = "typst"
+--   , nixKernelChannel = "codedown"
+--   , nixKernelDisplayName = Just [i|Typst|]
+--   , nixKernelPackages = []
+--   , nixKernelMeta = Nothing
+--   , nixKernelIcon = Nothing
+--   , nixKernelExtraConfig = Just [
+--       "lsp.tinymist.enable = true"
+--       ]
+--   }
+
+config = [
+  "exporters.typst.enable = true;"
+  , "exporters.typst.lsp.tinymist.enable = true;"
+  ]
+
+main :: IO ()
+main = jupyterMain tests

tests/src/TestLib/LSP.hs

@@ -256,6 +256,7 @@ withLspSession' handleFn name filename codeToTest extraFiles session = do
            & set (workspace . _Just . configuration) Nothing
            & set (workspace . _Just . didChangeWatchedFiles . _Just . dynamicRegistration) (Just False)
            & set (workspace . _Just . didChangeConfiguration . _Just . dynamicRegistration) (Just False)
+           & set (textDocument . _Just . semanticTokens . _Just . dynamicRegistration) (Just False)
 
   handleFn $ runSessionWithConfigCustomProcess modifyCp sessionConfig cp caps homeDir (session homeDir)