✨ Feature: CLI 用户体验优化 (#150)

Author: NCBM

.gitignore

@@ -8,7 +8,8 @@ docs_build/_build
 .docusaurus
 website/docs/api/**/*.md
 website/static/packages/*.whl
-!nb_cli/project/{{cookiecutter.project_slug}}/.env
+!nb_cli/template/project/*/{{cookiecutter.computed.project_slug}}/.env*
+!nb_cli/template/project/simple/{{cookiecutter.computed.project_slug}}/.vscode
 
 # Created by https://www.toptal.com/developers/gitignore/api/node,macos,linux,python,windows,jetbrains,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=node,macos,linux,python,windows,jetbrains,visualstudiocode

.pre-commit-config.yaml

@@ -31,6 +31,7 @@ repos:
       - id: prettier
         types_or: [javascript, jsx, ts, tsx, markdown, yaml, json]
         stages: [pre-commit]
+        exclude: ^nb_cli/template/project/.*\.json$
 
   - repo: https://github.com/nonebot/nonemoji
     rev: v0.1.4

nb_cli/cli/__init__.py

@@ -2,7 +2,7 @@
 from typing import Optional, cast
 
 import click
-from noneprompt import Choice, ListPrompt, CancelledError
+from noneprompt import Choice, ListPrompt, ConfirmPrompt, CancelledError
 
 from nb_cli import _, __version__
 from nb_cli.handlers import draw_logo
@@ -16,6 +16,22 @@
 from .customize import ClickAliasedCommand as ClickAliasedCommand
 
 
+@click.command  # this command only appears in interactive mode.
+@click.pass_context
+@run_async
+async def exit_(ctx: click.Context):
+    if await ConfirmPrompt(_("Are you sure to exit NB CLI?"), True).prompt_async(
+        style=CLI_DEFAULT_STYLE
+    ):
+        ctx.exit()
+
+
+@click.command  # this command only appears in interactive mode.
+def back_():
+    # nothing to do, just to keep a command to avoid type violation
+    return
+
+
 def _set_global_working_dir(
     ctx: click.Context, param: click.Option, value: Optional[Path]
 ):
@@ -93,28 +109,44 @@ async def cli(ctx: click.Context):
                     sub_cmd,
                 )
             )
+    _exit_choice = Choice(_("Exit NB CLI."), exit_)
+    choices.append(_exit_choice)
 
     click.secho(draw_logo(), fg="cyan", bold=True)
     click.echo("\n\b")
     click.secho(_("Welcome to NoneBot CLI!"), fg="green", bold=True)
 
-    # prompt user to choose
-    try:
-        result = await ListPrompt(
-            _("What do you want to do?"), choices=choices
-        ).prompt_async(style=CLI_DEFAULT_STYLE)
-    except CancelledError:
-        ctx.exit()
-
-    sub_cmd = result.data
-    await run_sync(ctx.invoke)(sub_cmd)
-
-
-from .commands import run, self, create, driver, plugin, adapter, generate
+    while True:
+        # prompt user to choose
+        try:
+            result = await ListPrompt(
+                _("What do you want to do?"), choices=choices
+            ).prompt_async(style=CLI_DEFAULT_STYLE)
+        except CancelledError:
+            result = _exit_choice
+
+        sub_cmd = result.data
+        ctx.params["can_back_to_parent"] = True
+        await run_sync(ctx.invoke)(sub_cmd)
+
+
+from .commands import (
+    run,
+    self,
+    create,
+    driver,
+    plugin,
+    adapter,
+    generate,
+    upgrade_format,
+    downgrade_format,
+)
 
 cli.add_command(create)
 cli.add_command(run)
 cli.add_command(generate)
+cli.add_command(upgrade_format)
+cli.add_command(downgrade_format)
 
 cli.add_command(plugin)
 

nb_cli/cli/commands/__init__.py

@@ -5,3 +5,5 @@
 from .project import create as create
 from .adapter import adapter as adapter
 from .project import generate as generate
+from .project import upgrade_format as upgrade_format
+from .project import downgrade_format as downgrade_format