Improve robustness of specifying Typst executable file name (#52)

resolve #51

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: yusancky

.github/workflows/test.yml

@@ -1,23 +1,22 @@
 name: Test
 on:
   push:
-    branches: [ main ]
+    branches: [main]
     paths-ignore:
       - .gitattributes
       - .gitignore
       - LICENSE
-      - '**.md'
-      - LICENSE
+      - "**.md"
       - .github/**
-      - '!.github/workflows/test.yml'
+      - "!.github/workflows/test.yml"
   pull_request:
     paths-ignore:
       - .gitattributes
       - .gitignore
       - LICENSE
-      - '**.md'
+      - "**.md"
       - .github/**
-      - '!.github/workflows/test.yml'
+      - "!.github/workflows/test.yml"
   workflow_dispatch:
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -29,7 +28,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: "20"
           cache: npm
       - run: npm ci
       - run: npm run build

README.md

@@ -5,6 +5,7 @@
 # Setup Typst
 
 This action provides the following functionality for GitHub Actions users:
+
 - **Installing** a version of [Typst] and adding it to the PATH
 - **Caching** [packages] dependencies
 - **Downloading** ZIP archives as packages
@@ -62,6 +63,13 @@ jobs:
 - run: typst-latest compile paper.typ paper.pdf
 ```
 
+> [!TIP]
+>
+> - `executable-name` defaults to `typst`.
+> - A Typst executable named `typst-${version}` is always kept.
+> - For Windows, there is no need to include the executable file extension `.exe` in the parameters.
+> - Multiple distinct `executable-name` values can be set for the same Typst version. Setting the same `executable-name` (including the default `typst`) for different Typst versions is **not recommended**, as it may lead to version management confusion.
+
 #### Managing Packages with Cache
 
 **`cache-dependency-path`:** Used to specify the path to a Typst file containing lines of `import` keyword.
@@ -70,7 +78,7 @@ jobs:
 # Example workflow YAML file
 - uses: typst-community/setup-typst@v4
   with:
-   cache-dependency-path: requirements.typ
+    cache-dependency-path: requirements.typ
 ```
 
 ```typst
@@ -104,6 +112,7 @@ jobs:
 ```
 
 > [!TIP]
+>
 > - For links to download GitHub repositories, please refer to [_Downloading source code archives_].
 > - The supported namespaces are only `local` and `preview`.
 > - The SemVer versions of packages are read from its `typst.toml`.
@@ -166,6 +175,7 @@ You can also use `npm run lint` to run type checking and format code with `npm r
 The repository uses GitHub Actions for continuous integration testing. The workflow automatically runs on pull requests and pushes to the main branch.
 
 The CI workflow consists of two kinds of jobs:
+
 - Build: Compiles the action and uploads artifacts
 - Test: Tests the action across all platforms
   - Basic Test: Tests basic functionality

README_zh-Hans-CN.md

@@ -5,6 +5,7 @@
 # Setup Typst
 
 Setup Typst 操作为 GitHub Actions 用户提供以下功能：
+
 - **安装**指定版本的 [Typst]
 - **缓存**依赖的 [包]
 - **下载** ZIP 压缩文件作为包
@@ -62,6 +63,13 @@ jobs:
       - run: typst-latest compile paper.typ paper.pdf
 ```
 
+> [!TIP]
+>
+> - `executable-name` 默认为 `typst`。
+> - 一份名为 `typst-${version}` 的 Typst 可执行文件总是被保存。
+> - 对于 Windows，不需要在参数中设置可执行文件后缀名 `.exe`。
+> - 可以为同一版本 Typst 设置多个不同的 `executable-name`。**不推荐** 对不同版本 Typst 设置相同的 `executable-name`（包括默认的 `typst`），因为这可能导致版本管理混乱。
+
 #### 包管理与缓存
 
 **`cache-dependency-path`:** 指向一个含有 `import` 关键字的 Typst 文件。
@@ -104,6 +112,7 @@ jobs:
 ```
 
 > [!TIP]
+>
 > - 对于下载 GitHub 存储库需要的链接，请参阅[《下载源代码存档》]。
 > - 仅支持将 ZIP 包下载到命名空间 `local` 或 `preview`。
 > - SemVer 版本号从 `typst.toml` 读取。
@@ -166,6 +175,7 @@ Setup Typst 操作使用 TypeScript 开发，所以你需要 Nodejs.20 和 npm 
 此存储库使用 GitHub Actions 进行持续集成测试。工作流将对拉取请求和对主分支的推送自动运行。
 
 CI 工作流包括两种工作：
+
 - 构建：编译操作并上传到构件
 - 测试：跨系统测试操作
   - 基础测试：测试基础功能