mirror of
https://github.com/typst/typst
synced 2025-07-27 22:37:54 +08:00
Compare commits
11 Commits
5953a60f06
...
a656d35daf
Author | SHA1 | Date | |
---|---|---|---|
|
a656d35daf | ||
|
b790c6d59c | ||
|
b1c79b50d4 | ||
|
4629ede020 | ||
|
01f73c35ed | ||
|
fb0b01d45c | ||
|
801b689dae | ||
|
d799a4207b | ||
|
72c219d24a | ||
|
ea3ca30a65 | ||
|
a517a08d2f |
@ -173,8 +173,11 @@ typst help
|
|||||||
typst help watch
|
typst help watch
|
||||||
```
|
```
|
||||||
|
|
||||||
If you prefer an integrated IDE-like experience with autocompletion and instant
|
If you prefer an integrated IDE-like experience with autocompletion and instant
|
||||||
preview, you can also check out [Typst's free web app][app].
|
preview, you can also check out our [free web app][app]. Alternatively, there is
|
||||||
|
a community-created language server called
|
||||||
|
[Tinymist](https://myriad-dreamin.github.io/tinymist/) which is integrated into
|
||||||
|
various editor extensions.
|
||||||
|
|
||||||
## Community
|
## Community
|
||||||
The main places where the community gathers are our [Forum][forum] and our
|
The main places where the community gathers are our [Forum][forum] and our
|
||||||
|
@ -7,6 +7,7 @@ use typst_library::foundations::{
|
|||||||
};
|
};
|
||||||
use typst_library::introspection::{Counter, State};
|
use typst_library::introspection::{Counter, State};
|
||||||
use typst_syntax::ast::{self, AstNode};
|
use typst_syntax::ast::{self, AstNode};
|
||||||
|
use typst_syntax::Span;
|
||||||
use typst_utils::singleton;
|
use typst_utils::singleton;
|
||||||
|
|
||||||
use crate::{CapturesVisitor, Eval, FlowEvent, Vm};
|
use crate::{CapturesVisitor, Eval, FlowEvent, Vm};
|
||||||
@ -284,8 +285,19 @@ impl Eval for ast::CodeBlock<'_> {
|
|||||||
type Output = Value;
|
type Output = Value;
|
||||||
|
|
||||||
fn eval(self, vm: &mut Vm) -> SourceResult<Self::Output> {
|
fn eval(self, vm: &mut Vm) -> SourceResult<Self::Output> {
|
||||||
|
let body = self.body();
|
||||||
|
match body.exprs().next_back() {
|
||||||
|
Some(expr @ ast::Expr::ShowRule(_)) => {
|
||||||
|
warn_for_useless_rule(&mut vm.engine, expr.span(), "show")
|
||||||
|
}
|
||||||
|
Some(expr @ ast::Expr::SetRule(_)) => {
|
||||||
|
warn_for_useless_rule(&mut vm.engine, expr.span(), "set")
|
||||||
|
}
|
||||||
|
_ => {}
|
||||||
|
}
|
||||||
|
|
||||||
vm.scopes.enter();
|
vm.scopes.enter();
|
||||||
let output = self.body().eval(vm)?;
|
let output = body.eval(vm)?;
|
||||||
vm.scopes.exit();
|
vm.scopes.exit();
|
||||||
Ok(output)
|
Ok(output)
|
||||||
}
|
}
|
||||||
@ -393,3 +405,12 @@ fn warn_for_discarded_content(engine: &mut Engine, event: &FlowEvent, joined: &V
|
|||||||
|
|
||||||
engine.sink.warn(warning);
|
engine.sink.warn(warning);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Emits a warning when a set or show rule has no effect.
|
||||||
|
fn warn_for_useless_rule(engine: &mut Engine, span: Span, kind: &str) {
|
||||||
|
engine.sink.warn(warning!(
|
||||||
|
span,
|
||||||
|
"{kind} rule has no effect";
|
||||||
|
hint: "a {kind} rule is only in effect until the end of the surrounding code block"
|
||||||
|
));
|
||||||
|
}
|
||||||
|
@ -797,7 +797,9 @@ impl Color {
|
|||||||
components
|
components
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the constructor function for this color's space:
|
/// Returns the constructor function for this color's space.
|
||||||
|
///
|
||||||
|
/// Returns one of:
|
||||||
/// - [`luma`]($color.luma)
|
/// - [`luma`]($color.luma)
|
||||||
/// - [`oklab`]($color.oklab)
|
/// - [`oklab`]($color.oklab)
|
||||||
/// - [`oklch`]($color.oklch)
|
/// - [`oklch`]($color.oklch)
|
||||||
|
@ -242,7 +242,7 @@ fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
|
|||||||
items.push(CategoryItem {
|
items.push(CategoryItem {
|
||||||
name: group.name.clone(),
|
name: group.name.clone(),
|
||||||
route: subpage.route.clone(),
|
route: subpage.route.clone(),
|
||||||
oneliner: oneliner(docs).into(),
|
oneliner: oneliner(docs),
|
||||||
code: true,
|
code: true,
|
||||||
});
|
});
|
||||||
children.push(subpage);
|
children.push(subpage);
|
||||||
@ -296,7 +296,7 @@ fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
|
|||||||
items.push(CategoryItem {
|
items.push(CategoryItem {
|
||||||
name: name.into(),
|
name: name.into(),
|
||||||
route: subpage.route.clone(),
|
route: subpage.route.clone(),
|
||||||
oneliner: oneliner(func.docs().unwrap_or_default()).into(),
|
oneliner: oneliner(func.docs().unwrap_or_default()),
|
||||||
code: true,
|
code: true,
|
||||||
});
|
});
|
||||||
children.push(subpage);
|
children.push(subpage);
|
||||||
@ -306,7 +306,7 @@ fn category_page(resolver: &dyn Resolver, category: Category) -> PageModel {
|
|||||||
items.push(CategoryItem {
|
items.push(CategoryItem {
|
||||||
name: ty.short_name().into(),
|
name: ty.short_name().into(),
|
||||||
route: subpage.route.clone(),
|
route: subpage.route.clone(),
|
||||||
oneliner: oneliner(ty.docs()).into(),
|
oneliner: oneliner(ty.docs()),
|
||||||
code: true,
|
code: true,
|
||||||
});
|
});
|
||||||
children.push(subpage);
|
children.push(subpage);
|
||||||
@ -637,7 +637,7 @@ fn group_page(
|
|||||||
let item = CategoryItem {
|
let item = CategoryItem {
|
||||||
name: group.name.clone(),
|
name: group.name.clone(),
|
||||||
route: model.route.clone(),
|
route: model.route.clone(),
|
||||||
oneliner: oneliner(&group.details).into(),
|
oneliner: oneliner(&group.details),
|
||||||
code: false,
|
code: false,
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -772,8 +772,24 @@ pub fn urlify(title: &str) -> EcoString {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Extract the first line of documentation.
|
/// Extract the first line of documentation.
|
||||||
fn oneliner(docs: &str) -> &str {
|
fn oneliner(docs: &str) -> EcoString {
|
||||||
docs.lines().next().unwrap_or_default()
|
let paragraph = docs.split("\n\n").next().unwrap_or_default();
|
||||||
|
let mut depth = 0;
|
||||||
|
let mut period = false;
|
||||||
|
let mut end = paragraph.len();
|
||||||
|
for (i, c) in paragraph.char_indices() {
|
||||||
|
match c {
|
||||||
|
'(' | '[' | '{' => depth += 1,
|
||||||
|
')' | ']' | '}' => depth -= 1,
|
||||||
|
'.' if depth == 0 => period = true,
|
||||||
|
c if period && c.is_whitespace() && !docs[..i].ends_with("e.g.") => {
|
||||||
|
end = i;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
_ => period = false,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
EcoString::from(&docs[..end]).replace("\r\n", " ").replace("\n", " ")
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The order of types in the documentation.
|
/// The order of types in the documentation.
|
||||||
|
@ -86,7 +86,7 @@ pub struct FuncModel {
|
|||||||
pub name: EcoString,
|
pub name: EcoString,
|
||||||
pub title: &'static str,
|
pub title: &'static str,
|
||||||
pub keywords: &'static [&'static str],
|
pub keywords: &'static [&'static str],
|
||||||
pub oneliner: &'static str,
|
pub oneliner: EcoString,
|
||||||
pub element: bool,
|
pub element: bool,
|
||||||
pub contextual: bool,
|
pub contextual: bool,
|
||||||
pub deprecation: Option<&'static str>,
|
pub deprecation: Option<&'static str>,
|
||||||
@ -139,7 +139,7 @@ pub struct TypeModel {
|
|||||||
pub name: &'static str,
|
pub name: &'static str,
|
||||||
pub title: &'static str,
|
pub title: &'static str,
|
||||||
pub keywords: &'static [&'static str],
|
pub keywords: &'static [&'static str],
|
||||||
pub oneliner: &'static str,
|
pub oneliner: EcoString,
|
||||||
pub details: Html,
|
pub details: Html,
|
||||||
pub constructor: Option<FuncModel>,
|
pub constructor: Option<FuncModel>,
|
||||||
pub scope: Vec<FuncModel>,
|
pub scope: Vec<FuncModel>,
|
||||||
|
@ -127,6 +127,10 @@
|
|||||||
checks = self'.checks;
|
checks = self'.checks;
|
||||||
inputsFrom = [ typst ];
|
inputsFrom = [ typst ];
|
||||||
|
|
||||||
|
buildInputs = with pkgs; [
|
||||||
|
rust-analyzer
|
||||||
|
];
|
||||||
|
|
||||||
packages = [
|
packages = [
|
||||||
# A script for quickly running tests.
|
# A script for quickly running tests.
|
||||||
# See https://github.com/typst/typst/blob/main/tests/README.md#making-an-alias
|
# See https://github.com/typst/typst/blob/main/tests/README.md#making-an-alias
|
||||||
|
@ -48,4 +48,5 @@
|
|||||||
let n = query(<a>).len()
|
let n = query(<a>).len()
|
||||||
let fonts = ("nope", "Roboto")
|
let fonts = ("nope", "Roboto")
|
||||||
set text(font: fonts.at(n))
|
set text(font: fonts.at(n))
|
||||||
|
[]
|
||||||
}
|
}
|
||||||
|
@ -51,4 +51,5 @@ Hello
|
|||||||
#context {
|
#context {
|
||||||
set document(author: "Changed") if "Normal" in document.author
|
set document(author: "Changed") if "Normal" in document.author
|
||||||
set document(title: "Changed") if document.title == "Normal"
|
set document(title: "Changed") if document.title == "Normal"
|
||||||
|
[]
|
||||||
}
|
}
|
||||||
|
12
tests/suite/styling/in-block.typ
Normal file
12
tests/suite/styling/in-block.typ
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
--- warn-show-set-last-in-block ---
|
||||||
|
#{
|
||||||
|
// Warning: 3-16 show rule has no effect
|
||||||
|
// Hint: 3-16 a show rule is only in effect until the end of the surrounding code block
|
||||||
|
show "a": "b"
|
||||||
|
}
|
||||||
|
|
||||||
|
#{
|
||||||
|
// Warning: 3-17 set rule has no effect
|
||||||
|
// Hint: 3-17 a set rule is only in effect until the end of the surrounding code block
|
||||||
|
set text(blue)
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user