✨ add developer tools choices in 'simple' template

Author: NCBM

.gitignore

@@ -9,6 +9,7 @@ docs_build/_build
 website/docs/api/**/*.md
 website/static/packages/*.whl
 !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/commands/project.py

@@ -75,6 +75,11 @@ def project_name_validator(name: str) -> bool:
     )
 
 
+def project_devtools_validator(devtools: tuple[Choice[str], ...]) -> bool:
+    expanded = {ch.data for ch in devtools}
+    return bool({"pyright", "basedpyright"} - expanded)
+
+
 async def prompt_common_context(context: ProjectContext) -> ProjectContext:
     click.secho(_("Loading adapters..."))
     all_adapters = await list_adapters()
@@ -203,6 +208,23 @@ async def prompt_simple_context(context: ProjectContext) -> ProjectContext:
             style=CLI_DEFAULT_STYLE
         )
     ).data
+    context.variables["devtools"] = [
+        ch.data
+        for ch in await CheckboxPrompt(
+            _("Which developer tool(s) would you like to use?"),
+            [
+                Choice(_("Pylance (Recommended)"), "pyright"),
+                Choice(_("Ruff"), "ruff"),
+                Choice(_("MyPy"), "mypy"),
+                Choice(_("BasedPyright (Advanced user)"), "basedpyright"),
+            ],
+            [0, 1],
+            validator=project_devtools_validator,
+            error_message=_(
+                "Cannot choose 'Pylance' and 'BasedPyright' at the same time."
+            ),
+        ).prompt_async(style=CLI_DEFAULT_STYLE)
+    ]
 
     return context
 

nb_cli/template/project/simple/{{cookiecutter.computed.project_slug}}/.vscode/extensions.json

@@ -0,0 +1,18 @@
+{
+  "recommendations": [
+{%- set extensions = ['"tamasfe.even-better-toml"'] -%}
+{% if "pyright" in cookiecutter.nonebot.devtools -%}
+{% set _ = extensions.append('"ms-python.python"') %}
+{%- endif -%}
+{% if "mypy" in cookiecutter.nonebot.devtools -%}
+{% set _ = extensions.append('"ms-python.mypy-type-checker"') %}
+{%- endif -%}
+{% if "basedpyright" in cookiecutter.nonebot.devtools -%}
+{% set _ = extensions.append('"detachhead.basedpyright"') %}
+{%- endif -%}
+{% if "ruff" in cookiecutter.nonebot.devtools -%}
+{% set _ = extensions.append('"charliermarsh.ruff"') %}
+{%- endif %}
+    {{ extensions|join(",\n")|indent(4) }}
+  ]
+}

nb_cli/template/project/simple/{{cookiecutter.computed.project_slug}}/pyproject.toml

@@ -44,3 +44,60 @@ builtin_plugins = []
 
 [tool.nonebot.plugins]
 "@local" = []
+{% if "ruff" in cookiecutter.nonebot.devtools -%}
+
+[tool.ruff]
+line-length = 88
+target-version = "py39"
+
+[tool.ruff.format]
+line-ending = "lf"
+
+[tool.ruff.lint]
+# For more rules, see https://docs.astral.sh/ruff/rules/.
+select = [
+  "F",     # Pyflakes
+  "W",     # pycodestyle warnings
+  "E",     # pycodestyle errors
+  "I",     # isort
+  "UP",    # pyupgrade
+  "ANN",   # flake8-annotations
+  "ASYNC", # flake8-async
+  "C4",    # flake8-comprehensions
+  "T10",   # flake8-debugger
+  "T20",   # flake8-print
+  "PYI",   # flake8-pyi
+  "Q",     # flake8-quotes
+  "TID",   # flake8-tidy-imports
+  "RUF",   # Ruff-specific rules
+]
+ignore = [
+  "E402",   # module-import-not-at-top-of-file
+  "UP037",  # quoted-annotation
+  "RUF001", # ambiguous-unicode-character-string
+  "RUF002", # ambiguous-unicode-character-docstring
+  "RUF003", # ambiguous-unicode-character-comment
+  "ANN202", # missing-return-type-private-function
+  "ANN401", # any-type
+]
+
+[tool.ruff.lint.pyupgrade]
+keep-runtime-typing = true
+{% endif -%}
+{% if "pyright" in cookiecutter.nonebot.devtools or "basedpyright" in cookiecutter.nonebot.devtools %}
+{% if "pyright" in cookiecutter.nonebot.devtools -%}
+[tool.pyright]
+# For Pylance/Pyright configurations, see https://microsoft.github.io/pyright/#/configuration.
+{%- else -%}
+[tool.basedpyright]
+# For BasedPyright configurations, see https://docs.basedpyright.com/latest/configuration/config-files/.
+{%- endif %}
+pythonVersion = "3.9"
+pythonPlatform = "All"
+typeCheckingMode = "standard"
+{%- endif %}
+{% if "mypy" in cookiecutter.nonebot.devtools %}
+[tool.mypy]
+# For MyPy configurations, see https://mypy.readthedocs.io/en/latest/config_file.html.
+python_version = "3.9"
+{% endif -%}