@dsh-cc/command-config 0.6.1 → 0.6.2

package/README.i18n.yaml

@@ -0,0 +1,6 @@
+# Bilingual-pair consistency record (docs/i18n/README.md): the git blob hash of each
+# side as of the last confirmed-consistent state. Both languages carry equal authority;
+# after editing either side, bring the other along and re-record with:
+#   pnpm check:readme --write
+README.md: 7afa923e6d28a5c5334522d0603f2f4fbbbc0332
+README.zh.md: 312104a076f5226835beba14c44bae65affdaa2e

package/README.md

@@ -0,0 +1,27 @@
+# @dsh-cc/command-config
+
+English | [中文](README.zh.md)
+
+Human-facing `/config` slash command for the settings service: render the effective configuration namespaces, or write an allowlisted key/value into a namespace scope. Invalid keys or scopes produce a friendly message, never a thrown error.
+
+## Usage
+
+```ts
+import { apply } from '@dsh-cc/command-config'
+
+apply(ctx, {
+  defaultScope: 'ui-theme',
+  allowlist: ['ui-theme.theme', 'ui-theme.fontSize'],
+})
+```
+
+## What it provides
+
+- `/config` — with no arguments, lists every registered settings namespace as `namespace = value (applies)`.
+- `/config [key] [value] [scope]` — parses the update, defaults the scope to `defaultScope` (default `ui-theme`), parses the value as JSON when it looks structured (else a string), and writes it through the settings service.
+- Writes are gated by a restricted allowlist of `namespace` or `namespace.key` entries; the default allowlist is `ui-theme.theme` and `ui-theme.fontSize`. Everything else is refused with a hint of the writable keys.
+
+## Notes
+
+- Injects the `commands` and `settings` services; wraps the command with `@dsh-cc/command-usage` so `help`/`-h`/`--help` render deterministic help.
+- Errors from the settings update are reported as text, not thrown.

package/README.zh.md

@@ -0,0 +1,27 @@
+# @dsh-cc/command-config
+
+[English](README.md) | 中文
+
+面向用户的 `/config` 斜杠命令，对接设置服务：渲染生效的配置命名空间，或向某个命名空间写入白名单内的键值。无效的键或作用域只会返回友好的提示文本，绝不抛出错误。
+
+## 用法
+
+```ts
+import { apply } from '@dsh-cc/command-config'
+
+apply(ctx, {
+  defaultScope: 'ui-theme',
+  allowlist: ['ui-theme.theme', 'ui-theme.fontSize'],
+})
+```
+
+## 提供的能力
+
+- `/config` —— 不带参数时，将每个已注册的设置命名空间渲染为 `namespace = value (applies)` 一行。
+- `/config [key] [value] [scope]` —— 解析更新参数，作用域缺省为 `defaultScope`（默认 `ui-theme`），值在形似结构化数据时按 JSON 解析（否则按字符串），并通过设置服务写入。
+- 写入受 `namespace` 或 `namespace.key` 形式的受限白名单约束；默认白名单为 `ui-theme.theme` 和 `ui-theme.fontSize`。其余写入一律拒绝，并提示可写的键。
+
+## 备注
+
+- 注入 `commands` 与 `settings` 服务；命令经 `@dsh-cc/command-usage` 包装，因此 `help`/`-h`/`--help` 会渲染确定性的帮助文本。
+- 设置更新产生的错误以文本形式报告，不会抛出。

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dsh-cc/command-config",
   "description": "Human-facing slash command to show or update effective configuration namespaces",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/dsh-cc/dsh-cc.git",
@@ -44,6 +44,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@dsh-cc/command-usage": "^0.6.1"
+    "@dsh-cc/command-usage": "^0.6.2"
   }
 }