So installieren Sie IDE-Erweiterungen automatisch in AWS CodeCatalyst-Entwicklungsumgebungen

Wussten Sie, dass Sie Ihre AWS CodeCatalyst Entwicklungsumgebung mit IDE-Erweiterungen anpassen können? In diesem Beitrag beschreibe ich, wie Sie IDE-Erweiterungen automatisch in Entwicklungscontainern installieren können, die den Konfigurationsstandard devfile verwenden.

Was ist CodeCatalyst?

AWS CodeCatalyst ist eine CI/CD-Plattform, die die verschiedenen Mitglieder der AWS Code-Familie (wie CodeCommit, CodeDeploy und CodeBuild) in einem einzigen Service bündelt. Ein wichtiges Merkmal von CodeCatalyst ist die Möglichkeit, Remote-Entwicklungsumgebungen einzurichten. Wenn Sie mehr über die Entwicklungsumgebungen und ihre Vorteile erfahren möchten, gebe ich hier in einem anderen Artikel eine kurze Einführung.

In CodeCatalyst sind Entwicklungsumgebungen (oder 'dev environments') Container, die mithilfe des devfile-Dateiformats konfiguriert werden können. Die AWS-Dokumentation gibt einen kurzen Überblick darüber, wie man sie startet. Das Tolle an Entwicklungscontainern ist, dass Sie sie mit Dienstprogrammen und Produktivitätstools wie der AWS CLI oder Github Copilot erweitern können. Seltsamerweise wird in der offiziellen Dokumentation nicht wirklich erklärt, wie man das macht! Sehen wir uns weiter unten an, wie Sie das erreichen können.

Anpassen Ihrer Entwicklungsumgebung

IDE-Plugins werden nicht in der Datei devfile.yaml selbst definiert (im Gegensatz zu z.B. dem devcontainer-Standard). Stattdessen erwartet es, dass der entfernte IDE-Server dies übernimmt.

Das bedeutet, dass die Anpassung für jede IDE anders umgesetzt wird! In diesem Beitrag werde ich Ihnen erklären, wie Sie Ihre VSCode-Umgebung anpassen können. Wenn Sie eine andere IDE wie z.B. JetBrains verwenden, hoffe ich, dass Ihnen dieser Beitrag dennoch als Inspiration für Ihre eigene Lösung dienen kann.

Fangen wir an!

Für VSCode können wir die empfohlenen Erweiterungen in einer .vscode/extensions.json Datei wie folgt angeben:

{
    "recommendations": [
        "AmazonWebServices.aws-toolkit-vscode",
        "GitHub.copilot",
        "dbaeumer.vscode-eslint"
    ]
}

Nachdem Sie Ihre Änderungen gespeichert und Ihren Arbeitsbereich neu gestartet haben, erhalten Sie nun eine Abfrage, ob Sie die empfohlenen Plugins installieren möchten.

Wenn Sie Ihre Plugins nicht jedes Mal manuell installieren möchten, wenn Sie eine neue Entwicklungsumgebung erstellen, können wir diesen Schritt auch mit VSCode-Aufgaben automatisieren. Wir können Aufgaben in der Konfigurationsdatei definieren. Mit Tasks können Sie verschiedene Prozesse in VSCode automatisieren, einschließlich der Installation von IDE-Erweiterungen!

Nehmen Sie die folgende Konfiguration in Ihre .vscode/tasks.json Datei auf:

{
    "version": "2.0.0",
    "tasks": [
            {
                "label": "Automatically install VSCode addons in AWS CodeCatalyst",
                "type": "shell",
                "command": "cat ./.vscode/extensions.json | jq -r .recommendations[] | xargs -L 1 code --install-extension",
                "runOptions": {
                    "runOn": "folderOpen"
                },
                "presentation": {
                    "reveal": "silent"
                }
            }
        ]
}

Die in dieser Aufgabe angegebene command liest alle empfohlenen Addons aus der Datei .vscode/extensions.json und gibt diese als Argumente an die VSCode CLI weiter. Die CLI installiert dann alle Addons für uns. Wir müssen natürlich nicht unbedingt die Datei .vscode/extensions.json verwenden - es kann jede beliebige Datei sein, aus der wir die Eingabe lesen können.

Nachdem Sie Ihre Änderungen gespeichert haben, starten Sie die Entwicklungsumgebung neu und alle Ihre Erweiterungen werden installiert! Dies kann die Installation verschiedener Tools erheblich beschleunigen, die möglicherweise nicht in Ihrem Standard-Entwicklungscontainer-Image enthalten sind.

Zusammenfassung

In diesem Beitrag habe ich gezeigt, wie Sie IDE-Erweiterungen in Ihrer CodeCatalyst-Entwicklungsumgebung installieren. Bei VSCode können Sie Erweiterungen manuell installieren, indem Sie sie in der .vscode/extensions.json file angeben, oder Sie können alles dem IDE-Server überlassen, indem Sie eine Aufgabe zur Installation der Erweiterung in der Datei .vscode/tasks.json erstellen.