@kitschpatrol/tldraw-cli 1.0.0

package/dist/translations/zh-tw.json

@@ -0,0 +1,316 @@
+{
+	"action.convert-to-bookmark": "轉換為書籤",
+	"action.convert-to-embed": "轉換為嵌入",
+	"action.open-embed-link": "開啟連結",
+	"action.align-bottom": "置底",
+	"action.align-center-horizontal": "水平置中",
+	"action.align-center-vertical": "垂直置中",
+	"action.align-center-horizontal.short": "水平置中",
+	"action.align-center-vertical.short": "垂直置中",
+	"action.align-left": "置左",
+	"action.align-right": "置右",
+	"action.align-top": "置頂",
+	"action.back-to-content": "回到內容",
+	"action.bring-forward": "前移一層",
+	"action.bring-to-front": "移至頂層",
+	"action.copy-as-json.short": "JSON",
+	"action.copy-as-json": "複製為 JSON",
+	"action.copy-as-png.short": "PNG",
+	"action.copy-as-png": "複製為 PNG",
+	"action.copy-as-svg.short": "SVG",
+	"action.copy-as-svg": "複製為 SVG",
+	"action.copy": "複製",
+	"action.cut": "剪下",
+	"action.delete": "刪除",
+	"action.distribute-horizontal": "水平分布",
+	"action.distribute-vertical": "垂直分布",
+	"action.distribute-horizontal.short": "水平分布",
+	"action.distribute-vertical.short": "垂直分布",
+	"action.duplicate": "複製",
+	"action.edit-link": "編輯連結",
+	"action.exit-pen-mode": "退出畫筆模式",
+	"action.export-as-json.short": "JSON",
+	"action.export-as-json": "匯出成 JSON",
+	"action.export-as-png.short": "PNG",
+	"action.export-as-png": "匯出成 PNG",
+	"action.export-as-svg.short": "SVG",
+	"action.export-as-svg": "匯出成 SVG",
+	"action.flip-horizontal": "水平翻轉",
+	"action.flip-vertical": "垂直翻轉",
+	"action.flip-horizontal.short": "水平翻轉",
+	"action.flip-vertical.short": "垂直翻轉",
+	"action.group": "群組",
+	"action.insert-media": "上傳媒體檔",
+	"action.new-shared-project": "新建共享專案",
+	"action.open-file": "開啟檔案",
+	"action.pack": "打包",
+	"action.paste": "貼上",
+	"action.print": "列印",
+	"action.redo": "取消復原",
+	"action.rotate-ccw": "逆時針旋轉",
+	"action.rotate-cw": "順時針旋轉",
+	"action.save-copy": "存為副本",
+	"action.select-all": "全選",
+	"action.select-none": "取消選取",
+	"action.send-backward": "後移一層",
+	"action.send-to-back": "移至底層",
+	"action.share-project": "共享此專案",
+	"action.stack-horizontal": "水平堆疊",
+	"action.stack-vertical": "垂直堆疊",
+	"action.stack-horizontal.short": "水平堆疊",
+	"action.stack-vertical.short": "垂直堆疊",
+	"action.stretch-horizontal": "水平延展",
+	"action.stretch-vertical": "垂直延展",
+	"action.stretch-horizontal.short": "水平延展",
+	"action.stretch-vertical.short": "垂直延展",
+	"action.toggle-auto-size": "切換自動大小",
+	"action.toggle-dark-mode.menu": "深色模式",
+	"action.toggle-dark-mode": "切換深色模式",
+	"action.toggle-debug-mode.menu": "除錯模式",
+	"action.toggle-debug-mode": "切換除錯模式",
+	"action.toggle-focus-mode.menu": "專注模式",
+	"action.toggle-focus-mode": "切換專注模式",
+	"action.toggle-grid.menu": "顯示網格",
+	"action.toggle-grid": "切換網格",
+	"action.toggle-snap-mode.menu": "始終貼齊",
+	"action.toggle-snap-mode": "切換始終貼齊",
+	"action.toggle-tool-lock.menu": "工具鎖定",
+	"action.toggle-tool-lock": "切換工具鎖定",
+	"action.toggle-transparent.context-menu": "透明",
+	"action.toggle-transparent.menu": "透明",
+	"action.toggle-transparent": "切換透明背景",
+	"action.undo": "復原",
+	"action.ungroup": "取消群組",
+	"action.zoom-in": "放大",
+	"action.zoom-out": "縮小",
+	"action.zoom-to-100": "縮放至 100%",
+	"action.zoom-to-fit": "縮放至適當大小",
+	"action.zoom-to-selection": "縮放至選取範圍",
+	"color-style.black": "黑色",
+	"color-style.blue": "藍色",
+	"color-style.green": "綠色",
+	"color-style.grey": "灰色",
+	"color-style.light-blue": "淺藍色",
+	"color-style.light-green": "淺綠色",
+	"color-style.light-red": "淺紅色",
+	"color-style.light-violet": "淺紫色",
+	"color-style.orange": "橘色",
+	"color-style.red": "紅色",
+	"color-style.violet": "紫色",
+	"color-style.yellow": "黃色",
+	"fill-style.none": "無",
+	"fill-style.semi": "半填滿",
+	"fill-style.solid": "填滿",
+	"fill-style.pattern": "圖案",
+	"dash-style.dashed": "虛線",
+	"dash-style.dotted": "虛點",
+	"dash-style.draw": "手繪",
+	"dash-style.solid": "實線",
+	"size-style.s": "小",
+	"size-style.m": "中",
+	"size-style.l": "大",
+	"size-style.xl": "特大",
+	"opacity-style.0.1": "10%",
+	"opacity-style.0.25": "25%",
+	"opacity-style.0.5": "50%",
+	"opacity-style.0.75": "75%",
+	"opacity-style.1": "100%",
+	"font-style.draw": "手繪",
+	"font-style.sans": "無襯線",
+	"font-style.serif": "襯線",
+	"font-style.mono": "等寬",
+	"align-style.start": "前端",
+	"align-style.middle": "置中",
+	"align-style.end": "末端",
+	"align-style.justify": "兩端",
+	"geo-style.arrow-down": "向下箭頭",
+	"geo-style.arrow-left": "向左箭頭",
+	"geo-style.arrow-right": "向右箭頭",
+	"geo-style.arrow-up": "向上箭頭",
+	"geo-style.diamond": "菱形 2",
+	"geo-style.ellipse": "橢圓形",
+	"geo-style.hexagon": "六邊形",
+	"geo-style.octagon": "八邊形",
+	"geo-style.oval": "卵形",
+	"geo-style.pentagon": "五邊形",
+	"geo-style.rectangle": "矩形",
+	"geo-style.rhombus-2": "菱形 2",
+	"geo-style.rhombus": "菱形",
+	"geo-style.star": "星形",
+	"geo-style.trapezoid": "梯形",
+	"geo-style.triangle": "三角形",
+	"geo-style.x-box": "X 框",
+	"arrowheadStart-style.none": "無",
+	"arrowheadStart-style.arrow": "箭頭",
+	"arrowheadStart-style.bar": "條狀",
+	"arrowheadStart-style.diamond": "菱形",
+	"arrowheadStart-style.dot": "點",
+	"arrowheadStart-style.inverted": "反轉",
+	"arrowheadStart-style.pipe": "管狀",
+	"arrowheadStart-style.square": "正方形",
+	"arrowheadStart-style.triangle": "三角形",
+	"arrowheadEnd-style.none": "無",
+	"arrowheadEnd-style.arrow": "箭頭",
+	"arrowheadEnd-style.bar": "條狀",
+	"arrowheadEnd-style.diamond": "菱形",
+	"arrowheadEnd-style.dot": "點",
+	"arrowheadEnd-style.inverted": "反轉",
+	"arrowheadEnd-style.pipe": "管狀",
+	"arrowheadEnd-style.square": "正方形",
+	"arrowheadEnd-style.triangle": "三角形",
+	"spline-style.line": "直線",
+	"spline-style.cubic": "立方體",
+	"tool.select": "選取",
+	"tool.hand": "抓取",
+	"tool.draw": "手繪",
+	"tool.eraser": "橡皮擦",
+	"tool.arrow-down": "向下箭頭",
+	"tool.arrow-left": "向左箭頭",
+	"tool.arrow-right": "向右箭頭",
+	"tool.arrow-up": "向上箭頭",
+	"tool.arrow": "箭頭",
+	"tool.diamond": "菱形 2",
+	"tool.ellipse": "橢圓形",
+	"tool.hexagon": "六邊形",
+	"tool.line": "直線",
+	"tool.octagon": "八邊形",
+	"tool.oval": "卵形",
+	"tool.pentagon": "五邊形",
+	"tool.rectangle": "矩形",
+	"tool.rhombus": "菱形",
+	"tool.star": "星形",
+	"tool.trapezoid": "梯形",
+	"tool.triangle": "三角形",
+	"tool.x-box": "X 框",
+	"tool.asset": "資源",
+	"tool.frame": "框架",
+	"tool.note": "便利貼",
+	"tool.embed": "嵌入",
+	"tool.text": "文字",
+	"menu.title": "選單",
+	"menu.copy-as": "複製成",
+	"menu.edit": "編輯",
+	"menu.export-as": "匯出成",
+	"menu.file": "檔案",
+	"menu.language": "語言",
+	"menu.preferences": "選項",
+	"menu.view": "檢視",
+	"context-menu.arrange": "佈局",
+	"context-menu.copy-as": "複製成",
+	"context-menu.export-as": "匯出成",
+	"context-menu.move-to-page": "移至頁面",
+	"context-menu.reorder": "重新排序",
+	"page-menu.title": "頁面",
+	"page-menu.create-new-page": "建立新頁面",
+	"page-menu.max-page-count-reached": "達到上限頁數",
+	"page-menu.new-page-initial-name": "頁面 1",
+	"page-menu.edit-start": "編輯",
+	"page-menu.edit-done": "完成",
+	"page-menu.submenu.rename": "重新命名",
+	"page-menu.submenu.duplicate-page": "複製",
+	"page-menu.submenu.title": "選單",
+	"page-menu.submenu.move-down": "下移",
+	"page-menu.submenu.move-up": "上移",
+	"page-menu.submenu.delete": "刪除",
+	"share-menu.title": "共享",
+	"share-menu.share-project": "共享此專案",
+	"share-menu.copy-link": "複製連結",
+	"share-menu.readonly-link": "唯讀",
+	"share-menu.copy-readonly-link": "複製唯讀連結",
+	"share-menu.offline-note": "共享此專案將建立即時副本，並產生新網址。您可以分享網址，與其他至多三十人一起檢視和編輯副本。",
+	"share-menu.copy-link-note": "任何人透過連結都能檢視和編輯此專案。",
+	"share-menu.copy-readonly-link-note": "任何人透過連結都能檢視（但不能編輯）此專案。",
+	"share-menu.project-too-large": "抱歉，無法共享此專案，因為檔案過大。我們已在調整這件事！",
+	"people-menu.title": "人員",
+	"people-menu.change-name": "更改名稱",
+	"people-menu.change-color": "更改顏色",
+	"people-menu.user": "（您）",
+	"people-menu.invite": "邀請其他人",
+	"help-menu.title": "幫助和資源",
+	"help-menu.about": "關於",
+	"help-menu.discord": "Discord",
+	"help-menu.github": "GitHub",
+	"help-menu.keyboard-shortcuts": "鍵盤快捷鍵",
+	"help-menu.twitter": "Twitter",
+	"actions-menu.title": "操作",
+	"edit-link-dialog.title": "編輯連結",
+	"edit-link-dialog.invalid-url": "連結必須是有效網址。",
+	"edit-link-dialog.detail": "連結將在新分頁開啟。",
+	"edit-link-dialog.url": "網址",
+	"edit-link-dialog.clear": "清除",
+	"edit-link-dialog.save": "繼續",
+	"edit-link-dialog.cancel": "取消",
+	"embed-dialog.title": "建立嵌入",
+	"embed-dialog.back": "返回",
+	"embed-dialog.create": "建立",
+	"embed-dialog.cancel": "取消",
+	"embed-dialog.url": "網址",
+	"embed-dialog.instruction": "貼上網站連結以建立嵌入。",
+	"embed-dialog.invalid-url": "我們沒辦法從該網址建立嵌入。",
+	"edit-pages-dialog.move-down": "下移",
+	"edit-pages-dialog.move-up": "上移",
+	"shortcuts-dialog.title": "鍵盤快捷鍵",
+	"shortcuts-dialog.edit": "編輯",
+	"shortcuts-dialog.file": "檔案",
+	"shortcuts-dialog.preferences": "選項",
+	"shortcuts-dialog.tools": "工具",
+	"shortcuts-dialog.transform": "轉換",
+	"shortcuts-dialog.view": "檢視",
+	"style-panel.title": "樣式",
+	"style-panel.align": "對齊",
+	"style-panel.arrowheads": "箭頭",
+	"style-panel.color": "顏色",
+	"style-panel.dash": "虛線",
+	"style-panel.fill": "填充",
+	"style-panel.font": "字型",
+	"style-panel.geo": "形狀",
+	"style-panel.mixed": "混合",
+	"style-panel.opacity": "不透明度",
+	"style-panel.size": "大小",
+	"style-panel.spline": "曲線",
+	"tool-panel.drawing": "繪圖",
+	"tool-panel.shapes": "形狀",
+	"navigation-zone.toggle-minimap": "切換小地圖",
+	"navigation-zone.zoom": "縮放",
+	"focus-mode.toggle-focus-mode": "切換專注模式",
+	"toast.close": "關閉",
+	"file-system.file-open-error.title": "無法開啟檔案",
+	"file-system.file-open-error.not-a-tldraw-file": "您嘗試開啟的檔案不像 tldraw 檔。",
+	"file-system.file-open-error.file-format-version-too-new": "你嘗試開啟的檔案來自新版 tldraw。請重新載入頁面，然後再試一次。",
+	"file-system.file-open-error.generic-corrupted-file": "您嘗試開啟的檔案已損毀。",
+	"file-system.confirm-open.title": "覆蓋當前檔案？",
+	"file-system.confirm-open.description": "開啟檔案將置換您的當前專案，任何未儲存的更動都會消失。您確定要繼續嗎？",
+	"file-system.confirm-open.cancel": "取消",
+	"file-system.confirm-open.open": "開啟檔案",
+	"file-system.confirm-open.dont-show-again": "不再詢問",
+	"toast.error.export-fail.title": "匯出失敗",
+	"toast.error.export-fail.desc": "圖片匯出失敗",
+	"toast.error.copy-fail.title": "複製失敗",
+	"toast.error.copy-fail.desc": "圖片複製失敗",
+	"file-system.shared-document-file-open-error.title": "無法開啟檔案",
+	"file-system.shared-document-file-open-error.description": "不支援從共享專案開啟檔案。",
+	"vscode.file-open.dont-show-again": "不再詢問",
+	"vscode.file-open.desc": "此檔案由較早版本的 tldraw 所建立。您想要更新它以用於新版本上嗎？",
+	"context.pages.new-page": "新頁面",
+	"style-panel.arrowhead-start": "前端",
+	"style-panel.arrowhead-end": "末端",
+	"vscode.file-open.open": "繼續",
+	"vscode.file-open.backup": "備份",
+	"vscode.file-open.backup-saved": "已備份",
+	"vscode.file-open.backup-failed": "備份失敗：這不是 .tldr 檔。",
+	"tool-panel.more": "更多",
+	"debug-panel.more": "更多",
+	"action.new-project": "新建專案",
+	"file-system.confirm-clear.title": "清除當前專案？",
+	"file-system.confirm-clear.description": "建立新專案將清除當前專案，任何未儲存的更動都會消失。您確定要繼續嗎？",
+	"file-system.confirm-clear.cancel": "取消",
+	"file-system.confirm-clear.continue": "繼續",
+	"file-system.confirm-clear.dont-show-again": "不再詢問",
+	"action.stop-following": "取消追蹤",
+	"people-menu.follow": "追蹤",
+	"style-panel.position": "位置",
+	"page-menu.go-to-page": "轉到頁面",
+	"share-menu.create-snapshot-link": "建立快照連結",
+	"share-menu.save-note": "將此專案作為 .tldr 檔下載到您的電腦。",
+	"share-menu.fork-note": "基於此快照建立新的共享專案。"
+}

