ENH: remove GitPod badge if --no-gitpod (#369)

* DX: remove gitpod config
* ENH: install git graph by default

.pre-commit-config.yaml

@@ -52,6 +52,7 @@ repos:
         args:
           - --allow-labels
           - --dependabot=update
+          - --no-gitpod
           - --no-notebooks
           - --no-prettierrc
           - --no-pypi

.vscode/extensions.json

@@ -8,6 +8,7 @@
     "executablebookproject.myst-highlight",
     "github.vscode-github-actions",
     "github.vscode-pull-request-github",
+    "mhutchie.git-graph",
     "ms-python.mypy-type-checker",
     "ms-python.python",
     "ms-python.vscode-pylance",

README.md

@@ -2,7 +2,6 @@
 
 [![BSD 3-Clause license](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 [![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
-[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/policy)
 [![pytest](https://github.com/ComPWA/qrules/workflows/pytest/badge.svg)](https://github.com/ComPWA/qrules/actions?query=branch%3Amain+workflow%3Apytest)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/policy/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/policy/main)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

src/compwa_policy/.template/.gitpod.yml

@@ -0,0 +1,17 @@
+tasks:
+  - init: pyenv local 3.9
+  - init: pip install -e .[dev]
+
+github:
+  prebuilds:
+    master: true
+    branches: false
+    pullRequests: true
+    pullRequestsFromForks: true
+    addComment: false
+    addBadge: false
+    addLabel: false
+
+vscode:
+  extensions:
+    - charliermarsh.ruff

src/compwa_policy/check_dev_files/gitpod.py

@@ -12,7 +12,7 @@
     PythonVersion,
     get_constraints_file,
 )
-from compwa_policy.utilities.readme import add_badge
+from compwa_policy.utilities.readme import add_badge, remove_badge
 from compwa_policy.utilities.yaml import write_yaml
 
 
@@ -22,6 +22,7 @@ def main(no_gitpod: bool, python_version: PythonVersion) -> None:
             os.remove(CONFIG_PATH.gitpod)
             msg = f"Removed {CONFIG_PATH.gitpod} as requested by --no-gitpod"
             raise PrecommitError(msg)
+        remove_badge(r"\[!\[GitPod\]\(https://img.shields.io/badge/gitpod")
         return
     error_message = ""
     expected_config = _generate_gitpod_config(python_version)

src/compwa_policy/check_dev_files/vscode.py

@@ -21,8 +21,7 @@ def _update_extensions() -> None:
         )
         do(
             vscode.remove_extension_recommendation,
-            "travisillig.vscode-json-stable-stringify",
-            # cspell:ignore travisillig
+            "travisillig.vscode-json-stable-stringify",  # cspell:ignore travisillig
             unwanted=True,
         )
         do(
@@ -32,14 +31,16 @@ def _update_extensions() -> None:
         )
         do(
             vscode.remove_extension_recommendation,
-            "garaioag.garaio-vscode-unwanted-recommendations",
-            # cspell:ignore garaio garaioag
+            "garaioag.garaio-vscode-unwanted-recommendations",  # cspell:ignore garaio garaioag
             unwanted=True,
         )
         do(
             vscode.add_extension_recommendation,
-            "Soulcode.vscode-unwanted-extensions",
-            # cspell:ignore Soulcode
+            "Soulcode.vscode-unwanted-extensions",  # cspell:ignore Soulcode
+        )
+        do(
+            vscode.add_extension_recommendation,
+            "mhutchie.git-graph",  # cspell:ignore mhutchie
         )