.gitignore per i progetti PhoneGap / Cordova 3.0 - cosa devo impegnare?

Ho appena provato a creare un nuovo progetto phonegap 3.0 ... Nota: sono nuovo in phonegap. Comunque, vedo che la cartella del progetto contiene:

• .cordova
• merges
• platforms
• plugins
• www

E dopo aver provato phonegap local run androidvedo molti file binari / generati in platforms/android. Questo mi lascia a chiedermi, quali parti di questa struttura di cartelle dovrei aggiungere al mio repository git. Normalmente, ritengo che sia una pratica estremamente scarsa eseguire il commit di file binari. Quindi, io normalmente aggiungere modelli come bin/, obj/, *.o, *.pycecc per .gitignoreevitare di inquinare il mio repository git con le cose che serve solo a creare conflitti di unione.

Sicuramente, wwwdovrebbe essere aggiunto a git, ma per quanto riguarda le altre parti del progetto. In che misura sono prodotti del codice sorgente e in che misura sono la configurazione del progetto?

cosa fai? Certo, sono nuovo, quindi capisco a malapena cosa abbia senso qui ...

La risposta dipende da quali piattaforme stai sviluppando l'app phongap e se stai seguendo la struttura di directory standard.

Se la struttura della directory del tuo progetto è standard, puoi iniziare da questo gitignore e modificarlo per le tue esigenze.

In linea di massima devi escludere tutti i file generati come le directory bin/e gen/. Se stai sviluppando una versione Android della tua app, dovresti escludere anche i file di build come *.apk.

Anche tutti i file generati nella androidsottodirectory dovrebbero essere esclusi:

Android/bin/
Android/gen/
Android/assets/

Espandendo la risposta di @Jake Moshenko:

Mi piace l'idea di omettere la platformsdirectory. In realtà, io sono sono in grado di escludere sia le pluginse platformsdirectory. Un buon punto di partenza per .gitignore:

platforms/
plugins/

Il problema con questo è che la copia pulita del repository deve essere inizializzata prima di poter effettivamente lavorare con esso. Può avere senso creare uno script di inizializzazione come:

#!/bin/bash
textReset=$(tput sgr0)
textGreen=$(tput setaf 2)
message_info () {
  echo "${textGreen}[my-app]${textReset} $1"
}

message_info "Creating necessary directories..."
mkdir plugins
mkdir platforms

message_info "Adding platforms..."
# If using cordova, change to: cordova platform add android
phonegap build android
phonegap build ios

message_info "Adding plugins..."
# If using cordova, change to: cordova plugin add
phonegap local plugin add https://git-wip-us.apache.org/repos/asf/cordova-plugin-device.git

Un avvertimento a questo approccio è che rende un po 'più difficile personalizzare il codice / la configurazione dell'applicazione specifica della piattaforma al di fuori di ciò che è supportato da phonegap / cordova (cioè supporto per l'orientamento dello schermo).

Aggiornamento: Bash Gist

Questa sintesi contiene uno script più completo per la gestione di un progetto che non esegue il commit delle directory pluginse platforms. Fornisce un meccanismo per copiare le icone e le immagini splashscreen da www alle directory della piattaforma (per iOS e Android), installare plugin e gestire file specifici della piattaforma che dovrebbero essere aggiunti al controllo della versione.

Aggiornamento: Grunt Gist

Ecco un altro succo che è un porting Grunt dello script bash sopra menzionato. (Grazie a @obie per aver suggerito grugnito).

Quindi l'ho capito solo attraverso tentativi ed errori. La platformsdirectory può essere omessa se stai usando phonegap locale o build remota, poiché viene generata al volo. Tutte le altre cartelle, inclusa la cartella nascosta, .cordovasono obbligatorie.

Volevo solo lasciare qui la mia esperienza con questo problema e l'approccio che abbiamo finalmente seguito.

Nel nostro progetto phonegap abbiamo iniziato a eseguire il commit di tutti i file meno la cartella / piattaforma utilizzando il file .gitignore. Abbiamo pensato in questo modo, quando lo sviluppatore ha clonato il repository l'unica azione rimasta da fare sarebbe stata eseguire:

phonegap / cordova aggiungi piattaforma

Ma non lo era. Una volta aggiunta la piattaforma e provato a compilare, è apparso un errore e l'app non è stata installata nel dispositivo.

Guardando i log, abbiamo riscontrato che questo errore era dovuto ai plugin. Quindi abbiamo deciso di reinstallare tutti i plugin che stavamo utilizzando nel progetto e voilà l'app è stata eseguita correttamente.

Quindi il mio consiglio è di salvare nel repository tutto il contenuto meno la piattaforma di cartelle e plugin. Crea e carica nel repository un file README con un elenco di plugin utilizzati nel progetto.

In questo modo, quando uno sviluppatore clona il repository, dovrà:

1.- Aggiungi le piattaforme: phonegap / cordova aggiungi la piattaforma "piattaforma"

2.- Aggiungi i plugin: phonegap / cordova plugin aggiungi "plugin"

Spero che questo ti aiuti!

Saluti.

Molte di queste cose sono vecchie e non si applicano all'ultima versione di Apache Cordova. Sto usando Apache Cordova 5.1.1 e questo .gitignore mi consente di personalizzare ancora con icone personalizzate ecc. Mentre blocco tutto ciò che non serve per la versione sia per Android che per IOS. Sì .gradle viene utilizzato quindi non rimuoverlo!

www/
.gradle/
build/
.tmp/
.temp/
coverage/
*.log
node_modules/
bower_components/

Sebbene sia una preferenza in qualche modo personale, sono andato con questo (per un progetto solo per Android). Rimuovendo la maggior parte, ma mantenendo ciò che è personalizzato

ToonPlane/platforms/android/*
!ToonPlane/platforms/android/AndroidManifest.xml
ToonPlane/plugins/*
!ToonPlane/plugins/android.json
!ToonPlane/plugins/fetch.json