package/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Eric Mika
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@kitschpatrol/tldraw-cli",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "A tiny little CLI tool for converting tldraw .tldr files into svg or png images.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kitschpatrol/tldraw-cli.git"
+  },
+  "homepage": "https://github.com/kitschpatrol/tldraw-cli",
+  "bugs": {
+    "url": "https://github.com/kitschpatrol/tldraw-cli/issues",
+    "email": "eric@ericmika.com"
+  },
+  "author": {
+    "name": "Eric Mika",
+    "email": "eric@ericmika.com",
+    "url": "https://ericmika.com"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=8.0.0"
+  },
+  "bin": {
+    "tldraw-cli": "bin/cli.js"
+  },
+  "files": [
+    "bin/*",
+    "dist/*"
+  ],
+  "keywords": [
+    "tldraw",
+    "tldr",
+    "cli",
+    "diagram",
+    "drawing",
+    "sketch",
+    "export"
+  ],
+  "dependencies": {
+    "express": "^4.18.2",
+    "puppeteer": "^21.7.0"
+  },
+  "devDependencies": {
+    "@kitschpatrol/shared-config": "^4.3.3",
+    "@tldraw/assets": "2.0.0-beta.2",
+    "@tldraw/editor": "2.0.0-beta.2",
+    "@tldraw/tldraw": "2.0.0-beta.2",
+    "@types/express": "^4.17.21",
+    "@types/react": "^18.2.47",
+    "@types/react-dom": "^18.2.18",
+    "@types/yargs": "^17.0.32",
+    "@vitejs/plugin-react-swc": "^3.5.0",
+    "bumpp": "^9.2.1",
+    "esbuild": "^0.19.11",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.5",
+    "get-port": "^7.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.3",
+    "untildify": "^5.0.0",
+    "vite": "^5.0.11",
+    "yargs": "^17.7.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run build:tldraw && pnpm run build:cli",
+    "build:cli": "tsx ./scripts/build-cli.ts",
+    "build:tldraw": "pnpm run tldraw-copy-assets && vite build",
+    "dev": "pnpm run tldraw-copy-assets && vite",
+    "dev-cli": "pnpm run build:tldraw && tsx ./src/cli/tldraw-cli.ts ./test-assets/box.tldr --verbose",
+    "fix": "shared-config --fix",
+    "lint": "shared-config --lint",
+    "preview": "vite preview",
+    "release": "pnpm build && pnpm bumpp --commit 'Release: %s' && pnpm publish --otp $(op read 'op://Personal/Npmjs/one-time password?attribute=otp')",
+    "tldraw-copy-assets": "sync -av --include='/*/' --exclude='/*' ./node_modules/@tldraw/assets/ ./src/tldraw/public/"
+  }
+}

