Metadata-Version: 2.3
Name: nonebot-plugin-treehelp
Version: 0.5.0
Summary: 适用于 Nonebot2 的树形帮助插件
Project-URL: Homepage, https://github.com/he0119/nonebot-plugin-treehelp
Project-URL: Repository, https://github.com/he0119/nonebot-plugin-treehelp.git
Project-URL: Issues, https://github.com/he0119/nonebot-plugin-treehelp/issues
Project-URL: Changelog, https://github.com/he0119/nonebot-plugin-treehelp/blob/main/CHANGELOG.md
Author-email: uy_sun <hmy0119@gmail.com>
License: MIT License
        
        Copyright (c) 2022 hemengyang
        
        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.
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: nonebot2>=2.2.0
Provides-Extra: alconna
Requires-Dist: nonebot-plugin-alconna>=0.49.0; extra == 'alconna'
Description-Content-Type: text/markdown

<!-- markdownlint-disable MD033 MD036 MD041 -->

<p align="center">
  <a href="https://v2.nonebot.dev/"><img src="https://v2.nonebot.dev/logo.png" width="200" height="200" alt="nonebot"></a>
</p>

<div align="center">

# NoneBot Plugin TreeHelp

_✨ NoneBot 树形帮助插件 ✨_

</div>

<p align="center">
  <a href="https://raw.githubusercontent.com/he0119/nonebot-plugin-treehelp/main/LICENSE">
    <img src="https://img.shields.io/github/license/he0119/nonebot-plugin-treehelp.svg" alt="license">
  </a>
  <a href="https://pypi.python.org/pypi/nonebot-plugin-treehelp">
    <img src="https://img.shields.io/pypi/v/nonebot-plugin-treehelp.svg" alt="pypi">
  </a>
  <img src="https://img.shields.io/badge/python-3.9+-blue.svg" alt="python">
  <a href="https://codecov.io/gh/he0119/nonebot-plugin-treehelp">
    <img src="https://codecov.io/gh/he0119/nonebot-plugin-treehelp/branch/main/graph/badge.svg?token=jd5ufc1alv" alt="codecov"/>
  </a>
  <a href="https://jq.qq.com/?_wv=1027&k=7zQUpiGp">
    <img src="https://img.shields.io/badge/QQ%E7%BE%A4-730374631-orange?style=flat-square" alt="QQ Chat Group">
  </a>
</p>

## 简介

使用插件元数据获取插件信息，并通过插件与子插件的组织形式，来区分插件的多种功能。

树形帮助插件，最重要的功能当然是显示插件树！

发送 `/help --tree`，你将获得如下帮助：

```text
插件：
帮助 # 获取插件帮助信息
测试 # 一个测试插件
├── 复杂功能 # 测试插件复杂子插件
│   └── 二级功能 # 测试插件二级插件
└── 简单功能 # 测试插件简单子插件
```

## 使用方式

加载插件后发送 `/help help` 或 `/help --help` 获取具体用法。

## 插件适配

插件与子插件写法可参考 [示例插件](./tests/plugins/tree/)。

### 声明适配器

通过设置 adapters 属性来指定支持的适配器。如果不设置或留空则默认支持全部适配器。如果插件不支持该适配器，则不会在帮助列表上显示。

```python
__plugin_meta__ = PluginMetadata(
    name="OneBot",
    description="测试 OneBot 适配器",
    usage="/onebot",
    type="application",
    supported_adapters={"~onebot.v11", "~onebot.v12"},
)
```

## 配置项

配置方式：直接在 `NoneBot` 全局配置文件中添加以下配置项即可。

### treehelp_ignored_plugins

- 类型: `list[str]`
- 默认: `[]`
- 说明: 需要忽略的插件名称列表

## 计划

- [ ] 支持输出插件版本
- [x] 支持输出插件树
- [ ] 支持输出插件内的命令名称
