Minimal files to check into source control

jeffwhelpley · March 15, 2015, 12:52pm

I would like to check in only the required files to git which I believe would be:

config.xml
ionic.project
package.json
bower.json
www/* (except for www/lib)

These files contain all the custom, unique information for a project, but I can’t seem to find the right ionic CLI command to automatically install all my cordova plugins and platforms off of this information. The plugins are listed in package.json so I have to imagine there is a way to do it, but I couldn’t find any information on this.

So, 2 questions:

Are these the right list of files to check in or are others needed?
How does another developer properly install their environment after pulling down these files (i.e. npm install, bower install, then ??)

mhartington · March 16, 2015, 12:55pm

Hey @jeffwhelpley

So the CLI should have some cordova hooks that take care of this.

https://github.com/driftyco/ionic-cli/tree/master/lib/hooks

So any plugins that are added to a project will be referenced in your package.json.

github.com

mhartington/Devnexus/blob/master/package.json#L17


  "gulp-sass": "^0.7.1",
  "gulp-concat": "^2.2.0",
  "gulp-minify-css": "^0.3.0",
  "gulp-rename": "^1.2.0"
},
"devDependencies": {
  "bower": "^1.3.3",
  "gulp-util": "^2.2.14",
  "shelljs": "^0.3.0"
},
"cordovaPlugins": [
  "https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin.git",
  "com.ionic.keyboard",
  "org.apache.cordova.console",
  "org.apache.cordova.device",
  "org.apache.cordova.camera",
  "https://github.com/apache/cordova-plugin-statusbar.git",
  "org.apache.cordova.splashscreen",
  "org.apache.cordova.dialogs"
]
}

Then after a fresh clone of the project, the hooks will go off a fetch each plugin.

jeffwhelpley · March 16, 2015, 2:01pm

So are you saying I should check in my hooks directory?

If no, then how does someone get the hooks?

If yes, then that makes sense but I would suggest making it so you don’t have to check hooks into source control in the future.

My ideal workflow, fyi, would be something like this:

either git clone blah or git pull origin master
ionic update // will load all hooks, plugins, platforms, etc. from ionic.project file. As an aside, unless there are technical reasons for putting the cordova plugins in package.json, it sort of makes more sense to me being in the ionic.project file.

Thanks for all the help!

mhartington · March 16, 2015, 2:52pm

You don’t have to check in the hooks directory, because the cli will automatically add that for you if the directory doesn’t exist.

So what the workflow is:

Work on project for a bit, add plugins as needed, check into git repo
new computer- clone project and add ios/android projects
hooks will automatically add the plugins before creating the ios/android project.

The ionic.project is really for our services part, so having the plugins there really doesn’t make sense.

jeffwhelpley · March 16, 2015, 4:09pm

OK, I tested this out and works great. Thanks for the info. Feel free to close.