mofox-plugin-dev-toolkit 0.3.5__tar.gz → 0.4.3__tar.gz

{mofox_plugin_dev_toolkit-0.3.5/mofox_plugin_dev_toolkit.egg-info → mofox_plugin_dev_toolkit-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mofox-plugin-dev-toolkit
-Version: 0.3.5
+Version: 0.4.3
 Summary: 开发工具集，用于快速创建、开发和测试 MoFox-Bot 插件
 Author-email: MoFox-Studio <wwwww95915@qq.com>
 License: GPL-3.0-or-later

{mofox_plugin_dev_toolkit-0.3.5 → mofox_plugin_dev_toolkit-0.4.3/mofox_plugin_dev_toolkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mofox-plugin-dev-toolkit
-Version: 0.3.5
+Version: 0.4.3
 Summary: 开发工具集，用于快速创建、开发和测试 MoFox-Bot 插件
 Author-email: MoFox-Studio <wwwww95915@qq.com>
 License: GPL-3.0-or-later

{mofox_plugin_dev_toolkit-0.3.5 → mofox_plugin_dev_toolkit-0.4.3}/mofox_plugin_dev_toolkit.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ mpdt/__init__.py
 mpdt/__main__.py
 mpdt/cli.py
 mpdt/commands/__init__.py
+mpdt/commands/build.py
 mpdt/commands/check.py
 mpdt/commands/dev.py
 mpdt/commands/generate.py
@@ -20,15 +21,19 @@ mpdt/dev/bridge_plugin/__init__.py
 mpdt/dev/bridge_plugin/cleanup_handler.py
 mpdt/dev/bridge_plugin/dev_config.py
 mpdt/dev/bridge_plugin/file_watcher.py
+mpdt/dev/bridge_plugin/manifest.json
 mpdt/dev/bridge_plugin/plugin.py
 mpdt/templates/__init__.py
 mpdt/templates/action_template.py
 mpdt/templates/adapter_template.py
 mpdt/templates/chatter_template.py
+mpdt/templates/collection_template.py
+mpdt/templates/config_template.py
 mpdt/templates/event_template.py
 mpdt/templates/plus_command_template.py
 mpdt/templates/prompt_template.py
 mpdt/templates/router_template.py
+mpdt/templates/service_template.py
 mpdt/templates/tool_template.py
 mpdt/utils/__init__.py
 mpdt/utils/code_parser.py

{mofox_plugin_dev_toolkit-0.3.5 → mofox_plugin_dev_toolkit-0.4.3}/mpdt/__init__.py

@@ -4,7 +4,7 @@ MoFox Plugin Dev Toolkit
 一个用于 MoFox-Bot 插件开发的工具集
 """
 
-__version__ = "0.3.5"
+__version__ = "0.4.3"
 __author__ = "MoFox-Studio"
 __license__ = "GPL-3.0-or-later"
 

{mofox_plugin_dev_toolkit-0.3.5 → mofox_plugin_dev_toolkit-0.4.3}/mpdt/cli.py

@@ -67,7 +67,7 @@ def init(ctx: click.Context, plugin_name: str | None, template: str, author: str
 
 
 @cli.command()
-@click.argument("component_type", type=click.Choice(["action", "tool", "event", "adapter", "prompt", "plus-command","router","chatter"]), required=False)
+@click.argument("component_type", type=click.Choice(["action", "tool", "event", "adapter", "plus-command", "router", "chatter", "service", "config"]), required=False)
 @click.argument("component_name", required=False)
 @click.option("--description", "-d", help="组件描述")
 @click.option("--output", "-o", type=click.Path(), help="输出目录")
@@ -135,14 +135,31 @@ def check(ctx: click.Context, path: str, level: str, fix: bool, report: str, out
 
 
 @cli.command()
+@click.argument("plugin_path", type=click.Path(), required=False, default=".")
 @click.option("--output", "-o", type=click.Path(), default="dist", help="输出目录")
 @click.option("--with-docs", is_flag=True, help="包含文档")
-@click.option("--format", type=click.Choice(["zip", "tar.gz", "wheel"]), default="zip", help="构建格式")
+@click.option("--format", "fmt", type=click.Choice(["mfp", "zip"]), default="mfp", help="构建格式（mfp 为推荐格式）")
 @click.option("--bump", type=click.Choice(["major", "minor", "patch"]), help="自动升级版本号")
 @click.pass_context
-def build(ctx: click.Context, output: str, with_docs: bool, format: str, bump: str | None) -> None:
-    """构建和打包插件"""
-    console.print("[yellow]⚠️  构建命令尚未实现[/yellow]")
+def build(ctx: click.Context, plugin_path: str, output: str, with_docs: bool, fmt: str, bump: str | None) -> None:
+    """构建并打包插件为 .mfp 文件
+
+    PLUGIN_PATH 为插件根目录（含 manifest.json），默认为当前目录。
+    """
+    from mpdt.commands.build import build_plugin
+
+    try:
+        build_plugin(
+            plugin_path=plugin_path,
+            output_dir=output,
+            with_docs=with_docs,
+            fmt=fmt,
+            bump=bump,
+            verbose=ctx.obj["verbose"],
+        )
+    except Exception as e:
+        console.print(f"[bold red]❌ 构建失败: {e}[/bold red]")
+        raise click.Abort()
 
 
 @cli.command()

mofox_plugin_dev_toolkit-0.4.3/mpdt/commands/__init__.py

@@ -0,0 +1,3 @@
+"""
+命令模块
+"""

mofox_plugin_dev_toolkit-0.4.3/mpdt/commands/build.py

@@ -0,0 +1,300 @@
+"""
+构建命令实现
+
+将插件目录打包为 .mfp 文件（本质为 ZIP 压缩包）。
+loader.py 支持从 .mfp 直接加载插件，与文件夹加载行为一致。
+
+流程：
+1. 验证插件目录及 manifest.json
+2. 可选地自动升级版本号（major / minor / patch）
+3. 收集需打包的文件（排除缓存、版本控制等）
+4. 写入 .mfp（ZIP）或 .zip 文件
+5. 打印构建摘要
+"""
+
+from __future__ import annotations
+
+import json
+import re
+import zipfile
+from pathlib import Path
+
+from rich.panel import Panel
+from rich.table import Table
+
+from mpdt.utils.color_printer import (
+    console,
+    print_error,
+    print_step,
+    print_success,
+    print_warning,
+)
+
+# 构建时默认排除的文件/目录名称（精确匹配）
+_EXCLUDE_NAMES: set[str] = {
+    "__pycache__",
+    ".git",
+    ".gitignore",
+    ".gitattributes",
+    ".github",
+    ".mypy_cache",
+    ".ruff_cache",
+    ".pytest_cache",
+    ".venv",
+    "venv",
+    ".env",
+    "node_modules",
+    "dist",
+    ".DS_Store",
+    "Thumbs.db",
+}
+
+# 排除的文件扩展名
+_EXCLUDE_EXTS: set[str] = {
+    ".pyc",
+    ".pyo",
+    ".pyd",
+    ".egg-info",
+}
+
+# 文档相关目录/文件名
+_DOC_NAMES: set[str] = {
+    "docs",
+    "doc",
+    "README.md",
+    "README.rst",
+    "CHANGELOG.md",
+    "CHANGELOG.rst",
+}
+
+
+def _is_excluded(path: Path, with_docs: bool) -> bool:
+    """判断路径是否应被排除。"""
+    name = path.name
+    if name in _EXCLUDE_NAMES:
+        return True
+    if path.suffix in _EXCLUDE_EXTS:
+        return True
+    # 以 . 开头的隐藏文件/目录
+    if name.startswith("."):
+        return True
+    # 文档文件（若不包含文档）
+    if not with_docs and name in _DOC_NAMES:
+        return True
+    return False
+
+
+def _collect_files(plugin_dir: Path, with_docs: bool) -> list[Path]:
+    """递归收集插件目录中需要打包的文件列表（相对路径）。"""
+    files: list[Path] = []
+
+    for item in sorted(plugin_dir.rglob("*")):
+        # 检查路径上的每个部分是否被排除
+        relative = item.relative_to(plugin_dir)
+        parts = relative.parts
+
+        excluded = False
+        for part in parts:
+            part_path = Path(part)
+            if _is_excluded(part_path, with_docs):
+                excluded = True
+                break
+
+        if excluded:
+            continue
+
+        if item.is_file():
+            files.append(item)
+
+    return files
+
+
+def _bump_version(version: str, bump: str) -> str:
+    """按规则升级版本号（语义化版本 major.minor.patch）。
+
+    Args:
+        version: 当前版本字符串，例如 "1.2.3"
+        bump: 升级类型，"major" / "minor" / "patch"
+
+    Returns:
+        升级后的版本字符串
+
+    Raises:
+        ValueError: 版本格式不合法
+    """
+    match = re.fullmatch(r"(\d+)\.(\d+)\.(\d+)(.*)", version.strip())
+    if not match:
+        raise ValueError(f"版本号格式不合法: '{version}'，应为 major.minor.patch")
+
+    major, minor, patch, suffix = int(match.group(1)), int(match.group(2)), int(match.group(3)), match.group(4)
+
+    if bump == "major":
+        major += 1
+        minor = 0
+        patch = 0
+    elif bump == "minor":
+        minor += 1
+        patch = 0
+    elif bump == "patch":
+        patch += 1
+
+    return f"{major}.{minor}.{patch}{suffix}"
+
+
+def _load_manifest(plugin_dir: Path) -> dict | None:
+    """读取并解析 manifest.json，返回字典；失败返回 None。"""
+    manifest_path = plugin_dir / "manifest.json"
+    if not manifest_path.exists():
+        print_error(f"manifest.json 不存在: {manifest_path}")
+        return None
+    try:
+        with open(manifest_path, encoding="utf-8") as f:
+            return json.load(f)
+    except json.JSONDecodeError as e:
+        print_error(f"manifest.json 解析失败: {e}")
+        return None
+
+
+def _save_manifest(plugin_dir: Path, manifest: dict) -> None:
+    """将 manifest 字典写回 manifest.json。"""
+    manifest_path = plugin_dir / "manifest.json"
+    with open(manifest_path, "w", encoding="utf-8") as f:
+        json.dump(manifest, f, ensure_ascii=False, indent=4)
+
+
+def build_plugin(
+    plugin_path: str = ".",
+    output_dir: str = "dist",
+    with_docs: bool = False,
+    fmt: str = "mfp",
+    bump: str | None = None,
+    verbose: bool = False,
+) -> None:
+    """构建并打包插件为 .mfp / .zip 文件。
+
+    Args:
+        plugin_path: 插件根目录（包含 manifest.json）
+        output_dir:  输出目录，默认 dist/
+        with_docs:   是否将文档文件打入包中
+        fmt:         输出格式，"mfp"（推荐） 或 "zip"
+        bump:        自动升级版本，"major" / "minor" / "patch" / None
+        verbose:     是否显示详细信息
+    """
+    plugin_dir = Path(plugin_path).resolve()
+
+    # ── 1. 基本验证 ──────────────────────────────────────────────────────────
+    if not plugin_dir.exists():
+        print_error(f"插件路径不存在: {plugin_dir}")
+        return
+    if not plugin_dir.is_dir():
+        print_error(f"插件路径不是目录: {plugin_dir}")
+        return
+
+    console.print(Panel.fit(f"📦 构建插件: [cyan]{plugin_dir.name}[/cyan]", border_style="blue"))
+
+    manifest = _load_manifest(plugin_dir)
+    if manifest is None:
+        return
+
+    required = ["name", "version", "description", "author", "entry_point"]
+    for field in required:
+        if field not in manifest:
+            print_error(f"manifest.json 缺少必需字段: '{field}'")
+            return
+
+    plugin_name: str = manifest["name"]
+    plugin_version: str = manifest["version"]
+
+    # ── 2. 版本升级 ──────────────────────────────────────────────────────────
+    if bump:
+        try:
+            new_version = _bump_version(plugin_version, bump)
+        except ValueError as e:
+            print_error(str(e))
+            return
+        print_step(f"版本升级: [yellow]{plugin_version}[/yellow] → [green]{new_version}[/green]")
+        manifest["version"] = new_version
+        _save_manifest(plugin_dir, manifest)
+        plugin_version = new_version
+
+    # ── 3. 验证入口文件 ───────────────────────────────────────────────────────
+    entry_point = manifest.get("entry_point", "plugin.py")
+    entry_file = plugin_dir / entry_point
+    if not entry_file.exists():
+        print_warning(f"入口文件不存在: {entry_point}（仍将继续构建）")
+
+    # ── 4. 收集文件 ───────────────────────────────────────────────────────────
+    print_step("收集文件...")
+    files = _collect_files(plugin_dir, with_docs)
+
+    if not files:
+        print_warning("未找到任何需要打包的文件")
+        return
+
+    if verbose:
+        for f in files:
+            rel = f.relative_to(plugin_dir)
+            console.print(f"  [dim]+ {rel}[/dim]")
+
+    # ── 5. 确定输出路径 ───────────────────────────────────────────────────────
+    # output_dir 可以是绝对路径或相对于插件目录
+    out_path = Path(output_dir)
+    if not out_path.is_absolute():
+        out_path = plugin_dir / output_dir
+
+    out_path.mkdir(parents=True, exist_ok=True)
+
+    suffix = ".mfp" if fmt == "mfp" else ".zip"
+    archive_name = f"{plugin_name}-{plugin_version}{suffix}"
+    archive_path = out_path / archive_name
+
+    if archive_path.exists():
+        print_warning(f"目标文件已存在，将覆盖: {archive_path}")
+
+    # ── 6. 压缩打包 ───────────────────────────────────────────────────────────
+    print_step(f"正在写入 {suffix} 包...")
+    total_bytes = 0
+
+    try:
+        with zipfile.ZipFile(archive_path, "w", compression=zipfile.ZIP_DEFLATED) as zf:
+            for file_path in files:
+                arcname = file_path.relative_to(plugin_dir)
+                zf.write(file_path, arcname)
+                total_bytes += file_path.stat().st_size
+                if verbose:
+                    console.print(f"  [dim]  → {arcname}[/dim]")
+    except Exception as e:
+        print_error(f"打包失败: {e}")
+        # 清理不完整的文件
+        if archive_path.exists():
+            archive_path.unlink()
+        return
+
+    # ── 7. 摘要 ──────────────────────────────────────────────────────────────
+    archive_size = archive_path.stat().st_size
+
+    table = Table(show_header=False, box=None, padding=(0, 2))
+    table.add_column(style="cyan")
+    table.add_column(style="white")
+    table.add_row("插件名称", plugin_name)
+    table.add_row("版本", plugin_version)
+    table.add_row("作者", manifest.get("author", "-"))
+    table.add_row("入口文件", entry_point)
+    table.add_row("打包文件数", str(len(files)))
+    table.add_row("原始大小", _format_size(total_bytes))
+    table.add_row("包大小", _format_size(archive_size))
+    table.add_row("输出路径", str(archive_path))
+
+    console.print()
+    console.print(table)
+    console.print()
+    print_success(f"构建完成: {archive_path.name}")
+
+
+def _format_size(size: int) -> str:
+    """将字节数格式化为人类可读字符串。"""
+    for unit in ("B", "KB", "MB", "GB"):
+        if size < 1024:
+            return f"{size:.1f} {unit}"
+        size //= 1024
+    return f"{size:.1f} TB"