Zeplin CLI Android Plugin

Zeplin CLI plugin to generate descriptions and code snippets for Android components.

How it works

The plugin search for xml files and add to the snippet the first child inside the <merge> tags in that file. It is a good way to show an example of usages referencing to code in a showcase app

Example

For the following text_view.xml file

<?xml version="1.0" encoding="utf-8"?>
<merge xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    tools:parentTag="androidx.constraintlayout.widget.ConstraintLayout">

    <!--    Main Title component example, can also be used with bold variant-->
    <TextView
        android:id="@+id/main_title"
        style="@style/MainTitle"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="Main Title" />

</merge>

you are going to see following result

Installation

Install the plugin using npm.

npm install -g @rappi/zeplin-cli-connect-android-plugin

Usage

Run CLI connect command using the plugin.

zeplin connect -p @zeplin/cli-connect-swift-plugin

About Connected Components

Connected Components in Zeplin lets you access components in your codebase directly on designs in Zeplin, with links to Storybook, GitHub and any other source of documentation based on your workflow. 🧩

Zeplin CLI uses plugins like this one to analyze component source code and publishes a high-level overview to be displayed in Zeplin.