Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

exmllent:0.1.0, handy-dora:0.1.0 and zebraw:0.1.0 #1510

Merged
merged 15 commits into from
Jan 8, 2025
Merged

Conversation

hongjr03
Copy link
Contributor

@hongjr03 hongjr03 commented Jan 3, 2025

I am submitting

  • a new package
  • an update for a package

Description:

  • Zebraw is a lightweight and fast package for displaying code blocks with line numbers in typst, supporting code line highlighting.
  • Exmllent is a pure typst implementation of converting XML Excel table to typst table.
  • Handy Dora is a wasm impl of Riichi-hand-rs, for visualizing mahjong hands by inputing a hand string.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE

@typst-package-check typst-package-check bot changed the title zebraw:0.1.0 exmllent:0.1.0 and zebraw:0.1.0 Jan 4, 2025
@typst-package-check typst-package-check bot added the new A new package submission. label Jan 4, 2025
@typst-package-check typst-package-check bot changed the title exmllent:0.1.0 and zebraw:0.1.0 exmllent:0.1.0, mahjong-tiles:0.1.0 and zebraw:0.1.0 Jan 8, 2025
@@ -0,0 +1,198 @@
#let xml-to-worksheets(xml-path) = {
let workbook = xml(xml-path).filter(e => if e.tag == "" { false } else { true }).first()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't work as expected, because xml can only read files from the current package. The user of your package should call it and pass the resulting string as an argument to your function.

version = "0.1.0"
entrypoint = "lib.typ"
authors = ["hongjr03 <https://github.com/hongjr03>"]
description = "Riichi-hand-rs but in Typst."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, this description could be improved. I personally don't know what riichi-hand-rs is, and I believe a lot of people don't either. Something along the lines of "Render Mahjong tiles" would be better.

@@ -0,0 +1,14 @@
[package]
name = "mahjong-tiles"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This name is too descriptive of what the package does. Could you please change it to something more unique?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice if you could compress this file, to not bloat the repository too much. You can use oxipng for that (or any image editing program).

@hongjr03
Copy link
Contributor Author

hongjr03 commented Jan 8, 2025

Thanks for your review! I'll fix these quickly.

@typst-package-check typst-package-check bot changed the title exmllent:0.1.0, mahjong-tiles:0.1.0 and zebraw:0.1.0 exmllent:0.1.0, handy-dora:0.1.0 and zebraw:0.1.0 Jan 8, 2025
Copy link
Member

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for taking the review into account. I just noticed something else that could be improved in your READMEs. Sorry for the multiple reviews.

packages/preview/exmllent/0.1.0/README.md Outdated Show resolved Hide resolved

## Usage

Start with `#import "src/lib.typ": mahjong`. Reminds that `handy-dora.wasm` should be in the same directory as where `src/` is.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here (and the second sentence is then no longer necessary).

Suggested change
Start with `#import "src/lib.typ": mahjong`. Reminds that `handy-dora.wasm` should be in the same directory as where `src/` is.
Start with `#import "@preview/handy-dora:0.1.0": mahjong`.

@hongjr03
Copy link
Contributor Author

hongjr03 commented Jan 8, 2025

Thank you for taking the review into account. I just noticed something else that could be improved in your READMEs. Sorry for the multiple reviews.

Thanks for your kind work!

@elegaanz
Copy link
Member

elegaanz commented Jan 8, 2025

Thanks!

@elegaanz elegaanz merged commit 6321794 into typst:main Jan 8, 2025
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new A new package submission.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants