create cordova hooks

[MathiasTim]

To solve some problems like manipulation the plist, we need to use cordova hooks.

We should write a colletion of most used cordova hooks and maybe integrate them then into generator-m.

[stefanjauker]

why would you manipulate the plist file?

[MathiasTim]

For example to add the supported languages on iOS to the app. In this way labels on buttons from native plugins will be translated.
i.e.: the camera plugin will always display 'use photo' although your are on a device that has german as language. That can be solved if you add the 'supported languages' to the app. Then iOS will translate system labels in the correct language.

[MathiasTim]

I talked to Frank today, he used this hook, for my described usecase above:

https://github.com/diegonetto/generator-ionic/blob/master/templates/hooks/after_prepare/update_platform_config.js

I like it, and I think we should think about a way to scaffold this with the generator-m (at least ask the user)

[FrankStierle]

This Hook can also add all kind of entries to the AndroidManifest.xml if specified in the config.xml.

Very useful

[gruppjo]

Maybe we can provide an m:hook subgenerator.

related #184, #183

[gruppjo]

#188 (add badges on app icons)

[gruppjo]

Cordova hooks docs - http://cordova.apache.org/docs/en/edge/guide_appdev_hooks_index.md.html#Hooks%20Guide

[gruppjo]

Agreements as of today:

update platform config

• include the following hook: https://github.com/diegonetto/generator-ionic/blob/master/templates/hooks/after_prepare/update_platform_config.js
  • include the following packages as devDependencies in the package.json https://github.com/diegonetto/generator-ionic/blob/master/templates/hooks/after_prepare/update_platform_config.js#L80-L82
  • include for android and ios with the config.xml syntax - http://cordova.apache.org/docs/en/edge/guide_appdev_hooks_index.md.html#Hooks%

Nice to have in the future: provide hooks as node module.

splash & icons (Gulp, no hook!)

based on: https://generator-m.slack.com/files/mathias/F0873DD8W/setup_splash_and_icons.js
folder structure

res/
  |- android
    | default files
    | current - files are copied here by task
    | config1
    | config2
    | ....

the task then copies all files to the current/ directory. The links to the splashscreens and icons in the config.xml should point to this directory.

The task is started when cordova run, emulate, build, prepare are called.
Different assets can be chosen like this: gulp --cordova 'run ios' --res=badge1.

It's the developer's responsibility to correctly link to the resource files in the config.xml.

[gruppjo]

Adding

  <platform name="android">
    <hook type="after_prepare" src="hooks/update_platform_config.js"/>
  </platform>
  <platform name="ios">
    <hook type="after_prepare" src="hooks/update_platform_config.js"/>
  </platform>

to the config.xml results in the following error when running gulp --cordova 'run ios'

ERROR running one or more of the platforms: TypeError: invalid data
You may not have the required environment or OS to run this project

I'm reverting to adding the hook using the directory after_prepare:

For future reference, this is the code for the gulp config task:

if (options.addHook && options.type && options.src) {
  result.widget.platform = result.widget.platform || [];
  result.widget.platform.push({
    $: { name: 'android' },
    hook: {
      $: {
        type: options.type,
        src: options.src
      }
    }
  });
  result.widget.platform.push({
    $: { name: 'ios' },
    hook: {
      $: {
        type: options.type,
        src: options.src
      }
    }
  });
}

and the gulp tasks could have been called in the app/index.js like this: https://github.com/mwaylabs/generator-m/blob/0.2.7/app/index.js#L371-L383

[gruppjo]

closed with 9a36328

[MathiasTim]

I thought we will not support the deprecated method with using the hooks folder for cordova hooks?

Although the demo has it. Is there any reason why?

[gruppjo]

Yes! See the comment above. #171 (comment)
Feel free to try this and let me know if you get the same error, when using the config.xml method.