Creare un modello personalizzato

Firebase Studio offre una vasta gamma di modelli integrati che includono tutti i file, i pacchetti di sistema (ad esempio, i compilatori) e le estensioni di cui hai bisogno per iniziare rapidamente a utilizzare un linguaggio o un framework.

Puoi anche avviare uno spazio di lavoro Firebase Studio utilizzando i modelli della community in hosting su GitHub. Per ulteriori informazioni su come avviare un nuovo workspace da un modello, consulta Creare uno spazio di lavoroFirebase Studio.

La maggior parte degli utenti utilizzerà i modelli integrati o importerà i progetti da Git, ma per casi d'uso più avanzati puoi creare i tuoi modelli:

• Se stai creando il tuo framework, la tua libreria o il tuo servizio, puoi lasciare che i tuoi utenti inizino rapidamente a utilizzare la tua tecnologia senza mai uscire dal browser, con tutta la potenza di una macchina virtuale basata su cloud.

• Se hai uno stack tecnologico preferito per i tuoi progetti, puoi semplificare la procedura per avviare nuovi progetti con un modello personalizzato.

• Se insegnate ad altri, ad esempio tramite un tutorial o un codelab, puoi rimuovere alcuni dei passaggi iniziali per gli studenti preconfigurando il punto di partenza del tuo codelab come un tempietto personalizzato.

Dopo aver creato e testato il modello personalizzato, puoi creare un link per posizionarlo sul tuo sito web, nel file README del repository Git, nella pagina dei dettagli del pacchetto (ad esempio in NPM) o in qualsiasi altro luogo in cui prevedi che gli utenti inizino a utilizzare la tua tecnologia.

Prerequisiti

Prima di iniziare:

• Scopri come utilizzare il file idx/dev.nix per personalizzare il tuo ambiente.

• Acquisisci familiarità con le nozioni di base del linguaggio Nix e tieni a portata di mano il riferimento.

Struttura del file modello

Un modello Firebase Studio è un repository Git pubblico (o una cartella o un ramo in un repository) che contiene almeno due file:

• idx-template.json include i metadati del modello, tra cui il nome visibile all'utente, la descrizione e i parametri disponibili per la configurazione del modello. Ad esempio, puoi consentire ai tuoi utenti di scegliere tra una serie di linguaggi di programmazione o casi di utilizzo esempi. Firebase Studio utilizza queste informazioni per preparare l'interfaccia utente mostrata agli utenti quando scelgono di creare un nuovo spazio di lavoro dal tuo modello.

• idx-template.nix è un file scritto con il linguaggio Nix che contiene uno script della shell Bash (racchiuso in una funzione Nix) che:

  1. Crea la directory di lavoro per il nuovo spazio di lavoro.

  2. Configura il proprio ambiente creando un file .idx/dev.nix. Tieni presente che in questo script puoi anche eseguire uno strumento di scaffolding del progetto come flutter create o npm init oppure uno script personalizzato scritto in Go, Python, Node.js o un altro linguaggio.

     Questo file verrà eseguito con i parametri specificati dall'utente quando Firebase Studio carica il modello.

Oltre a questi due file, è possibile includere altri file da utilizzare in idx-template.nix per creare un'istanza del modello. Ad esempio, puoi includere il file .idx/dev.nix finale o anche tutti i file di struttura direttamente nel repository.

Creare un modello di partenza

Per velocizzare la creazione del modello, ti consigliamo di iniziare con uno dei seguenti metodi per creare un modello Firebase Studio che puoi personalizzare ulteriormente:

• Trasformare qualsiasi repository GitHub pubblico in un modello
• Utilizzare un modello ufficiale o della community come base per il tuo modello

Un esempio di base: trasformare qualsiasi repository GitHub pubblico in un modello

Prima di entrare nei dettagli su come definire idx-template.json e idx-template.nix, è utile vedere un modello di esempio di base che:

• Non contiene parametri configurabili dall'utente.
• Copia tutti i file nel repository dei modelli (tranne i due fileidx-template) nello spazio di lavoro dell'utente. Dovrebbe già essere presente una sottocartella .idx con un file dev.nix che definisce l'ambiente.

Se aggiungi i seguenti file a qualsiasi repository GitHub pubblico (o sottodirectory o ramo), il repository diventa effettivamente un modello Firebase Studio.

idx-template.json

{
  "name": "Hello world",
  "description": "A template for a CLI program that prints 'hello world'",
  "icon": "https://www.gstatic.com/images/branding/productlogos/studio/v1/192px.svg",
  "params": []
}