package/readme.md

@@ -0,0 +1,105 @@
+# @kitschpatrol/tldraw-cli
+
+[![NPM Package](https://img.shields.io/npm/v/@kitschpatrol/tldraw-cli.svg)](https://npmjs.com/package/@kitschpatrol/tldraw-cli)
+
+## Overview
+
+**A minimal CLI app to automate conversion and export of [tldraw](https://tldraw.dev) `.tldr` files into svg or png image formats.**
+
+This could be useful in the context of a content publishing pipeline where you want to use a `.tldr` file (perhaps under version control) as the "source of truth" for assets to be embedded elsewhere, and you don't want to manage the export of that diagram manually.
+
+_Note: This tool is not a part of the official tldraw project, and it is currently only tested and compatible with tldraw 2.0.0-beta.2._
+
+## Installation
+
+Invoke directly:
+
+```sh
+npx @kitschpatrol/tldraw-cli some-file.tldr
+```
+
+...or install locally:
+
+```sh
+npm --install --save-dev @kitschpatrol/tldraw-cli
+```
+
+...or install globally:
+
+```sh
+npm --install --global @kitschpatrol/tldraw-cli
+```
+
+## Usage
+
+### Invocation
+
+```sh
+tldraw-cli file {options}
+```
+
+### Option flags
+
+| Option            | Description                                 | Default |
+| ----------------- | ------------------------------------------- | ------- |
+| `-f`, `--format`  | Output image format , one of "png" or "svg" | `svg`   |
+| `-o`, `--output`  | Output image directory                      | `./`    |
+| `-h`, `--help`    | Show help                                   |         |
+| `-v`, `--version` | Show version number                         |         |
+| `--verbose`       | Enable verbose output                       | `false` |
+
+## Examples
+
+### Basic conversion
+
+To convert the file `your-drawing.tldr` to an svg named `your-drawing.svg` saved in the current working directory, run the following command. Note that the default output format is svg, and the default export location is the current working directory.
+
+```sh
+npx @kitschpatrol/tldraw-cli your-drawing.tldr
+```
+
+### Export to a specific format
+
+```sh
+npx @kitschpatrol/tldraw-cli your-drawing.tldr --format png
+```
+
+### Export to a specific destination
+
+```sh
+npx @kitschpatrol/tldraw-cli your-drawing.tldr --output ~/Desktop
+```
+
+## Background
+
+The potential utility of a tldraw CLI app has received mention a few times.
+
+On GitHub:
+
+- [\[Feature\]: CLI export application #1491](https://github.com/tldraw/tldraw/issues/1491)
+- [AWS Lambda-based approach](https://gist.github.com/steveruizok/c30fc99b9b3d95a14c82c59bdcc69201)
+
+On Discord:
+
+- [@jorisjh in #ideas_old](https://discord.com/channels/859816885297741824/859816885801713730/1156880056501665802)
+- [@Nitsuj in #ideas_old](https://discord.com/channels/859816885297741824/859816885801713730/1020352607920869406)
+
+## Implementation notes
+
+Due to the current implementation of tldraw, export depends on functionality provided by a web browser. So, behind the scenes, this app serves a local instance of tldraw, then loads a `.tldr` and invokes the export download via [Puppeteer](https://pptr.dev).
+
+The local instance of tldraw includes its assets dependencies, so the tool should work correctly without internet access.
+
+## The future
+
+This is a very minimal implementation. Current plans for future improvements include the following:
+
+- Add automated tests
+- Implement the ability to export frames or pages as separate image files
+- Add an option flag to set dpi when exporting to a bitmap format
+
+Any other suggestions are welcome.
+
+Eventually, I think it would make sense for some kind of CLI tool like this one to be part of the core tldraw project. (Similar to how [tldraw-vscode](https://github.com/tldraw/tldraw/tree/main/apps/vscode) is currently integrated.)
+
+I'm consciously releasing this tool under the `@kitschpatrol` namespace on NPM to leave the `tldraw-cli` package name available to the core tldraw project.