Skip to content

Commit

Permalink
feat: upgrade shiroa package (#85)
Browse files Browse the repository at this point in the history
  • Loading branch information
Myriad-Dreamin authored Aug 27, 2024
1 parent c17d309 commit 59bd5a0
Show file tree
Hide file tree
Showing 12 changed files with 37 additions and 20 deletions.
2 changes: 1 addition & 1 deletion cli/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ use std::path::PathBuf;
use clap::{ArgAction, Parser, Subcommand, ValueEnum};

#[derive(Debug, Parser)]
#[clap(name = "shiroa", version = "0.1.0")]
#[clap(name = "shiroa", version = "0.1.1")]
pub struct Opts {
/// Print Version
#[arg(short = 'V', long, group = "version-dump")]
Expand Down
4 changes: 2 additions & 2 deletions cli/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ async fn init(args: InitArgs) -> ZResult<()> {
dir.join("book.typ"),
format!(
r##"
#import "@preview/shiroa:0.1.0": *
#import "@preview/shiroa:0.1.1": *
#show: book
Expand Down Expand Up @@ -135,7 +135,7 @@ Sample page
write_file(
dir.join("ebook.typ"),
format!(
r##"#import "@preview/shiroa:0.1.0": *
r##"#import "@preview/shiroa:0.1.1": *
#import "{ebook_template}"
Expand Down
6 changes: 3 additions & 3 deletions cli/src/project.rs
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,12 @@ impl Project {

let package_meta = res
.first()
.ok_or_else(|| error_once!("no internal-package meta in book.typ (are you using old book package?, please import @preview/shiroa:0.1.0; or do you forget the show rule `#show: book`?)"))?;
.ok_or_else(|| error_once!("no internal-package meta in book.typ (are you using old book package?, please import @preview/shiroa:0.1.1; or do you forget the show rule `#show: book`?)"))?;

let InternalPackageMeta::Package { version } = &package_meta.value;
if version != "0.1.0" {
if version != "0.1.1" {
return Err(error_once!(
"outdated book package, please import @preview/shiroa:0.1.0", importing_version: version,
"outdated book package, please import @preview/shiroa:0.1.1", importing_version: version,
));
}
}
Expand Down
2 changes: 1 addition & 1 deletion contrib/typst/gh-ebook.typ
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#import "@preview/shiroa:0.1.0": *
#import "@preview/shiroa:0.1.1": *
#import "/contrib/typst/gh-pages.typ": project, part-style

#let _page-project = project
Expand Down
2 changes: 1 addition & 1 deletion contrib/typst/gh-pages.typ
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// This is important for shiroa to produce a responsive layout
// and multiple targets.
#import "@preview/shiroa:0.1.0": get-page-width, target, is-web-target, is-pdf-target, plain-text, templates
#import "@preview/shiroa:0.1.1": get-page-width, target, is-web-target, is-pdf-target, plain-text, templates
#import templates: *

// Metadata
Expand Down
2 changes: 1 addition & 1 deletion github-pages/docs/book.typ
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

#import "@preview/shiroa:0.1.0": *
#import "@preview/shiroa:0.1.1": *

#show: book

Expand Down
14 changes: 9 additions & 5 deletions github-pages/docs/cli/init.typ
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ shiroa build my-book/ # memoryized dest-dir
The harder way, by creating the book without `init` command, your `book.typ` should at least provides a `book-meta`, as #cross-link("/guide/get-started.typ")[Get Started] shown.

```typ
#import "@preview/shiroa:0.1.0": *
#import "@preview/shiroa:0.1.1": *
#show: book

#book-meta(
Expand All @@ -43,11 +43,15 @@ The harder way, by creating the book without `init` command, your `book.typ` sho
)
```

// todo: update it
What is arguable, your `template.typ` must import and respect the `page-width` and `target` variable from `@preview/typst-ts-variables:0.1.0` to this time.
Your `template.typ` must import and respect the `page-width` and `target` variable from `@preview/shiroa:0.1.1` to this time. The two variables will be used by the tool for rendering responsive layout and multiple targets.

```typ
#import "@preview/typst-ts-variables:0.1.0": page-width, target
#import "@preview/shiroa:0.1.1": get-page-width, target, is-web-target, is-pdf-target

// Metadata
#let page-width = get-page-width()
#let is-pdf-target = is-pdf-target() // target.starts-with("pdf")
#let is-web-target = is-web-target() // target.starts-with("web")

#let project(body) = {
// set web/pdf page properties
Expand All @@ -65,7 +69,7 @@ What is arguable, your `template.typ` must import and respect the `page-width` a
bottom: 0.5em,
// remove rest margins.
rest: 0pt,
)) if target.starts-with("web");
)) if is-web-target;

body
}
Expand Down
6 changes: 3 additions & 3 deletions github-pages/docs/format/theme.typ
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Currently we have no much design on theme's html part. But you can still configu
Your `book.typ` should at least provides a `book-meta`, as #t shown.

```typ
#import "@preview/shiroa:0.1.0": *
#import "@preview/shiroa:0.1.1": *
#show: book

#book-meta(
Expand All @@ -29,10 +29,10 @@ Your `book.typ` should at least provides a `book-meta`, as #t shown.
```

// todo: update it
What is arguable, your `template.typ` must import and respect the `page-width` and `target` variable from `@preview/typst-ts-variables:0.1.0` to this time.
What is arguable, your `template.typ` must import and respect the `page-width` and `target` variable from `@preview/typst-ts-variables:0.1.1` to this time.

```typ
#import "@preview/typst-ts-variables:0.1.0": page-width, target
#import "@preview/typst-ts-variables:0.1.1": page-width, target

#let project(body) = {
// set web/pdf page properties
Expand Down
2 changes: 1 addition & 1 deletion github-pages/docs/guide/get-started.typ
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Before a chapter can be viewed, it must be added to this list.
Here's a basic summary file with a few chapters:

```typ
#import "@preview/shiroa:0.1.0": *
#import "@preview/shiroa:0.1.1": *
#show: book

#book-meta( // put metadata of your book like book.toml of mdbook
Expand Down
2 changes: 1 addition & 1 deletion github-pages/docs/pdf.typ
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#import "@preview/shiroa:0.1.0": *
#import "@preview/shiroa:0.1.1": *

#import "/contrib/typst/gh-ebook.typ"
#let ebook = gh-ebook
Expand Down
13 changes: 13 additions & 0 deletions packages/shiroa-tests/test-no-bad-import.typ
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#import "../shiroa/lib.typ"
#import "../shiroa/media.typ"
#import "../shiroa/supports-link.typ"
#import "../shiroa/supports-text.typ"
#import "../shiroa/meta-and-state.typ"
#import "../shiroa/sys.typ"
#import "../shiroa/template-link.typ"
#import "../shiroa/template-theme.typ"
#import "../shiroa/templates.typ"
#import "../shiroa/summary-internal.typ"
#import "../shiroa/summary.typ"
#import "../shiroa/xcommand.typ"
#import "../shiroa/utils.typ"
2 changes: 1 addition & 1 deletion packages/shiroa/typst.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "shiroa"
version = "0.1.0"
version = "0.1.1"
entrypoint = "lib.typ"
authors = ["Myriad-Dreamin <https://github.com/Myriad-Dreamin>"]
license = "Apache-2.0"
Expand Down

0 comments on commit 59bd5a0

Please sign in to comment.