Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hms-core/hms-toolkit-convertor

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.
https://github.com/hms-core/hms-toolkit-convertor

android convertor hms huawei tool toolkit

Last synced: about 2 months ago
JSON representation

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.

Awesome Lists containing this project

README 

        
# HMS Toolkit Convertor



[![License](https://img.shields.io/badge/Docs-hmsguides-brightgreen)](https://developer.huawei.com/consumer/en/doc/development/Tools-Guides/05673260) ![Apache-2.0](https://img.shields.io/badge/license-Apache-blue)



English | [中文](https://github.com/HMS-Core/hms-toolkit-convertor/blob/master/README_ZH.md)



## Table of Contents



 * [Introduction](#introduction)

 * [Build](#build)

 * [Install](#install)

 * [Develop](#run-and-debug-on-ide)

 * [Code Contributions](#code-contributions)

 * [License](#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: 



```shell

$ ./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**



![avatar](https://communityfile-drcn.op.hicloud.com/FileServer/getFile/cmtyPub/011/111/111/0000000000011111111.20200202174355.27600226939014491241655781001918:50510422152457:2800:B7365AA229F3984BF33549A22CB13A9D312E5FD82F0D48ADF1D0102637571B4D.png?needInitFileName=true)



select the ZIP plugin package generated during the build.



tips:



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



```shell

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

```



For more details, please refer to [Usage Guide](https://developer.huawei.com/consumer/en/doc/development/Tools-Guides/90419706)



## Run and Debug on IDE



1. Clone the repo 



```bash

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](https://www.reddit.com/r/HuaweiDevelopers/) 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](https://stackoverflow.com/questions/tagged/huawei-mobile-services) is the best place for any programming questions. Be sure to tag your question with 

`huawei-mobile-services`.

- [Huawei Developer Forum](https://forums.developer.huawei.com/forumPortal/en/home?fid=0101187876626530001) 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](https://github.com/HMS-Core/hms-toolkit-convertor/issues) to the Repository. Even better you can submit a [Pull Request](https://github.com/HMS-Core/hms-toolkit-convertor/pulls) with a fix.



## License



HMS Toolkit Convertor is licensed under the [Apache License version 2.0](https://github.com/HMS-Core/hms-toolkit-convertor/blob/master/LICENSE)