HMS Toolkit Convertor

English | 中文

Table of Contents

• Introduction
• Build
• Install
• Develop
• Code Contributions
• License

introduction

Convertor is a code conversion tool supporting Java and Kotlin projects. It helps developers to automatically convert GMS APIs called by apps into corresponding HMS APIs, implementing quick conversion and HMS integration. The HMS Convertor provides the following functions:

• New Conversion: Automatically converts GMS APIs invoked by an app to HMS APIs.

• Open Last Conversion: Opens the last conversion result.

• Save All: Save the corrent project and conversion information.

• Restore Project: Restores a project with the backup file.

Build

Dependencies

Convertor requires:

• Gradle(>= 5.2.1)
• JDK(>= 8)

Run the git clone command to download the code, go to the Convertor/src directory, and run the following command:

$ ./gradlew -p IDE/intellij-plugin buildPlugin

After the build is complete, go to the Convertor/src/IDE/intellij-plugin/build/distributions directory to view the plugin package in .zip format.

Install

Start the IDEA or Android Studio and click the menu bar on the upper left, choose File -> Settings -> Plugins -> Install Plugin from Disk

select the ZIP plugin package generated during the build.

tips:

You can debug the plugin in the sandbox using the following command:

$ ./gradlew -p IDE/intellij-plugin runIde

For more details, please refer to Usage Guide

Run and Debug on IDE

1. Clone the repo

git clone https://github.com/HMS-Core/hms-toolkit-convertor.git

2. If you are using IntelliJ, from the Menu bar, go to File>Open.. and open the src folder inside the project.
3. Open the build.gradle file, find alternativeIdePath property, uncomment it, and set the install path of the intellij IDE that the plugin will be launched on (in this case android studio)

 intellij {

        // [...] 
        
         /**
         * Uncomment this for Debugging the plugin on Android Studio directly from the IDE (launches in a separate window/instance)
         * From the menu bar: Run>Run (launches instances with plugin installed) or Run>Debug (debug mode)
         *
         * In this case, we are setting the android studio install path, another IDE/path can be used as well.
        .*/
        // alternativeIdePath '/C://Program Files/Android/Android Studio'
        
        
        // [...] 
 }

4. From the gradle side toolwindow, click the "Reload all Gradle Projects" icon.
5. Now, you can run by choosing Run>Run (launches instance with plugin installed) or Run>Debug (debug mode)

Code Contributions

To make a contribution to Convertor project, follow these steps.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Question or issues

If you want to evaluate more about HMS Core, r/HMSCore on Reddit is for you to keep up with latest news about HMS Core, and to exchange insights with other developers.

If you have questions about how to use HMS samples, try the following options:

• Stack Overflow is the best place for any programming questions. Be sure to tag your question with huawei-mobile-services.
• Huawei Developer Forum HMS Core Module is great for general questions, or seeking recommendations and opinions.

If you run into a bug in our samples, please submit an issue to the Repository. Even better you can submit a Pull Request with a fix.

License

HMS Toolkit Convertor is licensed under the Apache License version 2.0