Typst manifesto (SchemaStore#4662)

jassielof · pre-commit-ci[bot] · web-flow · commit 6a8d70c729f5 · 2025-04-22T12:34:39.000-07:00
* json * rename * tests, catalog and no strict * fix: - author, license and description not required but specified on each's description - description guidelines - simpler version - authors email - simpler compiler version - invalid test * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
diff --git a/src/api/json/catalog.json b/src/api/json/catalog.json
@@ -5577,6 +5577,12 @@
       "fileMatch": ["**/sites/*/config.yaml", "**/sites/*/config.yml"],
       "url": "https://json.schemastore.org/typo3.json"
     },
+    {
+      "name": "Typst Manifest",
+      "description": "Typst package manifest file (typst.toml)",
+      "fileMatch": ["typst.toml"],
+      "url": "https://json.schemastore.org/typst.json"
+    },
     {
       "name": "typos.toml",
       "description": "typos configuration file",
diff --git a/src/negative_test/typst/invalid-author-type.toml b/src/negative_test/typst/invalid-author-type.toml
@@ -0,0 +1,9 @@
+#:schema ../../schemas/json/typst.json
+# Fails because package.authors is not an array
+[package]
+name = "wrong-authors"
+version = "0.1.0"
+entrypoint = "lib.typ"
+authors = "Just Me"                       # INVALID TYPE (should be array)
+license = "MIT"
+description = "Authors should be a list."
diff --git a/src/negative_test/typst/invalid-missing-required.toml b/src/negative_test/typst/invalid-missing-required.toml
@@ -0,0 +1,9 @@
+#:schema ../../schemas/json/typst.json
+# Fails because package.version is missing
+[package]
+name = "missing-version"
+# version = "0.1.0" # MISSING
+entrypoint = "lib.typ"
+authors = ["Incomplete Author"]
+license = "MIT"
+description = "This package is missing a version."
diff --git a/src/negative_test/typst/invalid-name-pattern.toml b/src/negative_test/typst/invalid-name-pattern.toml
@@ -0,0 +1,9 @@
+#:schema ../../schemas/json/typst.json
+# Fails because package.name contains uppercase characters
+[package]
+name = "Invalid-Name"                             # INVALID PATTERN
+version = "0.1.0"
+entrypoint = "lib.typ"
+authors = ["Rule Breaker"]
+license = "MIT"
+description = "This package has an invalid name."
diff --git a/src/negative_test/typst/invalid-version-pattern.toml b/src/negative_test/typst/invalid-version-pattern.toml
@@ -0,0 +1,9 @@
+#:schema ../../schemas/json/typst.json
+# Fails because package.version is not a valid SemVer string
+[package]
+name = "bad-version"
+version = "1.2"                                             # INVALID PATTERN (missing patch)
+entrypoint = "lib.typ"
+authors = ["Version Violator"]
+license = "MIT"
+description = "This package has an invalid version format."
diff --git a/src/schema-validation.jsonc b/src/schema-validation.jsonc
@@ -206,6 +206,7 @@
     "tsoa.json",
     "typings.json",
     "typingsrc.json",
+    "typst.json",
     "typo3.json",
     "ubuntu-server-autoinstall.json",
     "utam-page-object.json",
diff --git a/src/schemas/json/typst.json b/src/schemas/json/typst.json
@@ -0,0 +1,238 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://json.schemastore.org/typst.json",
+  "title": "Typst Package Manifest",
+  "description": "Schema for typst.toml package manifest files, used by the Typst package manager and universe.",
+  "type": "object",
+  "required": ["package"],
+  "properties": {
+    "package": {
+      "type": "object",
+      "description": "Contains metadata about the package.",
+      "required": ["name", "version", "entrypoint"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The package's identifier in its namespace. Should use kebab-case if it contains multiple words. Should not contain 'typst'. See https://github.com/typst/packages/tree/main?tab=readme-ov-file#submission-guidelines for detailed requirements.",
+          "pattern": "^[a-z0-9][a-z0-9\\-]*$",
+          "examples": ["my-package", "example", "uni-stuttgart-template"]
+        },
+        "version": {
+          "type": "string",
+          "description": "The package's version as a full major-minor-patch triple (following SemVer, no pre-release or build tags). See https://semver.org/",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$",
+          "examples": ["1.0.0", "0.2.1"]
+        },
+        "entrypoint": {
+          "type": "string",
+          "description": "The path to the main Typst file (relative to the package root) that is evaluated when the package is imported.",
+          "examples": ["lib.typ", "src/main.typ"]
+        },
+        "authors": {
+          "type": "array",
+          "description": "A list of the package's authors. Each author can provide an email address (<user@example.com>), homepage (<https://example.com>), or GitHub handle (<@typst>) in angle brackets. Required for Typst Universe submission.",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1,
+          "examples": [
+            ["Jane Doe <jane.doe@example.com>", "John Doe <@johndoe>"],
+            ["Typst GmbH <https://typst.app>"]
+          ]
+        },
+        "license": {
+          "type": "string",
+          "description": "The package's license. Must contain a valid SPDX 2.3 expression describing one or multiple licenses that are either OSI-approved (https://opensource.org/licenses/) or CC-BY-4.0, CC-BY-SA-4.0, or CC0-1.0. See https://spdx.dev/learn/handling-license-info/. Required for Typst Universe submission.",
+          "examples": [
+            "MIT",
+            "Apache-2.0",
+            "GPL-3.0-or-later",
+            "MIT OR Apache-2.0",
+            "CC-BY-SA-4.0"
+          ]
+        },
+        "description": {
+          "type": "string",
+          "description": "A short, clear description of the package (one sentence recommended). Required for Typst Universe submission."
+        },
+        "homepage": {
+          "type": "string",
+          "description": "A URL to the package's web presence (e.g., documentation website).",
+          "format": "uri",
+          "examples": ["https://example.com/my-package-docs"]
+        },
+        "repository": {
+          "type": "string",
+          "description": "A URL to the repository where this package is developed (e.g., GitHub, GitLab). Used if homepage is not set.",
+          "format": "uri",
+          "examples": ["https://github.com/user/my-package"]
+        },
+        "keywords": {
+          "type": "array",
+          "description": "An array of search keywords for the package.",
+          "items": {
+            "type": "string"
+          },
+          "uniqueItems": true,
+          "examples": [
+            ["chart", "plot", "data visualization"],
+            ["ieee", "template", "paper"]
+          ]
+        },
+        "categories": {
+          "type": "array",
+          "description": "An array with up to three categories from the official list to help users discover the package.",
+          "items": {
+            "type": "string",
+            "enum": [
+              "components",
+              "visualization",
+              "model",
+              "layout",
+              "text",
+              "languages",
+              "scripting",
+              "integration",
+              "utility",
+              "fun",
+              "book",
+              "report",
+              "paper",
+              "thesis",
+              "poster",
+              "flyer",
+              "presentation",
+              "cv",
+              "office"
+            ]
+          },
+          "maxItems": 3,
+          "uniqueItems": true,
+          "examples": [
+            ["visualization", "components"],
+            ["paper", "layout"]
+          ]
+        },
+        "disciplines": {
+          "type": "array",
+          "description": "An array of disciplines from the official list defining the target audience. Should be empty if generally applicable.",
+          "items": {
+            "type": "string",
+            "enum": [
+              "agriculture",
+              "anthropology",
+              "archaeology",
+              "architecture",
+              "biology",
+              "business",
+              "chemistry",
+              "communication",
+              "computer-science",
+              "design",
+              "drawing",
+              "economics",
+              "education",
+              "engineering",
+              "fashion",
+              "film",
+              "geography",
+              "geology",
+              "history",
+              "journalism",
+              "law",
+              "linguistics",
+              "literature",
+              "mathematics",
+              "medicine",
+              "music",
+              "painting",
+              "philosophy",
+              "photography",
+              "physics",
+              "politics",
+              "psychology",
+              "sociology",
+              "theater",
+              "theology",
+              "transportation"
+            ]
+          },
+          "uniqueItems": true,
+          "examples": [["computer-science", "mathematics"], ["physics"]]
+        },
+        "compiler": {
+          "type": "string",
+          "description": "The minimum Typst compiler version required for this package to work (SemVer format). Partial versions like '0' or '0.13' are supported. Pre-release tags are not supported.",
+          "pattern": "^(0|[1-9]\\d*)(\\.(0|[1-9]\\d*)){0,2}$",
+          "examples": ["0", "0.13", "0.8.0", "1.0.0"]
+        },
+        "exclude": {
+          "type": "array",
+          "description": "An array of globs specifying files (relative to package root) that should not be part of the published bundle. Do not exclude README or LICENSE.",
+          "items": {
+            "type": "string"
+          },
+          "examples": [["docs/", "*.pdf", "images/draft*.png"]]
+        }
+      },
+      "additionalProperties": false
+    },
+    "template": {
+      "type": "object",
+      "description": "If present, declares this package as a template.",
+      "required": ["path", "entrypoint", "thumbnail"],
+      "properties": {
+        "path": {
+          "type": "string",
+          "description": "The directory within the package (relative to package root) containing files to be copied into the user's new project directory.",
+          "examples": ["template", "skeleton"]
+        },
+        "entrypoint": {
+          "type": "string",
+          "description": "Path relative to the template 'path' directory pointing to the main file to be compiled after initialization.",
+          "examples": ["main.typ", "report.typ"]
+        },
+        "thumbnail": {
+          "type": "string",
+          "description": "Path relative to the package root pointing to a PNG or lossless WebP thumbnail (min 1080px on longer edge, max 3MB) depicting the initialized template.",
+          "pattern": "\\.(png|PNG|webp|WEBP)$",
+          "examples": ["thumbnail.png", "preview.webp"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "tool": {
+      "type": "object",
+      "description": "Namespace for third-party tools to store their own configuration.",
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "if": {
+        "required": ["template"]
+      },
+      "then": {
+        "properties": {
+          "package": {
+            "required": [
+              "name",
+              "version",
+              "entrypoint",
+              "authors",
+              "license",
+              "description",
+              "categories"
+            ],
+            "properties": {
+              "categories": {
+                "minItems": 1
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}
diff --git a/src/test/typst/full-package.toml b/src/test/typst/full-package.toml
@@ -0,0 +1,21 @@
+#:schema ../../schemas/json/typst.json
+# A package using many optional fields
+[package]
+name = "my-feature-rich-package"
+version = "1.2.3"
+entrypoint = "src/main.typ"
+authors = ["Dev One <@dev1>", "Dev Two <https://example.com/dev2>"]
+license = "Apache-2.0 OR MIT"
+description = "A package demonstrating most of the available fields."
+homepage = "https://example.com/my-package"
+repository = "https://github.com/user/my-feature-rich-package"
+keywords = ["utility", "example", "testing"]
+categories = ["utility", "scripting"]
+disciplines = ["computer-science"]
+compiler = "0.11"
+exclude = ["docs/", "*.pdf", "images/logo.png"]
+
+# No template section
+
+[tool.my-formatter]
+line-width = 80
diff --git a/src/test/typst/valid-basic-package.toml b/src/test/typst/valid-basic-package.toml
@@ -0,0 +1,12 @@
+#:schema ../../schemas/json/typst.json
+# A minimal valid package manifest
+[package]
+name = "my-basic-pkg"
+version = "0.1.0"
+entrypoint = "lib.typ"
+authors = ["Example Author <author@example.com>"]
+license = "MIT"
+description = "This is a minimal but valid package."
+
+# No template section
+# No tool section
diff --git a/src/test/typst/valid-template.toml b/src/test/typst/valid-template.toml
@@ -0,0 +1,19 @@
+#:schema ../../schemas/json/typst.json
+# A valid template package manifest
+[package]
+name = "simple-report-template"
+version = "0.2.0"
+entrypoint = "lib.typ"                               # Package entrypoint (for potential imports)
+authors = ["Template Creator <https://example.com>"]
+license = "CC0-1.0"                                  # License suitable for template content
+description = "A simple report template."
+# Template requires at least one category
+categories = ["report"]
+keywords = ["template", "report", "academic"]
+disciplines = ["education"]
+compiler = "0.10.0"
+
+[template]
+path = "template_files"
+entrypoint = "main.typ"            # Relative to template_files/
+thumbnail = "assets/thumbnail.png" # Relative to package root
