.gitignore for PhoneGap/Cordova 3.0 projects – what should I commit?

I just tried to create a new phonegap 3.0 project… Note: I’m new to phonegap. Anyways, I see the project folder contains:

  • .cordova
  • merges
  • platforms
  • plugins
  • www

And having tried phonegap local run android I see a lot of binary/generated files in platforms/android. This leaves me wondering, what parts of this folder structure should I add to my git repository. Normally, I would consider it extremely poor practice to commit binary files. Hence, I would normally add patterns like bin/, obj/, *.o, *.pyc etc. to .gitignore to avoid polluting my git repository with things that only serves to create merge conflicts.

Surely, www should be added to git, but what about the other parts of the project. To what extend are they products of the source code, and to what extend are they project configuration?

What do you do? Granted I’m new so I barely understand what makes sense here…

Should I commit .gitignore file? [duplicate]

This question already has an answer here: Should you commit .gitignore into the Git repos? 4 answers This seems to be dumbiest question with most obvious answer. And it was for me until now. Bu

What .gitignore I should use with QT projects? (QT Creator)

So, after little thinking I have wrote the following: # In repository we don’t need to have: # Compiled object files *.o # Generated MOC, resource and UI files moc_*.cpp qrc_*.cpp ui_*.h # Debug and

where should I put .gitignore to affect all projects?

where should I place a .gitignore file so that all my projects use those settings? I tried various folders and I can only get it to work if I put it in my project folder, but then the settings (of co

What should I put in a meteor .gitignore file?

I have a new meteor project. I’m guessing the .meteor dir has a combination of configuration files (needed) and temporary files (not needed). So what’s in your .gitignore?

.gitignore for Lua projects

I’ve noticed that GitHub does not have a .gitignore template for Lua projects. Are there any specific files/file extensions which should be excluded by default from source control for a Lua project? I

Should you commit .gitignore into the Git repos?

Do you think it is a good practice to commit .gitignore into a Git repo? Some people don’t like it, but I think it is good as you can track the file’s history. Isn’t it?

What should Xcode 6 gitignore file include?

What should the typical .gitignore include for Xcode 6? Also for information regarding the xccheckout introduced in Xcode 5 see here

Why should I use gitignore?

Currently, whenever I create a file that I’d like Git to track I simply add it to the index. If I don’t add it to the index Git would not see it. So why should I use a gitignore file, as opposed to

gitignore settings included in commit

I’m trying to commit the right files in git, but having problems configuring my gitignore properly. I followed the instructions here to create the gitignore file (django project): # File types # #####

.gitignore file, where should I put it?

I want git to ignore my UserInterfaceState.xcuserstate file in my XCode4 project, but where should I put the .gitignore file?, is it inside the .git folder? or out? The .git is in same folder with the

Answers

The answer depends on wich platforms you’re developing the phongap app, and if you’re following the standard directory structure.

If your project directory structure is standard, then you can start from this gitignore and modify it for your needs.

On a rule of thumb you’ve to exclude all generated files like the bin/ and gen/ directories. If you’re developing an Android version of your app you should exclude build files too like *.apk.

All generated files in the android subdirectory should be excluded too:

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

So I just figured this out through trial and error. The platforms directory can be omitted if you are using phonegap local or remote build, as it is generated on the fly. All of the other folders, including the hidden folder .cordova are required.

Expanding on @Jake Moshenko answer:

I like the idea of omitting the platforms directory. In fact, I am am able to exclude both the plugins and platforms directories. A good starting point for the .gitignore:

platforms/
plugins/

The problem with this is that clean copy of the repo must be initialized before you can actually work with it. It may make sense to create an init script such as:

#!/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

A caveat to this approach is that it makes it a little more challenging to customize the platform specific app code/config outside of what’s supported by phonegap/cordova (i.e. screen orientation support).

Update: Bash Gist

This gist contains a more complete script for handling a project that does not commit the plugins and platforms directories. It provides a mechanism for copying the icons and splashscreen images from www to the platform directories (for iOS and Android), installing plugins, and handling platform specific files that should be added to version control.

Update: Grunt Gist

Here is another gist which is a Grunt port of the above mentioned bash script. (Thanks to @obie for suggesting grunt).

I just wanted to leave here my experience with this issue and the approach we finally followed.

In our phonegap project we started to commit all files less the folder /platform using .gitignore file. We thought this way, when the developer cloned the repository the only action remaining to do would be to execute:

phonegap/cordova add platform

But it wasn’t. Once the platform was added and we tried to compile, an error appeared and the app didn’t install in the device.

Looking the logs, we got some hits that this error was due to plugins. So we decided to reinstall all the plugins we was using in the project and voilá the app run correctly.

So my advice is to save in the repository all the content less the folders platform and plugins. Create and upload to repository a file README with a list of plugins used in the project.

This way, when a developer clone the repository, he/she will have to:

1.- Add the platforms: phonegap/cordova add platform “platform”

2.- Add the plugins: phonegap/cordova plugin add “plugin”

Hope this helps!

Regards.

A lot of this stuff is old and doesn’t really apply to the latest version of Apache Cordova. I’m using Apache Cordova 5.1.1 and this .gitignore allows me to still customize with custom icons etc while blocking all the stuff we don’t need to version for both Android and IOS. Yes .gradle is used so don’t remove it!

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

While it’s somewhat personal preference, I went with this (for an android only project). Removing most, but keeping what’s custom

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