Add VS Code integration

.github/assets/cookiecutter-scverse-instance.json

@@ -8,6 +8,7 @@
         "github_user": "scverse",
         "github_repo": "cookiecutter-scverse-instance",
         "license": "BSD 3-Clause License",
+        "ide_integration": true,
         "_copy_without_render": [
             ".github/workflows/**.yaml",
             "docs/_templates/autosummary/**.rst"

.prettierrc.yaml

@@ -0,0 +1,7 @@
+overrides:
+  # JSON with comments and trailing commas
+  - files: "**/*.vscode*/*.json"
+    options:
+      parser: json5
+      quoteProps: preserve
+      singleQuote: false

cookiecutter.json

@@ -14,6 +14,7 @@
         "GNU General Public License Version 3",
         "Unlicense"
     ],
+    "ide_integration": true,
     "_copy_without_render": [
         ".github/workflows/build.yaml",
         ".github/workflows/test.yaml",

hooks/post_gen_project.py

@@ -1,12 +1,27 @@
 #!/bin/env python3
+import shutil
 from subprocess import run
-{% if not cookiecutter._render_devdocs %}
 from pathlib import Path
 
+{% if not cookiecutter._render_devdocs %}
 # Post processing
 Path("docs/template_usage.md").unlink()
 {% endif %}
 
+# Skip directories marked for skipping
+def skipped_dirs():
+    for toplevel in Path().iterdir():
+        if toplevel.name == ".git":
+            continue
+        if toplevel.name == "DELETE-ME":
+            yield toplevel
+        else:
+            yield from toplevel.rglob("DELETE-ME")
+
+for path in skipped_dirs():
+    assert path.is_dir(), path
+    shutil.rmtree(path)
+
 # Update pre commit hooks
 run("pre-commit autoupdate -c .pre-commit-config.yaml".split(), check=True)
 run("pre-commit install".split(), check=True)

scripts/tests/test_build.py

@@ -18,14 +18,21 @@
 @pytest.mark.parametrize(
     ("params", "path", "pattern"),
     [
-        ({}, "docs/conf.py", r'"github_repo": project_name,'),
-        ({"github_repo": "floob"}, "docs/conf.py", r'"github_repo": "floob",'),
+        pytest.param({}, "docs/conf.py", r'"github_repo": project_name,', id="no_gh_repo"),
+        pytest.param({"github_repo": "floob"}, "docs/conf.py", r'"github_repo": "floob",', id="gh_repo"),
+        pytest.param({}, ".vscode/extensions.json", r'"ms-python.python",', id="no_ide_integ"),
+        pytest.param({"ide_integration": False}, ".vscode", None, id="ide_integ"),
     ],
 )
-def test_build(tmp_path: Path, params: Mapping[str, Any], path: Path | str, pattern: re.Pattern | str):
+def test_build(tmp_path: Path, params: Mapping[str, Any], path: Path | str, pattern: re.Pattern | str | None):
     cookiecutter(str(HERE.parent.parent), output_dir=tmp_path, no_input=True, extra_context=params)
     proj_dir = tmp_path / "project-name"
     assert proj_dir.is_dir()
     path = proj_dir / path
-    pattern = re.compile(pattern, re.MULTILINE)
-    assert pattern.search(path.read_text())
+    if pattern is None:
+        assert not path.exists()
+    else:
+        pattern = re.compile(pattern, re.MULTILINE)
+        assert pattern.search(path.read_text())
+
+    assert not list(proj_dir.rglob("DELETE-ME"))

{{cookiecutter.project_name}}/.gitignore

@@ -3,6 +3,13 @@
 *~
 buck-out/
 
+{% if not cookiecutter.ide_integration -%}
+# IDEs
+/.idea/
+/.vscode/
+
+{% endif -%}
+
 # Compiled files
 .venv/
 __pycache__/
@@ -18,7 +25,3 @@ __pycache__/
 # docs
 /docs/generated/
 /docs/_build/
-
-# IDEs
-/.idea/
-/.vscode/

{{cookiecutter.project_name}}/{% if cookiecutter.ide_integration %}.prettierrc.yaml{% endif %}

@@ -0,0 +1,7 @@
+overrides:
+  # JSON with comments and trailing commas
+  - files: .vscode/*.json
+    options:
+      parser: json5
+      quoteProps: preserve
+      singleQuote: false

{{cookiecutter.project_name}}/{{".vscode" if cookiecutter.ide_integration else "DELETE-ME" }}/extensions.json

@@ -0,0 +1,18 @@
+{
+    "recommendations": [
+        // GitHub integration
+        "github.vscode-github-actions",
+        "github.vscode-pull-request-github",
+        // Language support
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ms-toolsai.jupyter",
+        "tamasfe.even-better-toml",
+        // Dependency management
+        "ninoseki.vscode-mogami",
+        // Linting and formatting
+        "editorconfig.editorconfig",
+        "charliermarsh.ruff",
+        "esbenp.prettier-vscode",
+    ],
+}

{{cookiecutter.project_name}}/{{".vscode" if cookiecutter.ide_integration else "DELETE-ME" }}/launch.json

@@ -0,0 +1,33 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Build Documentation",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "sphinx",
+            "args": ["-M", "html", ".", "_build"],
+            "cwd": "${workspaceFolder}/docs",
+            "console": "internalConsole",
+            "justMyCode": false,
+        },
+        {
+            "name": "Python: Debug Test",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "purpose": ["debug-test"],
+            "console": "internalConsole",
+            "justMyCode": false,
+            "env": {
+                "PYTEST_ADDOPTS": "--color=yes",
+            },
+            "presentation": {
+                "hidden": true,
+            },
+        },
+    ],
+}

{{cookiecutter.project_name}}/{{".vscode" if cookiecutter.ide_integration else "DELETE-ME" }}/settings.json

@@ -0,0 +1,18 @@
+{
+    "[python][jsonc][yaml]": {
+        "editor.formatOnSave": true,
+    },
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.codeActionsOnSave": {
+            "source.fixAll": "always",
+            "source.organizeImports": "always",
+        },
+    },
+    "[jsonc][yaml]": {
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+    },
+    "python.analysis.typeCheckingMode": "basic",
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": ["-vv", "--color=yes"],
+}