Gérer les fichiers LookML et Git avec l'extension Looker pour VS Code

L'extension Looker pour VS Code utilise un modèle de développement local en premier. Ce modèle maintient une relation à trois entre votre système de fichiers local, le mode Développement de votre instance Looker et votre dépôt Git distant.

Ce guide explique comment l'extension synchronise les fichiers et comment les opérations Git locales ont un impact sur votre projet Looker.

Mécanisme de synchronisation

L'extension gère automatiquement la synchronisation du contenu des fichiers entre votre IDE local et le serveur Looker.

Ouverture de fichiers (lecture à l'ouverture)

Lorsque vous ouvrez un fichier .lkml dans votre IDE local, l'extension récupère automatiquement la version actuelle de ce fichier à partir de la branche extraite dans le mode Développement de votre instance Looker. Vous vous assurez ainsi de toujours travailler sur la version la plus récente du code.

Enregistrer des fichiers (écriture à l'enregistrement)

Lorsque vous enregistrez un fichier localement (Cmd+S sur Mac ou Ctrl+S sur Windows/Linux), l'extension envoie immédiatement vos modifications locales au serveur Looker. Ces modifications sont ensuite visibles dans l'IDE Looker basé sur le navigateur lorsque vous êtes en mode Développement.

Gérer les conflits de synchronisation

Si un fichier est modifié dans l'IDE Looker basé sur navigateur alors qu'il est également ouvert dans VS Code, un conflit peut se produire.

Par défaut, l'extension remplace la version sur le serveur Looker par votre version locale VS Code.

Toutefois, si vous avez activé le paramètre looker.askBeforeOverwritingRemote, VS Code affiche un avertissement lorsque vous tentez d'enregistrer un fichier qui a été modifié sur le serveur. Vous pouvez choisir d'effectuer l'une des actions suivantes :

  • Conserver la version locale : remplace la version sur le serveur Looker par votre version locale VS Code.
  • Extraire le fichier distant : écrasez votre fichier local avec la version du serveur Looker.

Le paramètre looker.askBeforeOverwritingRemote est désactivé par défaut.

Opérations Git locales

L'extension synchronise le contenu des fichiers, mais vous devez gérer votre dépôt Git à l'aide des commandes Git standards dans votre terminal local ou dans l'onglet "Contrôle des sources" de l'IDE local.

Gérer les branches

Lorsque vous changez de branche en local à l'aide de git checkout, l'extension détecte le changement et bascule automatiquement votre session sur le serveur Looker vers la branche correspondante.

État Git dans Looker

Lorsque vous enregistrez des modifications apportées à un fichier, elles sont synchronisées avec votre instance Looker et apparaissent comme non validées dans l'IDE Looker basé sur le navigateur. Si vous validez ces modifications à l'aide de Git dans votre environnement local, elles continueront d'apparaître comme non validées dans l'IDE Looker jusqu'à ce que vous les transfériez vers votre dépôt distant.

Lorsque vous utilisez git push, votre instance Looker extrait les modifications validées de votre dépôt distant. Une fois que votre instance Looker a extrait les données à distance, les modifications que vous avez validées et publiées n'apparaissent plus comme non validées dans l'IDE Looker. Seuls les fichiers enregistrés localement, mais qui n'ont pas encore été validés ni envoyés, s'affichent comme non validés.

Valider le code LookML

L'extension exécute automatiquement le validateur LookML de Looker chaque fois que vous enregistrez une modification. Toutes les erreurs de syntaxe et de modèle renvoyées par le validateur s'affichent dans vos fichiers au sein de votre IDE local. Si vous le souhaitez, vous pouvez également exécuter le validateur LookML manuellement sans enregistrer les fichiers à l'aide de la commande Looker: Validate LookML (Looker : Valider le LookML) de la palette de commandes.

Étapes suivantes