mofox-plugin-dev-toolkit 0.5.0__tar.gz → 0.5.1__tar.gz

{mofox_plugin_dev_toolkit-0.5.0/mofox_plugin_dev_toolkit.egg-info → mofox_plugin_dev_toolkit-0.5.1}/PKG-INFO

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

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1/mofox_plugin_dev_toolkit.egg-info}/PKG-INFO

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

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1}/mofox_plugin_dev_toolkit.egg-info/SOURCES.txt

@@ -49,6 +49,7 @@ mpdt/utils/config_loader.py
 mpdt/utils/config_manager.py
 mpdt/utils/file_ops.py
 mpdt/utils/license_generator.py
+mpdt/utils/manifest_metadata.py
 mpdt/utils/plugin_parser.py
 mpdt/utils/template_engine.py
 mpdt/validators/__init__.py

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1}/mpdt/commands/build.py

@@ -16,6 +16,7 @@ from __future__ import annotations
 
 import json
 import re
+import sys
 import zipfile
 from dataclasses import dataclass
 from hashlib import sha256
@@ -31,6 +32,7 @@ from mpdt.utils.color_printer import (
     print_success,
     print_warning,
 )
+from mpdt.utils.manifest_metadata import ensure_manifest_metadata_interactive, metadata_errors
 
 # 构建时默认排除的文件/目录名称（精确匹配）
 _EXCLUDE_NAMES: set[str] = {
@@ -179,6 +181,18 @@ def _save_manifest(plugin_dir: Path, manifest: dict) -> None:
         json.dump(manifest, f, ensure_ascii=False, indent=4)
 
 
+def _validate_manifest_metadata(manifest: dict) -> None:
+    """验证打包所需的 manifest 元数据。"""
+    required = ["name", "version", "description", "author", "entry_point"]
+    for field in required:
+        if field not in manifest:
+            raise ValueError(f"manifest.json 缺少必需字段: '{field}'")
+
+    errors = metadata_errors(manifest)
+    if errors:
+        raise ValueError(errors[0])
+
+
 def build_plugin(
     plugin_path: str = ".",
     output_dir: str = "dist",
@@ -263,10 +277,9 @@ def build_package(
     if manifest is None:
         return
 
-    required = ["name", "version", "description", "author", "entry_point"]
-    for field in required:
-        if field not in manifest:
-            raise ValueError(f"manifest.json 缺少必需字段: '{field}'")
+    manifest = ensure_manifest_metadata_interactive(plugin_dir, manifest)
+
+    _validate_manifest_metadata(manifest)
 
     plugin_name: str = manifest["name"]
     plugin_version: str = manifest["version"]

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1}/mpdt/commands/check.py

@@ -2,12 +2,15 @@
 静态检查命令实现
 """
 
+import json
+
 from pathlib import Path
 
 from rich.panel import Panel
 from rich.table import Table
 
 from mpdt.utils.color_printer import console, print_error, print_info, print_success, print_warning
+from mpdt.utils.manifest_metadata import ensure_manifest_metadata_interactive
 from mpdt.validators import (
     AutoFixValidator,
     ComponentValidator,
@@ -77,6 +80,17 @@ def check_plugin(
     # 元数据验证
     if not skip_metadata:
         print_info("正在检查插件元数据...")
+        manifest_path = path / "manifest.json"
+        if manifest_path.exists():
+            try:
+                with open(manifest_path, encoding="utf-8") as f:
+                    manifest_data = json.load(f)
+                ensure_manifest_metadata_interactive(path, manifest_data)
+            except json.JSONDecodeError:
+                pass
+            except ValueError as e:
+                print_error(str(e))
+                return
         validator = MetadataValidator(path)
         result = validator.validate()
         all_results.append(result)

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1}/mpdt/commands/init.py

@@ -17,6 +17,7 @@ from typing import Any
 
 import questionary
 
+from mpdt.utils.manifest_metadata import prompt_manifest_metadata
 from mpdt.utils.color_printer import (
     console,
     print_error,
@@ -64,12 +65,20 @@ def init_plugin(
     if not plugin_name:
         plugin_info = _interactive_init()
         plugin_name = plugin_info["plugin_name"]
+        description = plugin_info.get("description", "")
         template = plugin_info["template"]
         author = plugin_info.get("author")
         email = plugin_info.get("email")
         license_type = plugin_info["license"]
         with_docs = plugin_info.get("with_docs", False)
         init_git = plugin_info.get("init_git", False)
+        categories = plugin_info["categories"]
+        tags = plugin_info["tags"]
+    else:
+        description = ""
+        metadata = prompt_manifest_metadata()
+        categories = metadata["categories"]
+        tags = metadata["tags"]
 
     # 此时 plugin_name 必定不为 None
     assert plugin_name is not None
@@ -96,11 +105,14 @@ def init_plugin(
     _create_plugin_structure(
         plugin_dir=plugin_dir,
         plugin_name=plugin_name,
+        description=description,
         template=template,
         author=author,
         email=email,
         license_type=license_type,
         with_docs=with_docs,
+        categories=categories,
+        tags=tags,
         verbose=verbose,
     )
 
@@ -194,6 +206,10 @@ def _interactive_init() -> dict[str, Any]:
         ),
     ).ask()
 
+    metadata = prompt_manifest_metadata()
+    answers["categories"] = metadata["categories"]
+    answers["tags"] = metadata["tags"]
+
     return answers
 
         # ============================================================================
@@ -204,11 +220,14 @@ def _interactive_init() -> dict[str, Any]:
 def _create_plugin_structure(
     plugin_dir: Path,
     plugin_name: str,
+    description: str,
     template: str,
     author: str | None,
     email: str | None,
     license_type: str,
     with_docs: bool,
+    categories: list[str],
+    tags: list[str],
     verbose: bool,
 ) -> None:
     """创建插件目录结构"""
@@ -217,7 +236,7 @@ def _create_plugin_structure(
     ensure_dir(plugin_dir)
 
     # 创建 manifest.json
-    manifest_content = _generate_manifest_file(plugin_name, author, template)
+    manifest_content = _generate_manifest_file(plugin_name, author, template, description, categories, tags)
     safe_write_file(plugin_dir / "manifest.json", manifest_content)
     if verbose:
         console.print("[dim]✓ 生成清单文件: manifest.json[/dim]")
@@ -281,7 +300,14 @@ def _create_plugin_structure(
         console.print(f"[dim]✓ 生成许可证文件: {license_type}[/dim]")
 
 
-def _generate_manifest_file(plugin_name: str, author: str | None, template: str, description: str = "") -> str:
+def _generate_manifest_file(
+    plugin_name: str,
+    author: str | None,
+    template: str,
+    description: str = "",
+    categories: list[str] | None = None,
+    tags: list[str] | None = None,
+) -> str:
     """生成 manifest.json 文件内容
 
     Args:
@@ -346,6 +372,8 @@ def _generate_manifest_file(plugin_name: str, author: str | None, template: str,
         "version": "1.0.0",
         "description": description or f"{plugin_name} 插件",
         "author": author or "Your Name",
+        "categories": categories or ["tool"],
+        "tags": tags or [plugin_name],
         "dependencies": {"plugins": [], "components": []},
         "include": template_components.get(template, []),
         "entry_point": "plugin.py",

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1}/mpdt/commands/market.py

@@ -30,6 +30,7 @@ from mpdt.market.manifest import (
     version_payload,
 )
 from mpdt.utils.color_printer import console
+from mpdt.utils.manifest_metadata import ensure_manifest_metadata_interactive_async
 
 
 def market_doctor(market_url: str | None = None, token: str | None = None) -> None:
@@ -49,7 +50,7 @@ def market_register(plugin_path: str = ".", market_url: str | None = None, token
     """Register a plugin in the market."""
 
     async def run() -> None:
-        manifest = load_manifest(plugin_path)
+        manifest = await _load_manifest_for_market(plugin_path)
         payload = plugin_payload(manifest, repository_url=repository_url)
         result = await _client(market_url, token).register_plugin(payload)
         _print_ok(f"Plugin registered: {result['plugin_id']} ({result['status']})")
@@ -61,7 +62,7 @@ def market_update(plugin_path: str = ".", market_url: str | None = None, token:
     """Update plugin metadata in the market."""
 
     async def run() -> None:
-        manifest = load_manifest(plugin_path)
+        manifest = await _load_manifest_for_market(plugin_path)
         payload = plugin_payload(manifest, repository_url=repository_url)
         plugin_id = payload.pop("plugin_id")
         result = await _client(market_url, token).update_plugin(plugin_id, payload)
@@ -98,7 +99,7 @@ def market_submit_version(
     """Build and submit a plugin version to the market."""
 
     async def run() -> None:
-        manifest = load_manifest(plugin_path)
+        manifest = await _load_manifest_for_market(plugin_path)
         package = build_package(plugin_path=plugin_path, output_dir=output_dir, with_docs=with_docs, fmt="mfp", show_progress=False)
         if package is None:
             return
@@ -132,7 +133,7 @@ def market_sync(
     """Rebuild and sync version metadata."""
 
     async def run() -> None:
-        manifest = load_manifest(plugin_path)
+        manifest = await _load_manifest_for_market(plugin_path)
         package = build_package(plugin_path=plugin_path, output_dir=output_dir, with_docs=with_docs, fmt="mfp", show_progress=False)
         if package is None:
             return
@@ -173,7 +174,7 @@ def market_publish(
 
     async def run() -> None:
         plugin_dir = Path(plugin_path).resolve()
-        manifest = load_manifest(str(plugin_dir))
+        manifest = await _load_manifest_for_market(str(plugin_dir))
         package = build_package(plugin_path=str(plugin_dir), output_dir=output_dir, with_docs=with_docs, fmt="mfp", show_progress=False)
         if package is None:
             return
@@ -433,6 +434,14 @@ def _run_market(awaitable) -> None:
         _print_error(f"Market server connection failed: {e}")
 
 
+async def _load_manifest_for_market(plugin_path: str) -> dict:
+    """Load manifest and repair required market metadata in async flows before proceeding."""
+    resolved_path = Path(plugin_path).resolve()
+    manifest = load_manifest(str(resolved_path))
+    await ensure_manifest_metadata_interactive_async(resolved_path, manifest)
+    return load_manifest(str(resolved_path))
+
+
 def _print_ok(message: str) -> None:
     """Print an ASCII success message."""
 

mofox_plugin_dev_toolkit-0.5.1/mpdt/utils/manifest_metadata.py

@@ -0,0 +1,199 @@
+"""Manifest metadata rules and interactive prompts."""
+
+from __future__ import annotations
+
+import asyncio
+import json
+import sys
+from pathlib import Path
+from typing import Any
+
+import questionary
+
+from .color_printer import print_success, print_warning
+
+ALLOWED_CATEGORIES = ("tool", "chat", "fun", "information", "moderation")
+
+
+def get_categories(manifest: dict[str, Any]) -> list[str]:
+    """Return normalized categories from manifest."""
+    value = manifest.get("categories")
+    if not isinstance(value, list):
+        return []
+    return [item.strip() for item in value if isinstance(item, str) and item.strip()]
+
+
+def get_tags(manifest: dict[str, Any]) -> list[str]:
+    """Return normalized tags from manifest."""
+    value = manifest.get("tags")
+    if not isinstance(value, list):
+        return []
+    normalized: list[str] = []
+    for item in value:
+        if not isinstance(item, str):
+            continue
+        tag = item.strip()
+        if tag and tag not in normalized:
+            normalized.append(tag)
+    return normalized
+
+
+def normalize_tags(raw_tags: str) -> list[str]:
+    """Parse raw tag input into a de-duplicated tag list."""
+    tags: list[str] = []
+    normalized_input = raw_tags.replace("，", ",").replace("\n", ",")
+    for part in normalized_input.split(","):
+        tag = part.strip()
+        if tag and tag not in tags:
+            tags.append(tag)
+    return tags
+
+
+def categories_are_valid(manifest: dict[str, Any]) -> bool:
+    """Return whether manifest categories satisfy the packaging rules."""
+    categories = get_categories(manifest)
+    return len(categories) == 1 and categories[0] in ALLOWED_CATEGORIES
+
+
+def tags_are_valid(manifest: dict[str, Any]) -> bool:
+    """Return whether manifest tags satisfy the packaging rules."""
+    return bool(get_tags(manifest))
+
+
+def metadata_errors(manifest: dict[str, Any]) -> list[str]:
+    """Return validation errors for required manifest metadata."""
+    errors: list[str] = []
+    if not categories_are_valid(manifest):
+        allowed = ", ".join(ALLOWED_CATEGORIES)
+        errors.append(f"manifest.json 的 categories 必须是只包含一个值的数组，且取值只能是: {allowed}")
+    if not tags_are_valid(manifest):
+        errors.append("manifest.json 的 tags 必须是至少包含一个非空字符串的数组")
+    return errors
+
+
+def _is_interactive_terminal() -> bool:
+    """Return whether stdin/stdout are attached to a TTY."""
+    return sys.stdin.isatty() and sys.stdout.isatty()
+
+
+def _has_running_event_loop() -> bool:
+    """Return whether the current thread is already inside a running event loop."""
+    try:
+        asyncio.get_running_loop()
+    except RuntimeError:
+        return False
+    return True
+
+
+def _finalize_manifest_metadata(manifest: dict[str, Any]) -> dict[str, Any]:
+    """Normalize legacy single-value metadata keys."""
+    manifest.pop("category", None)
+    manifest.pop("tag", None)
+    return manifest
+
+
+def _save_manifest(plugin_dir: Path, manifest: dict[str, Any]) -> None:
+    """Persist manifest.json after interactive metadata repair."""
+    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 prompt_manifest_metadata(existing_manifest: dict[str, Any] | None = None) -> dict[str, list[str]]:
+    """Collect required manifest metadata from the console."""
+    manifest = existing_manifest or {}
+    existing_categories = get_categories(manifest)
+    default_category = existing_categories[0] if existing_categories else ALLOWED_CATEGORIES[0]
+    existing_tags = ", ".join(get_tags(manifest))
+
+    category = questionary.select(
+        "选择插件分类 categories（只能选一个）:",
+        choices=[questionary.Choice(item, value=item) for item in ALLOWED_CATEGORIES],
+        default=default_category,
+    ).ask()
+    if category is None:
+        raise ValueError("已取消填写 categories")
+
+    tags_text = questionary.text(
+        "填写插件 tags（多个标签用逗号分隔）:",
+        default=existing_tags,
+        validate=lambda value: bool(normalize_tags(value)) or "至少填写一个 tag",
+    ).ask()
+    if tags_text is None:
+        raise ValueError("已取消填写 tags")
+
+    return {
+        "categories": [category],
+        "tags": normalize_tags(tags_text),
+    }
+
+
+async def prompt_manifest_metadata_async(existing_manifest: dict[str, Any] | None = None) -> dict[str, list[str]]:
+    """Collect required manifest metadata from the console inside an event loop."""
+    manifest = existing_manifest or {}
+    existing_categories = get_categories(manifest)
+    default_category = existing_categories[0] if existing_categories else ALLOWED_CATEGORIES[0]
+    existing_tags = ", ".join(get_tags(manifest))
+
+    category = await questionary.select(
+        "选择插件分类 categories（只能选一个）:",
+        choices=[questionary.Choice(item, value=item) for item in ALLOWED_CATEGORIES],
+        default=default_category,
+    ).ask_async()
+    if category is None:
+        raise ValueError("已取消填写 categories")
+
+    tags_text = await questionary.text(
+        "填写插件 tags（多个标签用逗号分隔）:",
+        default=existing_tags,
+        validate=lambda value: bool(normalize_tags(value)) or "至少填写一个 tag",
+    ).ask_async()
+    if tags_text is None:
+        raise ValueError("已取消填写 tags")
+
+    return {
+        "categories": [category],
+        "tags": normalize_tags(tags_text),
+    }
+
+
+def ensure_manifest_metadata_interactive(plugin_dir: Path, manifest: dict[str, Any]) -> dict[str, Any]:
+    """Prompt for missing manifest metadata and persist it when running in a TTY."""
+    errors = metadata_errors(manifest)
+    if not errors:
+        return _finalize_manifest_metadata(manifest)
+
+    if not _is_interactive_terminal() or _has_running_event_loop():
+        return manifest
+
+    print_warning("检测到 manifest.json 缺少或无效的 categories/tags，进入交互补全...")
+    for error in errors:
+        print_warning(error)
+
+    manifest.update(prompt_manifest_metadata(manifest))
+    _finalize_manifest_metadata(manifest)
+    _save_manifest(plugin_dir, manifest)
+
+    print_success("已更新 manifest.json 中的 categories 和 tags")
+    return manifest
+
+
+async def ensure_manifest_metadata_interactive_async(plugin_dir: Path, manifest: dict[str, Any]) -> dict[str, Any]:
+    """Async prompt for missing manifest metadata and persist it when running in a TTY."""
+    errors = metadata_errors(manifest)
+    if not errors:
+        return _finalize_manifest_metadata(manifest)
+
+    if not _is_interactive_terminal():
+        return manifest
+
+    print_warning("检测到 manifest.json 缺少或无效的 categories/tags，进入交互补全...")
+    for error in errors:
+        print_warning(error)
+
+    manifest.update(await prompt_manifest_metadata_async(manifest))
+    _finalize_manifest_metadata(manifest)
+    _save_manifest(plugin_dir, manifest)
+
+    print_success("已更新 manifest.json 中的 categories 和 tags")
+    return manifest

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1}/mpdt/validators/metadata_validator.py

@@ -4,6 +4,7 @@
 
 import json
 
+from ..utils.manifest_metadata import metadata_errors
 from .base import BaseValidator, ValidationResult
 
 
@@ -71,6 +72,13 @@ class MetadataValidator(BaseValidator):
         else:
             self.result.add_info("所有必需的元数据字段都已提供")
 
+        for error in metadata_errors(manifest_data):
+            self.result.add_error(
+                error,
+                file_path="manifest.json",
+                suggestion='请填写 "categories": ["tool|chat|fun|information|moderation"] 和 "tags": ["..."]',
+            )
+
         # 检查推荐字段
         missing_recommended = []
         for field in self.RECOMMENDED_FIELDS:

{mofox_plugin_dev_toolkit-0.5.0 → mofox_plugin_dev_toolkit-0.5.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mofox-plugin-dev-toolkit"
-version = "0.5.0"
+version = "0.5.1"
 description = "开发工具集，用于快速创建、开发和测试 MoFox-Bot 插件"
 authors = [
     {name = "MoFox-Studio", email = "wwwww95915@qq.com"}