phraseapp-gradle-plugin

This plugin helps you to sync your externalized/internationalized messages with your PharseApp account. So it will be a bridge between you as the developer and the translation agency/translater.

Usage

Configuration

1. Add the plugin artifact to your dependency list in build.gradle

    apply plugin: 'de.esailors.gradle.plugins.phraseapp'

    phraseAppSettings {
        projectId = "123456789-your-project-id"˘
        authToken = "987654321-your-auth-token"
    }

    buildscript {
        repositories {
            jcenter()
            mavenCentral()
            mavenLocal()
        }
        dependencies {
            classpath 'de.esailors.gradle.plugins:phraseapp-gradle-plugin:1.0.0-SNAPSHOT'
        }
    }

2. Execute some task

After you have configured your build.gradle file, simply run: gradle [taskname]

TaskName	Description
download	Downloads all messages properties from PhraseApp for your configured project.

3. Possible configurations

PropertyName	Default Value	Description
authToken	*	The AuthToken you have created in your PhraseApp account to pull/push keys.
projectId	*	The internal PhraseApp project id to identify the messages you will pull/push.
destinationDir	generated-resources	The name of the folder where the {messagesDir} should located.
destinationMessagesDir	messages	The name of the folder where the downloaded messages should be saved.
messageFilePrefix	messages_	The prefix name of the messages files.
fileFormat	properties	The file format you want to download the messages keys.[properties,xml]

* these properties are required!!!

Execute Tasks

After you have configured your build.gradle file, simply run: gradle [the-task-you-want-to-execute].

Dependencies

Java SDK

• Java 7 or higher

Runtime

• SLF4J for logging
• Lombok to remove some boilerplate code
• Phrase-Java-Client from mytaxi to encapsulate the PhraseApp API
• Spring-Web because the PharseApp-Java-Client needs this

For Unit tests

• JUntit for simple unit tests

Release this plugin

1. ensure you have the correct gradle.publish.key and gradle.publish.secret in your gradle config: $HOME_DIR/.gradle/gradle.properties (~/.gradle/gradle.properties)
2. ensure you have updated the version number of the plugin and added some changelog comments in the CHANGELOG.md file
3. release the plugin with make publish
4. commit and push the updated version

Links

• PhraseApp API Doku v2

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

Apache License, Version 2.0

TODOs

• update build cycle
  • release on master branch push
  • create tag on release
  • integrate auto-version-update plugin
    • increase version of plugin
• push functionality - push new keys or translation mistakes to phraseApp