Les fondamentaux

Présentation

Les modules d’extension de StudioCMS sont un outil puissant qui vous permet d’étendre les fonctionnalités de StudioCMS. Ils offrent un moyen simple et flexible d’ajouter de nouvelles fonctionnalités à votre projet StudioCMS. Voici une description des modules d’extension de StudioCMS et de leur fonctionnement.

Que sont les modules d’extension ?

Les modules d’extension de StudioCMS sont similaires aux intégrations Astro, mais ils intègrent des informations supplémentaires à l’objet fonction. Ces informations sont utilisées par StudioCMS pour déterminer comment le module d’extension doit être chargé et utilisé. Les modules d’extension de StudioCMS permettent d’étendre les fonctionnalités de StudioCMS en ajoutant de nouvelles fonctionnalités ou en modifiant celles existantes.

Le type des modules d’extension de StudioCMS Révisé dans la v0.4.0

interface StudioCMSPlugin {
  identifier: string;
  name: string;
  hooks: {
    'studiocms:astro:config': (params: {
      logger: AstroIntegrationLogger;
      addIntegrations: (args_0: AstroIntegration | AstroIntegration[]) => void;
    }) => void | Promise<void>;
    'studiocms:auth': (params: {
      logger: AstroIntegrationLogger;
      setAuthService: (args_0: { ...; }) => void;
    }) => void | Promise<void>;
    'studiocms:dashboard': (params: {
      logger: AstroIntegrationLogger;
      setDashboard: (args_0: { ...; }) => void;
      augmentDashboard: (args_0: { ...; }) => void;
    }) => void | Promise<void>;
    'studiocms:frontend': (params: {
      logger: AstroIntegrationLogger;
      setFrontend: (args_0: { ...; }) => void;
    }) => void | Promise<void>;
    'studiocms:rendering': (params: {
      logger: AstroIntegrationLogger;
      setRendering: (args_0: { ...; }) => void;
    }) => void | Promise<void>;
    'studiocms:image-service': (params: {
      logger: AstroIntegrationLogger;
      setImageService: (args_0: { ...; }) => void;
    }) => void | Promise<void>;
    'studiocms:sitemap': (params: {
      logger: AstroIntegrationLogger;
      setSitemap: (args_0: { ...; }) => void;
    }) => void | Promise<void>;
  }
}

Définir un module d’extension

Pour définir un module d’extension pour StudioCMS, vous devez créer un objet conforme au type StudioCMSPlugin. Cet objet doit ressembler à l’exemple suivant, sachant que les propriétés suivantes sont requises :

• identifier : L’identifiant du module d’extension à partir du fichier package.json.
• name : Le libellé du module d’extension à afficher dans le tableau de bord de StudioCMS.
• studiocmsMinimumVersion : La version minimale de StudioCMS requise pour que le module d’extension fonctionne.

Voici un exemple de définition de module d’extension pour StudioCMS qui inclut toutes les propriétés requises et fournit une intégration Astro pour effectuer une logique personnalisée :

mon-module-extension.ts

import { definePlugin } from 'studiocms/plugins';
import { AstroIntegration } from 'astro';

// Définir les options du module d’extension et de l’intégration
interface Options {
    foo: string;
}

// Définir l’intégration Astro
const monIntegration = (options: Options): AstroIntegration => ({
    name: 'mon-integration-astro',
    hooks: {
        "astro:config:setup": () => {
            console.log('Bonjour depuis mon intégration Astro !');
        }
    }
});

// Définir le module d’extension pour StudioCMS
export const monModuleExtension = (options: Options) => definePlugin({
    identifier: 'mon-module-extension',
    name: "Mon module d’extension",
    hooks: {
      'studiocms:astro-config': ({ addIntegrations }) => {
        addIntegrations(monIntegration(options)) // Facultatif, mais recommandé
      }
    }
});

Dans cet exemple, nous définissons un module d’extension pour StudioCMS appelé Mon module d’extension qui nécessite la version v0.1.0 ou supérieure de StudioCMS. Le module d’extension fournit également une intégration Astro qui enregistre un message dans la console lorsque le crochet astro:config:setup est appelé.

Pour plus d’informations sur la création de modules d’extension, consultez le guide Rendre les modules d’extension utiles