Compare commits

...

8 Commits

Author SHA1 Message Date
Malo
2abae7e00f
Merge 44bb2da4624b2d0114c049bb2bd2394e2ca0399e into f51cb4b03e9712b8eb404f8184a17ee4a63aaab2 2025-07-14 21:02:03 +03:00
Robin
f51cb4b03e
Rephrase docs for truncation of float/decimal to integer (#6543) 2025-07-14 13:31:27 +00:00
Robin
0c12828c9a
Fix minor typo in text docs (#6589) 2025-07-14 13:26:25 +00:00
Robin
b1a091a236
Use "whitespace" instead of "space" to denote block-level equation in docs (#6591) 2025-07-14 13:26:10 +00:00
Malo
44bb2da462 Improve target documentations 2025-06-26 20:06:16 +01:00
Malo
54809020bf Make --target optional 2025-06-26 20:04:46 +01:00
Malo
fee95dd0b0 Merge branch 'main' into query-html-export
# Conflicts:
#	crates/typst-cli/src/query.rs
#	crates/typst-library/src/diag.rs
2025-06-24 19:44:59 +01:00
Malo
8684daa17c Add --target argument for typst query 2025-06-07 19:33:12 +01:00
6 changed files with 44 additions and 15 deletions

View File

@ -155,6 +155,10 @@ pub struct QueryCommand {
#[clap(long)]
pub pretty: bool,
/// The target to compile for.
#[clap(long, default_value_t)]
pub target: Target,
/// World arguments.
#[clap(flatten)]
pub world: WorldArgs,
@ -457,6 +461,18 @@ pub enum OutputFormat {
display_possible_values!(OutputFormat);
/// The target to compile for.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, ValueEnum)]
pub enum Target {
/// PDF and image formats.
#[default]
Paged,
/// HTML.
Html,
}
display_possible_values!(Target);
/// Which format to use for diagnostics.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, ValueEnum)]
pub enum DiagnosticFormat {

View File

@ -4,12 +4,13 @@ use serde::Serialize;
use typst::diag::{bail, HintedStrResult, StrResult, Warned};
use typst::engine::Sink;
use typst::foundations::{Content, IntoValue, LocatableSelector, Scope};
use typst::html::HtmlDocument;
use typst::layout::PagedDocument;
use typst::syntax::{Span, SyntaxMode};
use typst::World;
use typst::{Document, World};
use typst_eval::eval_string;
use crate::args::{QueryCommand, SerializationFormat};
use crate::args::{QueryCommand, SerializationFormat, Target};
use crate::compile::print_diagnostics;
use crate::set_failed;
use crate::world::SystemWorld;
@ -22,12 +23,17 @@ pub fn query(command: &QueryCommand) -> HintedStrResult<()> {
world.reset();
world.source(world.main()).map_err(|err| err.to_string())?;
let Warned { output, warnings } = typst::compile(&world);
let Warned { output, warnings } = match command.target {
Target::Paged => typst::compile::<PagedDocument>(&world)
.map(|output| output.map(|document| retrieve(&world, command, &document))),
Target::Html => typst::compile::<HtmlDocument>(&world)
.map(|output| output.map(|document| retrieve(&world, command, &document))),
};
match output {
// Retrieve and print query results.
Ok(document) => {
let data = retrieve(&world, command, &document)?;
Ok(data) => {
let data = data?;
let serialized = format(data, command)?;
println!("{serialized}");
print_diagnostics(&world, &[], &warnings, command.process.diagnostic_format)
@ -51,10 +57,10 @@ pub fn query(command: &QueryCommand) -> HintedStrResult<()> {
}
/// Retrieve the matches for the selector.
fn retrieve(
fn retrieve<D: Document>(
world: &dyn World,
command: &QueryCommand,
document: &PagedDocument,
document: &D,
) -> HintedStrResult<Vec<Content>> {
let selector = eval_string(
&typst::ROUTINES,
@ -77,7 +83,7 @@ fn retrieve(
.cast::<LocatableSelector>()?;
Ok(document
.introspector
.introspector()
.query(&selector.0)
.into_iter()
.collect::<Vec<_>>())

View File

@ -151,6 +151,13 @@ pub struct Warned<T> {
pub warnings: EcoVec<SourceDiagnostic>,
}
impl<T> Warned<T> {
/// Maps the output, keeping the same warnings.
pub fn map<R, F: FnOnce(T) -> R>(self, f: F) -> Warned<R> {
Warned { output: f(self.output), warnings: self.warnings }
}
}
/// An error or warning in a source or text file.
///
/// The contained spans will only be detached if any of the input source files

View File

@ -46,7 +46,7 @@ impl i64 {
/// or smaller than the minimum 64-bit signed integer.
///
/// - Booleans are converted to `0` or `1`.
/// - Floats and decimals are truncated to the next 64-bit integer.
/// - Floats and decimals are rounded to the next 64-bit integer towards zero.
/// - Strings are parsed in base 10.
///
/// ```example

View File

@ -20,8 +20,8 @@ use crate::text::{FontFamily, FontList, FontWeight, LocalName, TextElem};
/// A mathematical equation.
///
/// Can be displayed inline with text or as a separate block. An equation
/// becomes block-level through the presence of at least one space after the
/// opening dollar sign and one space before the closing dollar sign.
/// becomes block-level through the presence of whitespace after the opening
/// dollar sign and whitespace before the closing dollar sign.
///
/// # Example
/// ```example
@ -41,9 +41,9 @@ use crate::text::{FontFamily, FontList, FontWeight, LocalName, TextElem};
///
/// # Syntax
/// This function also has dedicated syntax: Write mathematical markup within
/// dollar signs to create an equation. Starting and ending the equation with at
/// least one space lifts it into a separate block that is centered
/// horizontally. For more details about math syntax, see the
/// dollar signs to create an equation. Starting and ending the equation with
/// whitespace lifts it into a separate block that is centered horizontally.
/// For more details about math syntax, see the
/// [main math page]($category/math).
#[elem(Locatable, Synthesize, ShowSet, Count, LocalName, Refable, Outlinable)]
pub struct EquationElem {

View File

@ -92,7 +92,7 @@ pub(super) fn define(global: &mut Scope) {
/// ```
#[elem(Debug, Construct, PlainText, Repr)]
pub struct TextElem {
/// A font family descriptor or priority list of font family descriptor.
/// A font family descriptor or priority list of font family descriptors.
///
/// A font family descriptor can be a plain string representing the family
/// name or a dictionary with the following keys: