# zeplin-cli-connect-plugin-stenciljs

> [Zeplin CLI](https://github.com/zeplin/cli) plugin to generate descriptions and code snippets for React components.

Latest version **1.0.1** (published 2020-09-26) · ISC license · 0 weekly downloads

## Install

```sh
npm install zeplin-cli-connect-plugin-stenciljs
pnpm add zeplin-cli-connect-plugin-stenciljs
yarn add zeplin-cli-connect-plugin-stenciljs
bun add zeplin-cli-connect-plugin-stenciljs
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-09-26 |
| First published | 2020-09-21 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Freddy Montes |
| Maintainers | fmontes |

## Links

- npm: https://www.npmjs.com/package/zeplin-cli-connect-plugin-stenciljs
- npm.io page: https://npm.io/package/zeplin-cli-connect-plugin-stenciljs

## Dependencies (2)

- [pug](https://npm.io/package/pug.md) ^3.0.0
- [@zeplin/cli](https://npm.io/package/@zeplin/cli.md) ^1.0.4

## Recent versions

- 1.0.1 (latest) — 2020-09-26
- 1.0.0 (alpha) — 2020-09-21

## README

# Zeplin CLI Stencil JS Plugin

[Zeplin CLI](https://github.com/zeplin/cli) plugin to generate descriptions and code snippets for React components.

## Installation

Install the plugin using npm.

```sh
npm install -g zeplin-cli-connect-plugin-stenciljs
```

## Usage

1. Generate the [StencilJS](https://stenciljs.com/) json docs, update you `stencil.config.ts` file and inside the `outputTargets` property add:

```
outputTargets: [
    { 
        type: 'docs-json',
        file: 'path/to/file.json'
    },
]
```
and then run `npm run build` to generate the file

2. In your `.zeplin/components.json` configuration file, add the plugin and pass the stencil docs file:

```
"plugins": [
    {
        "name": "cli-connect-stenciljs-plugin",
        "config": {
            "sourcePath": 'path/to/file.json'
        }
    }
]
```

3. Run CLI `connect` command using the plugin.

```sh
zeplin connect
```

## About Connected Components

[Connected Components](https://blog.zeplin.io/introducing-connected-components-components-in-design-and-code-in-harmony-aa894ed5bd95) 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](https://github.com/zeplin/cli) uses plugins like this one to analyze component source code and publishes a high-level overview to be displayed in Zeplin.

---
_Source: https://npm.io/package/zeplin-cli-connect-plugin-stenciljs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._