\n\nTypix aims to make it easier to use [Nix](https://nixos.org/) in\n[Typst](https://github.com/typst/typst) projects.\n\n- **Dependency management**: supports arbitrary dependencies including fonts,\n images, and data\n- **Reproducible**: via a hermetically sealed build environment\n- **Extensible**: full support for [Typst packages](https://loqusion.github.io/typix/recipes/using-typst-packages.html)\n\n## Features\n\n- Automatically fetch dependencies and compile in a single command (`nix run\n.#build`)\n- Watch input files and recompile on changes (`nix run .#watch`)\n- Set up a shell environment with all dependencies made available via\n environment variables and symlinks\n- Extensible via\n [`mkTypstDerivation`](https://loqusion.github.io/typix/api/derivations/mk-typst-derivation.html)\n- Support for dependencies such as [fonts](https://typst.app/docs/reference/text/text/#parameters-font),\n [images](https://typst.app/docs/reference/visualize/image/), and [data](https://typst.app/docs/reference/data-loading/)\n- [Typst packages](https://loqusion.github.io/typix/recipes/using-typst-packages.html)\n fetched from the official Typst packages CDN\n\n## Getting Started\n\nAfter [installing Nix](https://github.com/DeterminateSystems/nix-installer) and\n[enabling\nflakes](https://nixos.wiki/wiki/Flakes#Enable_flakes_permanently_in_NixOS), you\ncan initialize a flake from the default template:\n\n```bash\nnix flake init --refresh -t github:loqusion/typix\n```\n\n> Alternatively, you can use a template demonstrating [Typst packages](https://loqusion.github.io/typix/recipes/using-typst-packages.html)\n> usage:\n>\n> ```bash\n> nix flake init --refresh -t 'github:loqusion/typix#with-typst-packages'\n> ```\n\nHere are some commands you can run from any template:\n\n- `nix run .#watch` — watch the input files and recompile on changes\n- `nix run .#build` — compile and copy the output to the current directory\n\n---\n\nFor more information, check out [the docs](https://loqusion.github.io/typix/).\n"
},
{
"path": "checks/.gitignore",
"content": "*.pdf\n"
},
{
"path": "checks/build-local.nix",
"content": "{\n lib,\n pkgs,\n buildTypstProjectLocal,\n}: runCommandDrvAttr: args: let\n build-local-drv = buildTypstProjectLocal ({\n name = \"build-local-check\";\n }\n // args\n // runCommandDrvAttr);\nin\n pkgs.runCommand \"build-local\" (runCommandDrvAttr\n // {\n nativeBuildInputs =\n (runCommandDrvAttr.nativeBuildInputs or [])\n ++ [\n build-local-drv\n ];\n }) ''\n ${lib.getExe build-local-drv} \"$out\"\n ''\n"
},
{
"path": "checks/check-emojis.py",
"content": "\"\"\"\nChecks if emoji characters in a PDF file are rendered with an appropriate font face.\n\nThis script is dumb, and only checks if the font face name for text with an\nemoji matches one of a set of patterns given on the command line. This\nassumption is naive, and may not hold if the font names change, or if a font\nname not supporting emoji happens to match any of the patterns.\n\"\"\"\n\nimport re\nimport sys\nfrom collections.abc import Iterator\nfrom dataclasses import dataclass\nfrom typing import Final\n\nimport emoji\nimport pdfplumber\n\n\n@dataclass\nclass TextElement:\n text: str\n font: str\n\n\nclass InvalidEmojiFontException(Exception):\n def __init__(self, text_element: TextElement, font_patterns: list[re.Pattern]):\n self.text_element = text_element\n self.font_patterns = font_patterns\n self.message = (\n f'Detected invalid font for text containing emoji character: \"{text_element.text}\"\\n'\n f'Font: \"{text_element.font}\"\\n'\n f\"Font did not match any of the following patterns: {', '.join((f\"'{pat.pattern}'\" for pat in font_patterns))}\"\n )\n super().__init__(self.message)\n\n\nclass PDFChecker:\n pdf_path: str\n\n def __init__(self, pdf_path: str):\n self.pdf_path = pdf_path\n\n def check_emojis(self, font_patterns: list[re.Pattern]):\n text_elements = self._extract_text_elements()\n\n for text_element in text_elements:\n if emoji.emoji_count(text_element.text) == 0:\n continue\n\n if not any(pat.search(text_element.font) for pat in font_patterns):\n raise InvalidEmojiFontException(text_element, font_patterns)\n\n def _extract_text_elements(self) -> Iterator[TextElement]:\n with pdfplumber.open(self.pdf_path) as pdf:\n for page in pdf.pages:\n words = page.extract_words(\n keep_blank_chars=True,\n use_text_flow=True,\n extra_attrs=[\"fontname\"],\n )\n\n for word in words:\n yield TextElement(\n text=word[\"text\"],\n font=word[\"fontname\"],\n )\n\n\nclass InvalidArgumentException(Exception):\n USAGE: Final = f\"usage: {sys.argv[0]} [...]\"\n\n def __init__(self, message: str):\n self.message = message + \"\\n\" + InvalidArgumentException.USAGE\n super().__init__(self.message)\n\n\ndef main():\n pdf_path = sys.argv[1]\n checker = PDFChecker(pdf_path)\n\n font_patterns = list(map(lambda pat: re.compile(pat, re.IGNORECASE), sys.argv[2:]))\n if len(font_patterns) == 0:\n raise InvalidArgumentException(\n \"expected one or more patterns given as arguments\"\n )\n\n checker.check_emojis(font_patterns)\n\n\nif __name__ == \"__main__\":\n try:\n main()\n except InvalidEmojiFontException as err:\n print(f\"test failed: {err}\", file=sys.stderr)\n sys.exit(1)\n except InvalidArgumentException as err:\n print(f\"error: {err}\", file=sys.stderr)\n sys.exit(2)\n except Exception:\n raise\n"
},
{
"path": "checks/clean/bad.c",
"content": "#include \n\nint main(void) {\n printf(\"Hello, World!\\n\");\n return 0;\n}\n"
},
{
"path": "checks/clean/lib.typ",
"content": "#bibliography(\"works.bib\")\n"
},
{
"path": "checks/clean/metadata.toml",
"content": "#:schema https://raw.githubusercontent.com/mintyfrankie/brilliant-CV/main/metadata.toml.schema.json\n\n# Set the output language\n# INFO: value must matches folder suffix; i.e \"zh\" -> \"./modules_zh\"\nlanguage = \"en\"\n\n[layout]\n# Optional values: skyblue, red, nephritis, concrete, darknight\n# You can also use a custom color by hex code i.e. \"#1E90FF\"\nawesome_color = \"skyblue\"\n\n# Skips are for controlling the spacing between sections and entries\nbefore_section_skip = \"1pt\"\nbefore_entry_skip = \"1pt\"\nbefore_entry_description_skip = \"1pt\"\n\n[layout.fonts]\nregular_fonts = [\"Source Sans Pro\", \"Source Sans 3\"]\nheader_font = \"Roboto\"\n\n[layout.header]\n# Optional values: left, center, right\nheader_align = \"left\"\n\n# Decide if you want to display profile photo or not\ndisplay_profile_photo = true\n\n[layout.entry]\n# Decide if you want to put your company in bold or your position in bold\ndisplay_entry_society_first = true\n\n# Decide if you want to display organisation logo or not\ndisplay_logo = true\n\n[inject]\n# Decide if you want to inject AI prompt or not\ninject_ai_prompt = false\n\n# Decide if you want to inject keywords or not\ninject_keywords = true\ninjected_keywords_list = [\"Data Analyst\", \"GCP\", \"Python\", \"SQL\", \"Tableau\"]\n\n[personal]\nfirst_name = \"John\"\nlast_name = \"Doe\"\n\n# The order of this section will affect how the entries are displayed\n# The custom value is for any additional information you want to add, name it as custom-1, custom-2, etc.\n[personal.info]\ngithub = \"mintyfrankie\"\nphone = \"+33 6 12 34 56 78\"\nemail = \"john.doe@me.org\"\nlinkedin = \"johndoe\"\n# gitlab = \"mintyfrankie\"\n# homepage = \"jd.me.org\"\n# orcid = \"0000-0000-0000-0000\"\n# researchgate = \"John-Doe\"\n# extraInfo = \"I am a cool kid\"\n[personal.info.custom-1]\n# image = \"\" # Example: image(\"./path/to/image.png\")\nawesomeIcon = \"graduation-cap\" # Example: \"graduation-cap\" see https://typst.app/universe/package/fontawesome/\ntext = \"PhD\"\nlink = \"https://www.example.com\"\n\n# add a new section if you want to include the language of your choice\n# i.e. [[lang.ru]]\n# each section must contains the following fields\n[lang.en]\nheader_quote = \"Experienced Data Analyst looking for a full time job starting from now\"\ncv_footer = \"Curriculum vitae\"\nletter_footer = \"Cover letter\"\n\n[lang.fr]\nheader_quote = \"Analyste de données expérimenté à la recherche d'un emploi à temps plein disponible dès maintenant\"\ncv_footer = \"Résumé\"\nletter_footer = \"Lettre de motivation\"\n\n[lang.zh]\nheader_quote = \"具有丰富经验的数据分析师，随时可入职\"\ncv_footer = \"简历\"\nletter_footer = \"申请信\"\n\n# For languages that are not written in Latin script\n# Currently supported non-latin language codes: (\"zh\", \"ja\", \"ko\", \"ru\")\n[lang.non_latin]\nname = \"王道尔\"\nfont = \"Heiti SC\"\n"
},
{
"path": "checks/clean/sub/bad.py",
"content": "if __name__ == \"__main__\":\n print(\"Hello, World!\")\n"
},
{
"path": "checks/clean/sub/sub.typ",
"content": ""
},
{
"path": "checks/clean/sub/typst.toml",
"content": "[package]\nname = \"sub\"\nversion = \"0.1.0\"\nentrypoint = \"sub.typ\"\n"
},
{
"path": "checks/clean/typst.toml",
"content": "[package]\nname = \"clean\"\nversion = \"0.1.0\"\nentrypoint = \"lib.typ\"\n"
},
{
"path": "checks/clean/works.bib",
"content": "\\begin{thebibliography}{9}\n\\bibitem{texbook}\nDonald E. Knuth (1986) \\emph{The \\TeX{} Book}, Addison-Wesley Professional.\n\n\\bibitem{lamport94}\nLeslie Lamport (1994) \\emph{\\LaTeX: a document preparation system}, Addison\nWesley, Massachusetts, 2nd ed.\n\\end{thebibliography}\n"
},
{
"path": "checks/clean-expected/lib.typ",
"content": "#bibliography(\"works.bib\")\n"
},
{
"path": "checks/clean-expected/metadata.toml",
"content": "#:schema https://raw.githubusercontent.com/mintyfrankie/brilliant-CV/main/metadata.toml.schema.json\n\n# Set the output language\n# INFO: value must matches folder suffix; i.e \"zh\" -> \"./modules_zh\"\nlanguage = \"en\"\n\n[layout]\n# Optional values: skyblue, red, nephritis, concrete, darknight\n# You can also use a custom color by hex code i.e. \"#1E90FF\"\nawesome_color = \"skyblue\"\n\n# Skips are for controlling the spacing between sections and entries\nbefore_section_skip = \"1pt\"\nbefore_entry_skip = \"1pt\"\nbefore_entry_description_skip = \"1pt\"\n\n[layout.fonts]\nregular_fonts = [\"Source Sans Pro\", \"Source Sans 3\"]\nheader_font = \"Roboto\"\n\n[layout.header]\n# Optional values: left, center, right\nheader_align = \"left\"\n\n# Decide if you want to display profile photo or not\ndisplay_profile_photo = true\n\n[layout.entry]\n# Decide if you want to put your company in bold or your position in bold\ndisplay_entry_society_first = true\n\n# Decide if you want to display organisation logo or not\ndisplay_logo = true\n\n[inject]\n# Decide if you want to inject AI prompt or not\ninject_ai_prompt = false\n\n# Decide if you want to inject keywords or not\ninject_keywords = true\ninjected_keywords_list = [\"Data Analyst\", \"GCP\", \"Python\", \"SQL\", \"Tableau\"]\n\n[personal]\nfirst_name = \"John\"\nlast_name = \"Doe\"\n\n# The order of this section will affect how the entries are displayed\n# The custom value is for any additional information you want to add, name it as custom-1, custom-2, etc.\n[personal.info]\ngithub = \"mintyfrankie\"\nphone = \"+33 6 12 34 56 78\"\nemail = \"john.doe@me.org\"\nlinkedin = \"johndoe\"\n# gitlab = \"mintyfrankie\"\n# homepage = \"jd.me.org\"\n# orcid = \"0000-0000-0000-0000\"\n# researchgate = \"John-Doe\"\n# extraInfo = \"I am a cool kid\"\n[personal.info.custom-1]\n# image = \"\" # Example: image(\"./path/to/image.png\")\nawesomeIcon = \"graduation-cap\" # Example: \"graduation-cap\" see https://typst.app/universe/package/fontawesome/\ntext = \"PhD\"\nlink = \"https://www.example.com\"\n\n# add a new section if you want to include the language of your choice\n# i.e. [[lang.ru]]\n# each section must contains the following fields\n[lang.en]\nheader_quote = \"Experienced Data Analyst looking for a full time job starting from now\"\ncv_footer = \"Curriculum vitae\"\nletter_footer = \"Cover letter\"\n\n[lang.fr]\nheader_quote = \"Analyste de données expérimenté à la recherche d'un emploi à temps plein disponible dès maintenant\"\ncv_footer = \"Résumé\"\nletter_footer = \"Lettre de motivation\"\n\n[lang.zh]\nheader_quote = \"具有丰富经验的数据分析师，随时可入职\"\ncv_footer = \"简历\"\nletter_footer = \"申请信\"\n\n# For languages that are not written in Latin script\n# Currently supported non-latin language codes: (\"zh\", \"ja\", \"ko\", \"ru\")\n[lang.non_latin]\nname = \"王道尔\"\nfont = \"Heiti SC\"\n"
},
{
"path": "checks/clean-expected/sub/sub.typ",
"content": ""
},
{
"path": "checks/clean-expected/sub/typst.toml",
"content": "[package]\nname = \"sub\"\nversion = \"0.1.0\"\nentrypoint = \"sub.typ\"\n"
},
{
"path": "checks/clean-expected/typst.toml",
"content": "[package]\nname = \"clean\"\nversion = \"0.1.0\"\nentrypoint = \"lib.typ\"\n"
},
{
"path": "checks/clean-expected/works.bib",
"content": "\\begin{thebibliography}{9}\n\\bibitem{texbook}\nDonald E. Knuth (1986) \\emph{The \\TeX{} Book}, Addison-Wesley Professional.\n\n\\bibitem{lamport94}\nLeslie Lamport (1994) \\emph{\\LaTeX: a document preparation system}, Addison\nWesley, Massachusetts, 2nd ed.\n\\end{thebibliography}\n"
},
{
"path": "checks/date/main.typ",
"content": "#let UNIX_EPOCH = datetime(\n year: 1980,\n month: 1,\n day: 1,\n)\n#assert.ne(\n datetime.today(),\n UNIX_EPOCH,\n)\n"
},
{
"path": "checks/default.nix",
"content": "{\n pkgs,\n myLib,\n}: let\n inherit (pkgs) lib;\n inherit (lib.strings) escapeShellArg concatMapStringsSep;\n onlyDrvs = lib.filterAttrs (_: lib.isDerivation);\nin\n onlyDrvs (lib.makeScope myLib.newScope (self: let\n callPackage = self.newScope {};\n typstSource = \"main.typ\";\n fontPaths = [\n \"${pkgs.roboto}/share/fonts/truetype\"\n ];\n virtualPaths = [\n {\n src = ./fixtures/icons;\n dest = \"icons\";\n }\n ];\n unstable_typstPackages = [\n {\n name = \"example\";\n version = \"0.1.0\";\n hash = \"sha256-R18Xv3AoZsTtMycRasczTsje5yIfiURIxtDICQ4mvho=\";\n }\n {\n name = \"cetz\";\n version = \"0.3.4\";\n hash = \"sha256-5w3UYRUSdi4hCvAjrp9HslzrUw7BhgDdeCiDRHGvqd4=\";\n }\n {\n name = \"polylux\";\n version = \"0.4.0\";\n hash = \"sha256-4owP2KiyaaASS1YZ0Hs58k6UEVAqsRR3YdGF26ikosk=\";\n }\n # Required by cetz\n {\n name = \"oxifmt\";\n version = \"0.2.1\";\n hash = \"sha256-8PNPa9TGFybMZ1uuJwb5ET0WGIInmIgg8h24BmdfxlU=\";\n }\n ];\n in rec {\n buildLocal = callPackage ./build-local.nix {};\n buildLocalSimple = buildLocal {} {\n inherit typstSource;\n src = myLib.cleanTypstSource ./simple;\n };\n buildLocalSimpleWithFonts = buildLocal {} {\n inherit fontPaths typstSource;\n src = myLib.cleanTypstSource ./simple-with-fonts;\n };\n buildLocalSimpleWithVirtualPaths = buildLocal {} {\n inherit virtualPaths typstSource;\n src = myLib.cleanTypstSource ./simple-with-virtual-paths;\n };\n buildLocalWithMultipleParameters = buildLocal {} {\n inherit typstSource;\n src = myLib.cleanTypstSource ./simple-with-multiple-parameters;\n typstOpts = {\n input = [\"key1=value1\" \"key2=value2\" \"key3= --spaces-are-properly-escaped\" \"key4='quotes-are-properly-escaped\\\"\"];\n };\n };\n buildLocalWithTypstPackages = buildLocal {} {\n inherit typstSource;\n src = myLib.cleanTypstSource ./typst-packages;\n inherit unstable_typstPackages;\n };\n\n clean = myLib.mkTypstDerivation {\n src = myLib.cleanTypstSource ./clean;\n EXPECTED_SRC = ./clean-expected;\n buildPhaseTypstCommand = ''\n diff -r \"$src\" \"$EXPECTED_SRC\"\n touch $out\n '';\n };\n\n date = myLib.buildTypstProject {\n inherit typstSource;\n src = myLib.cleanTypstSource ./date;\n };\n dateWatch = watch {} {\n inherit typstSource;\n src = myLib.cleanTypstSource ./date;\n };\n\n devShell = myLib.devShell {\n inherit virtualPaths;\n checks = {\n simple = myLib.buildTypstProject {\n inherit virtualPaths typstSource;\n src = myLib.cleanTypstSource ./simple;\n };\n };\n };\n\n checkEmojiScript = {\n inputs =\n (with pkgs; [\n python312\n python312Packages.emoji\n ])\n ++ (\n with pkgs.python312Packages; [\n # Referencing `emoji` doesn't work here because an attribute of that\n # name already exists in a recursive attribute set (`rec {...}`)\n pdfplumber\n ]\n );\n script = patterns: ''\n python3.12 ${./check-emojis.py} \"$out\" ${concatMapStringsSep \" \" escapeShellArg patterns}\n '';\n };\n\n emoji = {\n emojiFont,\n fontPaths ? [],\n patterns,\n }: (myLib.buildTypstProject ({\n inherit typstSource fontPaths;\n src = myLib.cleanTypstSource ./emoji;\n doCheck = true;\n nativeCheckInputs = checkEmojiScript.inputs;\n checkPhase = checkEmojiScript.script patterns;\n }\n // lib.optionalAttrs (emojiFont != \"__OMIT__\") {\n inherit emojiFont;\n }));\n emojiOmit = emoji {\n emojiFont = \"__OMIT__\";\n patterns = [\"emoji\"];\n };\n emojiTwemoji = emoji {\n emojiFont = \"twemoji\";\n patterns = [\"emoji\"];\n };\n emojiTwemojiCbdt = emoji {\n emojiFont = \"twemoji-cbdt\";\n patterns = [\"emoji\"];\n };\n emojiNoto = emoji {\n emojiFont = \"noto\";\n patterns = [\"emoji\"];\n };\n emojiNotoMonochrome = emoji {\n emojiFont = \"noto-monochrome\";\n patterns = [\"emoji\"];\n };\n # FIXME: https://github.com/loqusion/typix/issues/79\n # emojiEmojiOne = emoji {\n # emojiFont = \"emojione\";\n # patterns = [\"emoji\"];\n # };\n emojiFontOverride = emoji {\n emojiFont = null;\n fontPaths = [\"${pkgs.noto-fonts-color-emoji}/share/fonts/noto\"];\n patterns = [\"emoji\"];\n };\n\n emojiWatch = {\n emojiFont,\n fontPaths ? [],\n patterns,\n }: (watch {\n nativeBuildInputs = checkEmojiScript.inputs;\n postBuild = checkEmojiScript.script patterns;\n } ({\n inherit typstSource fontPaths;\n src = myLib.cleanTypstSource ./emoji;\n }\n // lib.optionalAttrs (emojiFont != \"__OMIT__\") {\n inherit emojiFont;\n }));\n emojiWatchOmit = emojiWatch {\n emojiFont = \"__OMIT__\";\n patterns = [\"emoji\"];\n };\n emojiWatchTwemoji = emojiWatch {\n emojiFont = \"twemoji\";\n patterns = [\"emoji\"];\n };\n emojiWatchTwemojiCbdt = emojiWatch {\n emojiFont = \"twemoji-cbdt\";\n patterns = [\"emoji\"];\n };\n emojiWatchNoto = emojiWatch {\n emojiFont = \"noto\";\n patterns = [\"emoji\"];\n };\n emojiWatchNotoMonochrome = emojiWatch {\n emojiFont = \"noto-monochrome\";\n patterns = [\"emoji\"];\n };\n # FIXME: https://github.com/loqusion/typix/issues/79\n # emojiWatchEmojiOne = emojiWatch {\n # emojiFont = \"emojione\";\n # patterns = [\"emoji\"];\n # };\n emojiWatchFontOverride = emojiWatch {\n emojiFont = null;\n fontPaths = [\"${pkgs.noto-fonts-color-emoji}/share/fonts/noto\"];\n patterns = [\"emoji\"];\n };\n\n overlappingVirtualPaths = isInvariant: util: file:\n util (let\n op =\n if isInvariant\n then \"!=\"\n else \"=\";\n errorMsg =\n if isInvariant\n then ''$FILE_TO_CHECK was overwritten\\; it should stay the same when forceVirtualPaths is false''\n else ''$FILE_TO_CHECK was not overwritten\\; it should be overwritten when forceVirtualPaths is true'';\n in {\n FILE_TO_CHECK = file;\n preBuild = ''\n if [ ! -e \"$FILE_TO_CHECK\" ]; then\n echo \"$FILE_TO_CHECK does not exist; unable to run check\"\n exit 1\n fi\n hash=$(sha256sum \"$FILE_TO_CHECK\" | awk '{ print $1 }')\n if [ -z \"$hash\" ]; then\n echo \"unable to obtain hash for $FILE_TO_CHECK\"\n exit 1\n fi\n '';\n postBuild = ''\n hash=''${hash:?not defined}\n new_hash=$(sha256sum \"$FILE_TO_CHECK\" | awk '{ print $1 }')\n if [ -z \"$new_hash\" ]; then\n echo \"unable to obtain hash for $FILE_TO_CHECK\"\n exit 1\n fi\n if [ \"$hash\" ${op} \"$new_hash\" ]; then\n echo ${errorMsg}\n echo\n echo \"old hash: $hash\"\n echo \"new hash: $new_hash\"\n exit 1\n fi\n '';\n }) {\n inherit virtualPaths typstSource;\n src = ./overlapping-virtual-paths;\n forceVirtualPaths = !isInvariant;\n };\n overlappingVirtualPathsInvariant = overlappingVirtualPaths true;\n overlappingVirtualPathsForce = overlappingVirtualPaths false;\n\n simple = myLib.buildTypstProject {\n inherit typstSource;\n src = myLib.cleanTypstSource ./simple;\n };\n simpleWithFonts = myLib.buildTypstProject {\n inherit fontPaths typstSource;\n src = myLib.cleanTypstSource ./simple-with-fonts;\n };\n simpleWithMultipleParameters = myLib.buildTypstProject {\n inherit typstSource;\n src = myLib.cleanTypstSource ./simple-with-multiple-parameters;\n typstOpts = {\n input = [\"key1=value1\" \"key2=value2\" \"key3= --spaces-are-properly-escaped\" \"key4='quotes-are-properly-escaped\\\"\"];\n };\n };\n simpleWithVirtualPaths = myLib.buildTypstProject {\n inherit virtualPaths typstSource;\n src = myLib.cleanTypstSource ./simple-with-virtual-paths;\n };\n\n withTypstPackages = myLib.buildTypstProject {\n inherit typstSource;\n src = myLib.cleanTypstSource ./typst-packages;\n inherit unstable_typstPackages;\n };\n\n virtualPathsChecks = callPackage ./virtual-paths.nix {};\n\n watch = callPackage ./watch.nix {};\n watchSimple = watch {} {\n inherit typstSource;\n src = myLib.cleanTypstSource ./simple;\n };\n watchSimpleWithFonts = watch {} {\n inherit fontPaths typstSource;\n src = myLib.cleanTypstSource ./simple-with-fonts;\n };\n watchWithMultipleParameters = watch {} {\n inherit typstSource;\n src = myLib.cleanTypstSource ./simple-with-multiple-parameters;\n typstOpts = {\n input = [\"key1=value1\" \"key2=value2\" \"key3= --spaces-are-properly-escaped\" \"key4='quotes-are-properly-escaped\\\"\"];\n };\n };\n # TODO: see above\n # watchSimpleWithTypstPackages = watch {} {\n # inherit typstSource;\n # src = myLib.cleanTypstSource ./simple-with-typst-packages;\n # };\n watchSimpleWithVirtualPaths = watch {} {\n inherit virtualPaths typstSource;\n src = myLib.cleanTypstSource ./simple-with-virtual-paths;\n };\n\n watchOverlappingVirtualPaths = overlappingVirtualPathsInvariant watch \"icons/link.svg\";\n watchOverlappingVirtualPathsForce = overlappingVirtualPathsForce watch \"icons/link.svg\";\n }))\n"
},
{
"path": "checks/emoji/main.typ",
"content": "#(emoji.tangerine)hell#(emoji.o) w#(emoji.o)rld#(emoji.face)\n"
},
{
"path": "checks/overlapping-virtual-paths/main.typ",
"content": "#lorem(100)\n\n#image(\"icons/link.svg\")\n"
},
{
"path": "checks/simple/main.typ",
"content": "#lorem(100)\n"
},
{
"path": "checks/simple-with-fonts/main.typ",
"content": "#set text(font: \"Roboto\")\n\n#lorem(100)\n"
},
{
"path": "checks/simple-with-multiple-parameters/main.typ",
"content": "#sys.inputs.key1\n#sys.inputs.key2\n"
},
{
"path": "checks/simple-with-virtual-paths/main.typ",
"content": "#lorem(100)\n\n#image(\"icons/link.svg\")\n#image(\"icons/paper-plane-tilt.svg\")\n"
},
{
"path": "checks/typst-packages/main.typ",
"content": "#import \"@preview/example:0.1.0\": add\n#import \"@preview/cetz:0.3.4\"\n#import \"@preview/polylux:0.4.0\": slide, uncover\n\n// example\n\n2 + 2 = #[add(2 + 2)]\n\n// cetz\n\n#cetz.canvas({\n import cetz.draw: *\n\n circle((0, 0))\n line((0, 0), (2, 1))\n})\n\n// polylux\n\n// Make the paper dimensions fit for a presentation and the text larger\n#set page(paper: \"presentation-16-9\")\n#set text(size: 25pt)\n\n// Use #slide to create a slide and style it using your favourite Typst functions\n#slide[\n #set align(horizon)\n = Very minimalist slides\n\n A lazy author\n\n July 23, 2023\n]\n\n#slide[\n == First slide\n\n Some static text on this slide.\n]\n\n#slide[\n == This slide changes!\n\n You can always see this.\n // Make use of features like #uncover, #only, and others to create dynamic content\n #uncover(2)[But this appears later!]\n]\n"
},
{
"path": "checks/virtual-paths.nix",
"content": "{\n cleanTypstSource,\n copyVirtualPathsHook,\n lib,\n linkFarmFromDrvs,\n linkVirtualPaths,\n pkgs,\n}: let\n inherit (lib.attrsets) filterAttrs mapAttrsToList;\n inherit (lib.lists) all;\n inherit (lib.strings) toShellVars;\n\n cleanArgs = args:\n builtins.removeAttrs args [\n \"virtualPaths\"\n \"assertionCommand\"\n \"linkAssertionCommnad\"\n ];\n\n copyVirtualPathsHookAssertion = args @ {\n virtualPaths,\n assertionCommand,\n ...\n }:\n pkgs.stdenvNoCC.mkDerivation ((cleanArgs args)\n // {\n src = cleanTypstSource ./simple;\n nativeBuildInputs = [\n (copyVirtualPathsHook virtualPaths)\n ];\n buildPhase = ''\n runHook preBuild\n runHook postBuild\n '';\n postBuild = ''\n set -euo pipefail\n\n assertionCommand() {\n ${assertionCommand}\n }\n\n if ! assertionCommand; then\n ${toShellVars {assertionText = assertionCommand;}}\n echo \"assertion \\`$assertionText\\` failed\"\n exit 1\n fi\n\n touch \"$out\"\n '';\n });\n\n linkVirtualPathsAssertion = args @ {\n virtualPaths,\n assertionCommand,\n linkAssertionCommand ? \"true\",\n ...\n }:\n pkgs.stdenvNoCC.mkDerivation ((cleanArgs args)\n // {\n src = cleanTypstSource ./simple;\n buildPhase = ''\n ${linkVirtualPaths {inherit virtualPaths;}}\n runHook postBuild\n '';\n postBuild = ''\n set -euo pipefail\n\n assertionCommand() {\n ${assertionCommand}\n }\n\n linkAssertionCommand() {\n ${linkAssertionCommand}\n }\n\n if ! assertionCommand; then\n ${toShellVars {assertionText = assertionCommand;}}\n echo \"assertion \\`$assertionText\\` failed\"\n exit 1\n fi\n if ! linkAssertionCommand; then\n ${toShellVars {assertionText = linkAssertionCommand;}}\n echo \"assertion \\`$assertionText\\` failed\"\n exit 1\n fi\n\n touch \"$out\"\n '';\n });\n\n virtualPathsTestAttrs = {\n fileSource = {\n virtualPaths = [\"${./fixtures/icons}/link.svg\"];\n assertionCommand = ''[ -f ./link.svg ]'';\n linkAssertionCommand = ''[ -L ./link.svg ]'';\n };\n\n directorySource = {\n virtualPaths = [./fixtures/icons];\n assertionCommand = ''[ -f ./main.typ ] && [ -f ./link.svg ]'';\n linkAssertionCommand = ''[ -L ./link.svg ]'';\n };\n\n fileSourceWithDest = {\n virtualPaths = [\n {\n src = ./fixtures/icons/link.svg;\n dest = \"link.svg\";\n }\n ];\n assertionCommand = ''[ -f ./link.svg ]'';\n linkAssertionCommand = ''[ -L ./link.svg ]'';\n };\n\n directorySourceWithDest = {\n virtualPaths = [\n {\n src = ./fixtures/icons;\n dest = \"icons\";\n }\n ];\n assertionCommand = ''[ -d ./icons ] && [ -f ./icons/link.svg ]'';\n linkAssertionCommand = ''[ ! -L ./icons ] && [ -L ./icons/link.svg ]'';\n };\n\n fileSourceWithDeepDest = {\n virtualPaths = [\n {\n src = ./fixtures/icons/link.svg;\n dest = \"assets/icons/link.svg\";\n }\n ];\n assertionCommand = ''[ -d ./assets/icons ] && [ -f ./assets/icons/link.svg ]'';\n linkAssertionCommand = ''[ ! -L ./assets ] && [ ! -L ./assets/icons ] && [ -L ./assets/icons/link.svg ]'';\n };\n\n directorySourceWithDeepDest = {\n virtualPaths = [\n {\n src = ./fixtures/icons;\n dest = \"assets/icons\";\n }\n ];\n assertionCommand = ''[ -d ./assets/icons ] && [ -f ./assets/icons/link.svg ]'';\n linkAssertionCommand = ''[ ! -L ./assets ] && [ ! -L ./assets/icons ] && [ -L ./assets/icons/link.svg ]'';\n };\n\n mergedSources = {\n virtualPaths = [\n {\n src = ./fixtures/icons;\n dest = \"icons\";\n }\n {\n src = ./fixtures/more-icons;\n dest = \"icons\";\n }\n ];\n assertionCommand = ''[ -d ./icons ] && [ -f ./icons/link.svg ] && [ -f ./icons/another-link.svg ]'';\n linkAssertionCommand = ''[ ! -L ./icons ] && [ -L ./icons/link.svg ] && [ -L ./icons/another-link.svg ]'';\n };\n };\n\n skip = {\n copyVirtualPathsHook = [];\n linkVirtualPaths = [];\n };\n filterSkip = skipNames:\n filterAttrs\n (name: _: all (skipName: name != skipName) skipNames);\n\n mapTestAttrs = f: skipAttrs: testGroupName:\n mapAttrsToList\n (name: attrs: f (attrs // {name = \"${testGroupName}-${name}\";}))\n (filterSkip skipAttrs virtualPathsTestAttrs);\nin\n linkFarmFromDrvs \"virtualPathsTests\"\n (\n (mapTestAttrs copyVirtualPathsHookAssertion skip.copyVirtualPathsHook \"copyVirtualPathsHook\")\n ++ (mapTestAttrs linkVirtualPathsAssertion skip.linkVirtualPaths \"linkVirtualPaths\")\n )\n"
},
{
"path": "checks/watch.nix",
"content": "{\n lib,\n pkgs,\n watchTypstProject,\n}: runCommandDrvAttr: args: let\n cleanedArgs = builtins.removeAttrs args [\n \"src\"\n ];\n watch-drv = watchTypstProject ({\n name = \"watch-check\";\n # `typst watch` will never exit itself, but we can still check the exit status of `typst compile` for errors\n typstWatchCommand = \"typst compile\";\n }\n // cleanedArgs);\nin\n pkgs.runCommand \"watch\" (runCommandDrvAttr\n // {\n nativeBuildInputs =\n (runCommandDrvAttr.nativeBuildInputs or [])\n ++ [\n watch-drv\n ];\n }) ''\n # This is needed to imitate a user's project directory\n cp -RLT --no-preserve=mode ${args.src} .\n\n runHook preBuild\n ${lib.getExe watch-drv} \"$out\"\n runHook postBuild\n ''\n"
},
{
"path": "docs/.gitignore",
"content": "book\n"
},
{
"path": "docs/SUMMARY.md",
"content": "\n\n# Summary\n\n- [Introduction](README.md)\n- [Getting Started](getting-started.md)\n\n# Recipes\n\n- [Adding dependencies](recipes/adding-dependencies.md)\n- [Specifying sources](recipes/specifying-sources.md)\n- [Declaring a shell environment](recipes/declaring-a-shell-environment.md)\n- [Using Typst packages](recipes/using-typst-packages.md)\n\n# API Reference\n\n- [Derivations](api/derivations.md)\n - [buildTypstProject](api/derivations/build-typst-project.md)\n - [buildTypstProjectLocal](api/derivations/build-typst-project-local.md)\n - [devShell](api/derivations/dev-shell.md)\n - [mkTypstDerivation](api/derivations/mk-typst-derivation.md)\n - [watchTypstProject](api/derivations/watch-typst-project.md)\n- [Utilities](api/utilities.md)\n - [cleanTypstSource](api/utilities/clean-typst-source.md)\n"
},
{
"path": "docs/api/derivations/build-typst-project-local.md",
"content": "# buildTypstProjectLocal\n\nReturns a derivation for compiling a Typst project and copying the output to the\ncurrent directory.\n\nThis is essentially a script which wraps\n[`buildTypstProject`](build-typst-project.md).\n\n
\n\nUsing this derivation requires\n[`allow-import-from-derivation`](https://nixos.org/manual/nix/stable/command-ref/conf-file#conf-allow-import-from-derivation)\nto be `true` (which is the default at the time of writing).\n\nMore info: \n\n
\n\n
\n\nInvoking the script produced by this derivation directly is currently\nunsupported. Instead, use `nix run`.\n\nSee [this issue](https://github.com/loqusion/typix/issues/2) for more\ninformation.\n\n
\n\n## Parameters\n\nAll parameters accepted by\n[`buildTypstProject`](build-typst-project.md#parameters) are also accepted by\n`buildTypstProjectLocal`. They are repeated below for convenience.\n\n### `src`\n\n{{#include common/src.md}}\n\n### `emojiFont` optional { #emojifont }\n\n{{#include common/emoji-font.md}}\n\n### `fontPaths` optional { #fontpaths }\n\n{{#include common/font-paths.md}}\n\n#### Example { #fontpaths-example }\n\n{{#include common/font-paths-example.md:buildtypstprojectlocal_example}}\n\n### `installPhaseCommand` optional { #installphasecommand }\n\n{{#include common/install-phase-command.md}}\n\n### `scriptName` optional { #scriptname }\n\n{{#include common/script-name.md}}\n\nDefault is `typst-build`.\n\n### `typstCompileCommand` optional { #typstcompilecommand }\n\n{{#include common/typst-compile-command.md}}\n\nDefault is `typst compile`.\n\n### `typstOpts` optional { #typstopts }\n\n{{#include common/typst-opts.md:head}}\n\n\n\nThese are in addition to any options you manually pass in\n[`typstCompileCommand`](#typstcompilecommand).\n\n\n\n{{#include common/typst-opts.md:tail}}\n\n#### Example { #typstopts-example }\n\n{{#include common/typst-opts-example.md:buildtypstprojectlocal}}\n{{#include common/typst-opts-example.md:typstcompile}}\n\n### `typstOutput` optional { #typstoutput }\n\n{{#include common/typst-project-output.md:head}}\n{{#include common/typst-project-output.md:buildtypstprojectlocal}}\n\n### `typstSource` optional { #typstsource }\n\n{{#include common/typst-project-source.md}}\n\nDefault is `main.typ`.\n\n### `unstable_typstPackages` optional { #typstpackages }\n\n{{#include common/typst-packages.md:body}}\n\n#### Example { #typstpackages-example }\n\n{{#include common/typst-packages.md:example_buildtypstprojectlocal}}\n{{#include common/typst-packages.md:example_typst}}\n\n### `virtualPaths` optional { #virtualpaths }\n\n{{#include common/virtual-paths.md}}\n\n#### Example { #virtualpaths-example }\n\n{{#include common/virtual-paths-example.md:head}}\n{{#include common/virtual-paths-example.md:buildtypstprojectlocal_example}}\n{{#include common/virtual-paths-example.md:tail}}\n\n## Source\n\n- [`buildTypstProjectLocal`](https://github.com/loqusion/typix/blob/main/lib/buildTypstProjectLocal.nix)\n"
},
{
"path": "docs/api/derivations/build-typst-project.md",
"content": "# buildTypstProject\n\nReturns a derivation for compiling a Typst project.\n\nIf you want to build to the project directory, use\n[`buildTypstProjectLocal`](build-typst-project-local.md) instead.\n\n## Parameters\n\nAll parameters accepted by\n[`mkTypstDerivation`](mk-typst-derivation.md#parameters) are also accepted by\n`buildTypstProject`. They are repeated below for convenience.\n\n### `src`\n\n{{#include common/src.md}}\n\n### `emojiFont` optional { #emojifont }\n\n{{#include common/emoji-font.md}}\n\n### `fontPaths` optional { #fontpaths }\n\n{{#include common/font-paths.md}}\n\n#### Example { #fontpaths-example }\n\n{{#include common/font-paths-example.md:buildtypstproject_example}}\n\n### `installPhaseCommand` optional { #installphasecommand }\n\n{{#include common/install-phase-command.md}}\n\n### `typstCompileCommand` optional { #typstcompilecommand }\n\n{{#include common/typst-compile-command.md}}\n\nDefault is `typst compile`.\n\n### `typstOpts` optional { #typstopts }\n\n{{#include common/typst-opts.md:head}}\n\n\n\nThese are in addition to any options you manually pass in\n[`typstCompileCommand`](#typstcompilecommand).\n\n\n\n{{#include common/typst-opts.md:tail}}\n\n#### Example { #typstopts-example }\n\n{{#include common/typst-opts-example.md:buildtypstproject}}\n{{#include common/typst-opts-example.md:typstcompile}}\n\n### `typstSource` optional { #typstsource }\n\n{{#include common/typst-project-source.md}}\n\nDefault is `main.typ`.\n\n### `unstable_typstPackages` optional { #typstpackages }\n\n{{#include common/typst-packages.md:body}}\n\n#### Example { #typstpackages-example }\n\n{{#include common/typst-packages.md:example_buildtypstproject}}\n{{#include common/typst-packages.md:example_typst}}\n\n### `virtualPaths` optional { #virtualpaths }\n\n{{#include common/virtual-paths.md}}\n\n#### Example { #virtualpaths-example }\n\n{{#include common/virtual-paths-example.md:head}}\n{{#include common/virtual-paths-example.md:buildtypstproject_example}}\n{{#include common/virtual-paths-example.md:tail}}\n\n## Source\n\n- [`buildTypstProject`](https://github.com/loqusion/typix/blob/main/lib/buildTypstProject.nix)\n"
},
{
"path": "docs/api/derivations/common/emoji-font.md",
"content": "Specify which emoji font to use. If `emojiFont` is `null`, no emoji font will\nbe included.\n\nMay be any of the following:\n\n- [`\"twemoji\"`](https://search.nixos.org/packages?channel=unstable&show=twemoji-color-font) (default)\n- [`\"twemoji-cbdt\"`](https://search.nixos.org/packages?channel=unstable&show=twitter-color-emoji)\n- [`\"noto\"`](https://search.nixos.org/packages?channel=unstable&show=noto-fonts-color-emoji)\n- [`\"noto-monochrome\"`](https://search.nixos.org/packages?channel=unstable&show=noto-fonts-monochrome-emoji)\n- [`\"emojione\"`](https://search.nixos.org/packages?channel=unstable&show=emojione)\n- `null` — Don't include any emoji font (e.g. so you can include your own)\n\n\nNote about difference between \"twemoji\" and \"twemoji-cbdt\"\n\nThe default Twemoji font displays color emojis using the SVG [font format],\nwhich may not be supported by some systems. If emojis aren't displaying\nproperly, using `\"twemoji-cbdt\"` may fix it.\n\n[font format]: https://www.colorfonts.wtf/\n\n\n"
},
{
"path": "docs/api/derivations/common/font-paths-example.md",
"content": "\n\n\n\n```nix\n{\n outputs = { nixpkgs, typix }: let\n system = \"x86_64-linux\";\n pkgs = nixpkgs.legacyPackages.${system};\n inherit (pkgs) lib;\n\n build-script = typix.lib.${system}.buildTypstProjectLocal {\n fontPaths = [\n \"${pkgs.roboto}/share/fonts/truetype\"\n ];\n };\n in {\n apps.${system}.default = {\n type = \"app\";\n program = lib.getExe build-script;\n };\n };\n}\n```\n\n\n\n\n\n```nix\n{\n outputs = { nixpkgs, typix }: let\n system = \"x86_64-linux\";\n pkgs = nixpkgs.legacyPackages.${system};\n in {\n packages.${system}.default = typix.lib.${system}.buildTypstProject {\n fontPaths = [\n \"${pkgs.roboto}/share/fonts/truetype\"\n ];\n };\n };\n}\n```\n\n\n\n\n\n```nix\n{\n outputs = { nixpkgs, typix }: let\n system = \"x86_64-linux\";\n pkgs = nixpkgs.legacyPackages.${system};\n in {\n devShells.${system}.default = typix.lib.${system}.devShell {\n fontPaths = [\n \"${pkgs.roboto}/share/fonts/truetype\"\n ];\n };\n };\n}\n```\n\n\n\n\n\n```nix\n{\n outputs = { nixpkgs, typix }: let\n system = \"x86_64-linux\";\n pkgs = nixpkgs.legacyPackages.${system};\n in {\n packages.${system}.default = typix.lib.${system}.mkTypstDerivation {\n fontPaths = [\n \"${pkgs.roboto}/share/fonts/truetype\"\n ];\n };\n };\n}\n```\n\n\n\n\n\n```nix\n{\n outputs = { nixpkgs, typix }: let\n system = \"x86_64-linux\";\n pkgs = nixpkgs.legacyPackages.${system};\n inherit (pkgs) lib;\n\n watch-script = typix.lib.${system}.watchTypstProject {\n fontPaths = [\n \"${pkgs.roboto}/share/fonts/truetype\"\n ];\n };\n in {\n apps.${system}.default = {\n type = \"app\";\n program = lib.getExe watch-script;\n };\n };\n}\n```\n\n\n"
},
{
"path": "docs/api/derivations/common/font-paths.md",
"content": "\n\nList of sources specifying paths to font files that will be made available to\nyour Typst project. With this, you can compile Typst projects even when the\nfonts it uses are not available on your system.\n\nUsed for setting `TYPST_FONT_PATHS` (see [`text#font`][typst-ref-text--font]).\n\n[typst-ref-text--font]: https://typst.app/docs/reference/text/text/#parameters-font\n"
},
{
"path": "docs/api/derivations/common/install-phase-command.md",
"content": "\n\nCommand (or commands) to run during\n[`installPhase`][nixpkgs-installphase].\n\n[nixpkgs-installphase]: https://nixos.org/manual/nixpkgs/stable/#ssec-install-phase\n"
},
{
"path": "docs/api/derivations/common/script-name.md",
"content": "\n\nName of the script that will be added to the Nix store. You can use this name\nafter entering a development shell to invoke the script.\n"
},
{
"path": "docs/api/derivations/common/src.md",
"content": "\n\n[Source](../../recipes/specifying-sources.md) containing all local files\nneeded in your Typst project.\n"
},
{
"path": "docs/api/derivations/common/typst-compile-command.md",
"content": "\n\nBase Typst command to run to compile the project. Other arguments will be\nappended based on the parameters you supply.\n"
},
{
"path": "docs/api/derivations/common/typst-opts-example.md",
"content": "\n\n\n\n```nix\n{\n format = \"png\";\n ppi = 300;\n input = [\"key1=value1\" \"key2=value2\"];\n}\n```\n\n...will result in a command like:\n\n\n\n\n\n```nix\n{\n outputs = { typix }: let\n system = \"x86_64-linux\";\n in {\n packages.${system}.default = typix.lib.${system}.buildTypstProject {\n typstOpts = {\n format = \"png\";\n ppi = 300;\n input = [\"key1=value1\" \"key2=value2\"];\n };\n };\n };\n}\n```\n\n...will result in a command like:\n\n\n\n\n\n```nix\n{\n outputs = { typix }: let\n system = \"x86_64-linux\";\n inherit (nixpkgs) lib;\n\n build-script = typix.lib.${system}.buildTypstProjectLocal {\n typstOpts = {\n format = \"png\";\n ppi = 300;\n input = [\"key1=value1\" \"key2=value2\"];\n };\n };\n in {\n apps.${system}.default = {\n type = \"app\";\n program = lib.getExe build-script;\n };\n };\n}\n```\n\n...will result in a command like:\n\n\n\n\n\n```nix\n{\n outputs = { typix }: let\n system = \"x86_64-linux\";\n inherit (nixpkgs) lib;\n\n watch-script = typix.lib.${system}.watchTypstProject {\n typstOpts = {\n format = \"png\";\n ppi = 300;\n input = [\"key1=value1\" \"key2=value2\"];\n };\n };\n in {\n apps.${system}.default = {\n type = \"app\";\n program = lib.getExe watch-script;\n };\n };\n}\n```\n\n...will result in a command like:\n\n\n\n\n\n```sh\ntypst compile --format png --ppi 300 --input key1=value1 --input key2=value2