feat: add word counter

Signed-off-by: Juntong Chen <[email protected]>

Author: jtchen2k

README.md

@@ -11,13 +11,20 @@
 - 优化段落缩进
 - 优化对多行标题 / 院系的处理逻辑
 - 优化开启 `twoside` 参数后的页码逻辑
+- 增加字数统计功能
 
 对于研究生，我们参考华东师范大研究生院于 2023 年发布的[华东师范大学博士、硕士学位论文基本格式要求](https://yjsy.ecnu.edu.cn/8e/62/c42090a429666/page.htm)；对于本科生，我们参考华东师范大学教务处于 2021 年更新的[华东师范大学本科生毕业论文（设计）格式要求](http://www.jwc.ecnu.edu.cn/d4/be/c40573a513214/page.htm)。格式适配于 2025 年初，后续使用的同学请留意参考校方的最新通知。
 
 ![1736471485839](https://jtchen.s3.ap-northeast-1.amazonaws.com/v1/img/2025/01/09/1736471485839.png)
 
 在这里可以找到硕士学位论文的示例文档：[thesis.pdf](https://github.com/jtchen2k/modern-ecnu-thesis/releases/download/0.1.0/thesis.pdf)。
 
+## Why Typst
+
+> 天下苦 LaTeX 久矣。
+
+Typst 是一个基于 Rust 的现代化的排版引擎。它具备类似 Markdown 的简洁语法、清晰的错误提示、实时预览级的编译性能，又同时具备和 LaTeX 一样精准的排版控制和图灵完备的脚本能力。自 2023 年 4 月开源发布以来，已获得 ![](https://img.shields.io/github/stars/typst/typst?style=flat)。现代化的 Typst 可以让你更加专注于论文内容本身，而不被 LaTeX 漫长的编译时间与难以阅读的输出日志困扰。
+
 ## Usage
 
 ### 在 VSCode 中本地编辑（推荐）
@@ -66,16 +73,45 @@ ln -s </path/to/modern-ecnu-thesis> $DATA_DIR/typst/packages/preview/modern-ecnu
 
 ## Tips
 
+默认模板有一些示例代码，清空前请留意。
+
+### 字数统计
+
+模板内置了字数统计功能。统计时会除去标题与标点符号，默认包括了正文与附录的所有内容。一个英语单词或一个 CJK 汉字将会被统计为一个 word，一个任意字符会被统计为一个 char。默认的统计范围为正文 + 附录，这取决于文中 `#show: word-count-cjk` 的位置。如果希望包括摘要、目录等能容，将这一行移动到 `#show: preface` 的下一行即可。
+
+如需统计字数，可以使用 `make count` 命令，你会得到类似如下的输出：
+
+```
+#word: 100
+#char: 200
+```
+
+具体而言，该命令使用 `typst query` 命令来查询嵌入在 `mainmatter.typ` 里的包含字数信息的 `metadata`。你也可以在正文中使用 `total-words-cjk`、`total-characters` 或使用以下代码来显示总字数 / 字符数：
+
+```typst
+context state("total-words-cjk").final()
+context state("total-characters").final()
+```
+
+### 从 LaTeX 到 Typst
+
 - Typst 支持的图片格式包括 png, jpeg, gif 与 svg，不支持 pdf 与 eps。你可以使用 InkSpace 或 [pdf2svg](https://github.com/dawbarton/pdf2svg) 等工具将 pdf 转换为 svg 格式：
 
     ```bash
     pdf2svg input.pdf output.svg
     ```
 
-- Typst 现在已经支持图片的浮动排版了。你可以使用 `figure` 的 `placement` 属性来控制图片位置。
-- Typst 有一套自己的公式语法，与 LaTeX 大同小异且更加简洁。如果你已经十分熟悉 LaTeX 的语法并希望使用，可以使用 [MiTeX](https://github.com/mitex-rs/mitex)，它将允许你在 Typst 中使用 LaTeX 数学语法。
+- Typst 现在已经支持图片的浮动排版了。你可以使用 `figure` 的 `placement` 属性来控制图片位置，可以实现类似 LaTeX 的 `[htbp]` 功能：
+
+    ```typst
+    figure {
+        placement: "top";
+        caption: "image caption";
+        ...
+    }[#image("...)] <label>
+    ```
+- Typst 有一套自己的公式语法，与 LaTeX 大同小异且更加简洁。如果你已经十分熟悉 LaTeX 的语法并希望继续使用，可以引入 [MiTeX](https://github.com/mitex-rs/mitex)，它将允许你在 Typst 中使用 LaTeX 数学语法。
 - Typst 原生兼容了 biblatex 引用格式，直接修改 ref.bib 即可。
-- 默认模板有一些示例代码，清空前请留意。
 
 更多 Typst 的介绍、学习资料与项目背景可参考[上游项目](https://github.com/nju-lug/modern-nju-thesis)的 README。
 

layouts/appendix.typ

@@ -1,6 +1,7 @@
 #import "@preview/i-figured:0.2.4"
 #import "../utils/custom-numbering.typ": custom-numbering
 
+
 // 后记，重置 heading 计数器
 #let appendix(
   numbering: custom-numbering.with(first-level: "", depth: 4, "1.1 "),

layouts/mainmatter.typ

@@ -6,6 +6,7 @@
 #import "../utils/indent.typ": fake-par
 #import "../utils/unpairs.typ": unpairs
 #import "../utils/pagebreak-from-odd.typ": pagebreak-from-odd
+#import "../utils/word-counter.typ": *
 
 #let mainmatter(
   // documentclass 传入参数
@@ -215,8 +216,15 @@
     )
   }))
 
-  it
+  // 字数统计（正文 + 附录）
+  //     typst query main.typ '<total-words>' 2>/dev/null --field value --one
+
+  context [
+    #metadata(state("total-words-cjk").final()) <total-words>
+    #metadata(state("total-characters").final()) <total-chars>
+  ]
 
+  it
   // 正文结束标志，不可缺少
   // 这里放在附录后面，使得页码能正确计数
   fence()

lib.typ

@@ -4,7 +4,7 @@
  * @project: modern-ecnu-thesis
  * @author: OrangeX4, Juntong Chen ([email protected])
  * @created: 2025-01-06 22:37:34
- * @modified: 2025-01-10 01:58:02
+ * @modified: 2025-01-11 15:11:45
 *
  * 华东师范大学学位论文模板
  *    Repo: https://github.com/jtchen2k/modern-ecnu-thesis
@@ -39,6 +39,7 @@
 #import "utils/custom-heading.typ": heading-display, active-heading, current-heading
 #import "utils/indent.typ": indent, fake-par, no-indent
 #import "utils/panic-page.typ": panic-page
+#import "utils/word-counter.typ": *
 #import "@preview/i-figured:0.2.4": show-figure, show-equation
 #import "utils/style.typ": 字体, 字号
 

template/Makefile

@@ -1,12 +1,20 @@
 TYP_SRC = $(shell find . -name '*.typ')
+
 TARGET = thesis.pdf
+TARGET_TYP = thesis.typ
 
 $(TARGET): $(TYP_SRC)
-	typst compile thesis.typ --pdf-standard 1.7 --root ..
+	typst compile --pdf-standard 1.7 $(TARGET_TYP) --root ..
+	@echo "Build successful: $(shell du -h $(TARGET_TYP) | cut -f1)"
 
-.PHONY: clean, watch
+.PHONY: clean, watch, count
 clean:
 	rm -f $(TARGET)
 
 watch:
-	typst watch thesis.typ --root ..
+	typst watch --root .. --pdf-standard 1.7 $(TARGET_TYP)
+
+# Count words and characters in mainmatter and backmatter
+count:
+	@echo "#words: $(shell typst query $(TARGET_TYP) '<total-words>' 2>/dev/null --field value --one)"
+	@echo "#chars: $(shell typst query $(TARGET_TYP) '<total-chars>' 2>/dev/null --field value --one)"

template/thesis.typ

@@ -1,4 +1,4 @@
-#import "@preview/modern-ecnu-thesis:0.1.0": documentclass, indent, no-indent
+#import "@preview/modern-ecnu-thesis:0.1.0": documentclass, indent, no-indent, word-count-cjk, total-words
 
 // 模板用到的主要字体：https://github.com/jtchen2k/modern-ecnu-thesis/tree/main/fonts/
 // 如果是在 Web App 上编辑，你应该手动上传上述字体文件，否则不能正常使用「楷体」和「仿宋」。
@@ -109,6 +109,9 @@
 // 可选的，可以通过 #show: mainmatter.with(figure-clearance: 0pt) 来设置浮动图表的间距或其他参数
 #show: mainmatter
 
+// 字数统计开始
+#show: word-count-cjk
+
 = 导　论
 
 == 列表
@@ -219,6 +222,15 @@ int main() {
 
 #no-indent 比如，这是一个没有首行缩进的段落。
 
+=== 字数统计
+
+正文与附录的的总字数为：#total-words。你也可以使用以下命令来使用命令行工具统计字数 / 字符数：
+
+```bash
+typst query thesis.typ '<total-words>' 2>/dev/null --field value --one
+typst query thesis.typ '<total-characters>' 2>/dev/null --field value --one
+```
+
 = 正　文
 
 // 用于生成占位符。可删除。
@@ -235,8 +247,6 @@ int main() {
 + 自定义段落编号
 ]
 
-
-
 // 手动分页示例
 #if twoside {
   pagebreak() + " "

utils/word-counter.typ

@@ -0,0 +1,27 @@
+/*
+ * word-counter.typ
+ *
+ * @project: modern-ecnu-thesis
+ * @author: Juntong Chen ([email protected])
+ * @created: 2025-01-11 13:37:30
+ * @modified: 2025-01-11 15:12:07
+ *
+ * Copyright (c) 2025 Juntong Chen. All rights reserved.
+ */
+
+#import "@preview/wordometer:0.1.4": *
+
+#let word-count-cjk(content, ..options) = {
+  let stats = word-count-of(content, exclude: (heading), counter: s => (
+    characters: s.replace(regex("\s+"), "").clusters().len(),
+    words: s.matches(regex("\b[\w'’.,\-]+\b")).len(),
+    words-cjk: s.matches(regex("[\u4e00-\u9fff\u3040-\u309f\u30a0-\u30ff\uac00-\ud7af]|[\w''.,\-]+")).len(),
+  ), ..options)
+  state("total-words-cjk").update((prev) => prev + stats.words-cjk)
+  state("total-words").update((prev) => prev + stats.words)
+  state("total-characters").update((prev) => prev + stats.characters)
+  content
+}
+
+#let total-words = context state("total-words-cjk").final()
+#let total-characters = context state("total-characters").final()