@gui-chat-plugin/common

中文文档
0.1.0发布于 2026/10/01MITTypeScriptESM + CJS零依赖近 30 天下载 4737

Pure, browser-safe helpers shared by @gui-chat-plugin/* packages: artifact path builders for the host's files.artifacts area

原始使用文档

@gui-chat-plugin/common

Pure helpers shared by the @gui-chat-plugin/* packages. Browser-safe: nothing touches the DOM or a node:* builtin, so a plugin can use them in its core entry (which may run on a server) and in its Vue entry alike. Its only dependency is gui-chat-protocol (^2.3.0), a peer, as in every package here.

Artifact paths

For a plugin that writes under the host's shared files.artifacts area. The directory's name is ARTIFACTS_ROOT from gui-chat-protocol; these build the paths under it.

ExportDoes
slugifyArtifact(title, fb)Lowercase-ASCII slug, capped at 120 chars; fb when the title yields nothing
yearMonthUtc(now?)The UTC YYYY/MM partition
buildArtifactRelPath(params)<dir>[/YYYY/MM]/<slug>-<epochMs>[-<suffix>]<ext>, the key files.artifacts.write takes
toWorkspaceArtifactPath(rel)Prefixes artifacts/, the workspace-relative form a tool reports to the model
hasUnsafePathSegment(value)True when a /- or \-separated segment is empty, . or .. (the traversal guard)

A plugin lists this package under dependencies: the helpers keep no state, so a second copy nested under a plugin is harmless.

版本与发布记录

@gui-chat-plugin/common 共发布 1 个版本,首次发布于 2026/10/01;过去 12 个月发布了 1 个版本。

版本发布日期距今
0.1.0latest2026/10/011 个月前

关于 @gui-chat-plugin/common 的常见问题

@gui-chat-plugin/common 是什么?

Pure, browser-safe helpers shared by @gui-chat-plugin/* packages: artifact path builders for the host's files.artifacts area

如何安装 @gui-chat-plugin/common?

在项目目录运行 npm install @gui-chat-plugin/common,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:gui-chat-protocol(^2.3.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gui-chat-plugin/common 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gui-chat-plugin/common 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gui-chat-plugin/common 可以商用吗?

@gui-chat-plugin/common 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gui-chat-plugin/common 的下载量有多少?

根据 npm 官方下载统计,@gui-chat-plugin/common 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,737 次,日均约 158 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gui-chat-plugin/common 还在维护吗?

最新版本 0.1.0 发布于 2026/10/01(1 个月前);至今共发布 1 个版本,其中过去 12 个月发布了 1 个;首次发布于 2026/10/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。