idx-template.nix

# No user-configurable parameters
{ pkgs, ... }: {
  # Shell script that produces the final environment
  bootstrap = ''
    # Copy the folder containing the `idx-template` files to the final
    # project folder for the new workspace. ${./.} inserts the directory
    # of the checked-out Git folder containing this template.
    cp -rf ${./.} "$out"

    # Set some permissions
    chmod -R +w "$out"

    # Remove the template files themselves and any connection to the template's
    # Git repository
    rm -rf "$out/.git" "$out/idx-template".{nix,json}
  '';
}

Vai a Personalizzare il modello per scoprire altre modifiche che puoi apportare per personalizzare il modello.

Creare un modello personalizzato utilizzando un modello ufficiale o della community

Il team di Firebase Studio gestisce due repository per i modelli Firebase Studio:

• Modelli ufficiali: si tratta dei modelli che selezioni direttamente dalla dashboard Firebase Studio quando crei una nuova app.

• Modelli della community: Questi modelli consentono i contributi della community open source. Per utilizzare un modello della community, clona il repository Git dei modelli della community. Puoi utilizzare il link completo al modello che vuoi utilizzare.

Per creare un modello personalizzato basato su un modello esistente:

1. Decidi quale modello utilizzare come base per il tuo modello personalizzato, quindi clona il progetto.

2. Personalizza idx-template.json, idx-template.nix e .idx/dev.nix come necessario, iniziando con Personalizza il tuo modello.

3. Controlla le modifiche nel repository.

4. Segui le istruzioni riportate in Creare un nuovo spazio di lavoro per il modello per pubblicare e testare il modello. Se utilizzi un repository nidificato, collegalo direttamente all'URL. Ad esempio, se utilizzavi il modello della community "Vanilla Vite", esegui il provisioning e il test di una nuova area di lavoro utilizzando il seguente URL:

   https://studio.firebase.google.com/new?template=https://github.com/project-idx/community-templates/tree/main/vite-vanilla
   

Vai a Personalizzare il modello per scoprire altre modifiche che puoi apportare per personalizzare il modello.

Personalizzare il modello

Ora che hai creato un modello di base su cui lavorare, puoi modificare i file idx-template.json, idx-template.nix e .idx/dev.nix in base alle tue esigenze. Ti consigliamo di personalizzare altre configurazioni:

• Aggiungi i pacchetti di sistema allo script bootstrap.
• Aggiungere parametri configurabili dall'utente
• Scegliere i file da aprire per impostazione predefinita
• Scegliere un'icona per l'area di lavoro predefinita

Utilizzare pacchetti di sistema aggiuntivi nello script bootstrap

L'esempio di base utilizza solo comandi POSIX di base per copiare i file nella posizione corretta. Lo script bootstrap del tuo modello potrebbe richiedere l'installazione di altri file binari, ad esempio git, node, python3 o altri.

Puoi rendere disponibili pacchetti di sistema aggiuntivi per lo script di bootstrap specificando packages nel file idx-template.nix, proprio come faresti per personalizzare uno spazio di lavoro con pacchetti di sistema aggiuntivi aggiungendoli al packages nel file dev.nix.

Ecco un esempio di aggiunta di pkgs.nodejs, che include file binari come node, npx e npm:

# idx-template.nix
{pkgs}: {
  packages = [
    # Enable "node", "npm" and "npx" in the bootstrap script below.
    # Note, this is NOT the list of packages available to the workspace once
    # it's created. Those go in .idx/dev.nix
    pkgs.nodejs
  ];

  bootstrap = ''
    mkdir "$out"
    # We can now use "npm"
    npm init --yes my-boot-strap@latest "$out"
  ''
}

Aggiungi parametri configurabili dall'utente

Per consentire agli utenti di personalizzare il punto di partenza del nuovo progetto, puoi creare più modelli o un singolo modello con parametri. Questa è un'ottima opzione se i diversi punti di partenza sono solo valori diversi passati a uno strumento CLI (ad esempio --language=js rispetto a --language=ts).

Per aggiungere i parametri:

1. Descrivi il parametro nell'oggetto params del idx-template.json file di metadati. Firebase Studio utilizza le informazioni contenute in questo file per preparare l'interfaccia utente (ad esempio caselle di controllo, menu a discesa e campi di testo) mostrata agli utenti del modello.
2. Aggiorna il bootstrap idx-template.nix in modo da utilizzare i valori selezionati dall'utente durante l'inizializzazione del modello.

Descrivi il parametro in idx-template.json

Ecco un esempio di aggiunta di un parametro enum, che viene visualizzato come menu a discesa o gruppo di pulsanti di opzione, a seconda del numero di opzioni:Firebase Studio

{
  "name": "Hello world",
  "description": "A hello world app",
  "params": [
    {
      "id": "language",
      "name": "Programming Language",
      "type": "enum",
      "default": "ts",
      "options": {
        "js": "JavaScript",
        "ts": "TypeScript"
      },
      "required": true
    }
  ]
}

Poiché sono presenti due valori (JavaScript e TypeScript), l'interfaccia utente mostrerà un gruppo di pulsanti di opzione per le due opzioni e passerà il valore ts o js allo script idx-template.nix.

Ogni oggetto parametro ha le seguenti proprietà:

Utilizzare i valori dei parametri in idx-template.nix

Dopo aver definito l'oggetto params nel file idx-template.json, puoi iniziare a personalizzare lo script di bootstrap in base ai valori dei parametri scelti dall'utente.

Seguendo l'esempio nella sezione precedente, se hai un singolo parametro con ID language che è un enum con possibili valori ts o js, puoi utilizzarlo nel seguente modo:

# idx-template.nix
# Accept additional arguments to this template corresponding to template
# parameter IDs, including default values (language=ts by default in this example).
{ pkgs, language ? "ts", ... }: {
  packages = [
    pkgs.nodejs
  ];

  bootstrap = ''
    # We use Nix string interpolation to pass the user's chosen programming
    # language to our script.
    npm init --yes my-boot-strap@latest "$out" -- --lang=${language}
  ''
}

Un altro pattern comune è includere i contenuti in modo condizionale a seconda del valore di una stringa. Un altro modo per scrivere l'esempio precedente è:

npm init --yes my-boot-strap@latest "$out" -- \
    ${if language == "ts" then "--lang=ts" else "--lang=js" }

Scegliere i file da aprire per impostazione predefinita

Ti consigliamo di personalizzare i file che devono essere aperti per la modifica quando vengono creati nuovi spazi di lavoro con il tuo modello. Ad esempio, se il tuo modello è per un sito web di base, ti consigliamo di aprire i file HTML, JavaScript e CSS principali.

Per personalizzare i file da aprire per impostazione predefinita, aggiorna il file .idx/dev.nix (non il file idx-template.nix) in modo da includere un hook dello spazio di lavoro onCreate con un attributo openFiles, come segue:

# .idx/dev.nix
{pkgs}: {
  ...
  idx = {
    # Workspace lifecycle hooks
    workspace = {
      # Runs when a workspace is first created with this `dev.nix` file
      onCreate = {
        # Open editors for the following files by default, if they exist.
        # The last file in the list will be focused.
        default.openFiles = [
          "src/index.css"
          "src/index.js"
          "src/index.html"
        ];
        # Include other scripts here, as needed, for example:
        # installDependencies = "npm install";
      };
      # To run something each time the workspace is (re)started, use the `onStart` hook
    };
    # Enable previews and customize configuration
    previews = { ... };
  };
}

Scegli un'icona per l'area di lavoro predefinita

Puoi scegliere l'icona predefinita per gli spazi di lavoro creati con il tuo modello inserendo un file PNG denominato icon.png accanto al file dev.nix all'interno della directory .idx.

Testa il tuo modello in una nuova area di lavoro

Il modo più semplice per testare il modello end-to-end è creare una nuova area di lavoro con il modello. Visita il seguente link, sostituendo l'esempio con l'URL del repository GitHub del tuo modello:

https://idx.google.com/new?template=https://github.com/my-org/my-repo

Se vuoi, puoi includere un ramo e una sottocartella. Sono validi tutti i seguenti elementi, a condizione che siano accessibili pubblicamente:

• https://github.com/my-org/my-repo/
• https://github.com/my-org/my-repo/tree/main/path/to/myidxtemplate
• https://github.com/my-org/my-repo/tree/branch
• https://github.com/my-org/my-repo/tree/branch/path/to/myidxtemplate

Si tratta anche dell'URL che condividerai con altri utenti in modo che possano utilizzare il nuovo modello o dell'URL a cui collegherai il pulsante"Apri in Firebase Studio".

Condividere il modello

Dopo aver verificato che il modello si comporti come previsto, pubblicalo in un repository GitHub e condividi lo stesso link che hai utilizzato per creare uno spazio di lavoro per i test.

Per consentire agli utenti di trovare ancora più facilmente il tuo modello, aggiungi un pulsante"Apri inFirebase Studio" al README del tuo sito web o del tuo repository.