{"id":13343917,"url":"https://github.com/zeplin/cli-connect-react-plugin","last_synced_at":"2025-07-10T05:30:46.067Z","repository":{"id":38192594,"uuid":"215841230","full_name":"zeplin/cli-connect-react-plugin","owner":"zeplin","description":"Zeplin CLI plugin for React components","archived":false,"fork":false,"pushed_at":"2023-12-13T07:15:40.000Z","size":1106,"stargazers_count":14,"open_issues_count":19,"forks_count":6,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-05-28T10:09:48.252Z","etag":null,"topics":["react","zeplin","zeplin-cli"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zeplin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-17T16:47:32.000Z","updated_at":"2024-07-23T00:19:06.000Z","dependencies_parsed_at":"2024-06-18T18:51:21.199Z","dependency_job_id":null,"html_url":"https://github.com/zeplin/cli-connect-react-plugin","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/zeplin/cli-connect-react-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-react-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-react-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-react-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-react-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeplin","download_url":"https://codeload.github.com/zeplin/cli-connect-react-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-react-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263705642,"owners_count":23499044,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["react","zeplin","zeplin-cli"],"created_at":"2024-07-29T19:32:05.360Z","updated_at":"2025-07-10T05:30:45.795Z","avatar_url":"https://github.com/zeplin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zeplin CLI React Plugin\n\n[Zeplin CLI](https://github.com/zeplin/cli) plugin to generate descriptions and code snippets for React components.\n\nZeplin CLI React Plugin uses [react-docgen](https://github.com/reactjs/react-docgen) and [react-docgen-typescript](https://github.com/styleguidist/react-docgen-typescript) to analyze and collect information from React components. For more details about the supported formats, see `react-docgen` [guidelines](https://github.com/reactjs/react-docgen#guidelines-for-default-resolvers-and-handlers) and `react-docgen-typescript` [examples](https://github.com/styleguidist/react-docgen-typescript#example).\n\n## Installation\n\nInstall the plugin using npm.\n\n```sh\nnpm install -g @zeplin/cli-connect-react-plugin\n```\n\n## Usage\n\nRun CLI `connect` command using the plugin.\n\n```sh\nzeplin connect -p @zeplin/cli-connect-react-plugin\n```\n\n### Using react-docgen-typescript for Typescript components\n\nYou can choose to use either `react-docgen` or `react-docgen-typescript` for TypeScript in your plugin configurations.\n\n```jsonc\n{\n    ...\n    \"plugins\" : [{\n        \"name\": \"@zeplin/cli-connect-react-plugin\",\n        \"config\": {\n            \"tsDocgen\": \"react-docgen-typescript\", // Default: \"react-docgen\"\n            \"tsConfigPath\": \"/path/to/tsconfig.json\" // Default: \"./tsconfig.json\"\n        }\n    }],\n    ...\n}\n```\n\n### Using react-docgen resolvers\n\nYou can set which built-in `react-docgen` resolver to use.\n\n```jsonc\n{\n    ...\n    \"plugins\" : [{\n        \"name\": \"@zeplin/cli-connect-react-plugin\",\n        \"config\": {\n            // Default: \"findAllExportedComponentDefinitions\"\n            \"reactDocgenResolver\": \"findExportedComponentDefinition\",\n        }\n    }],\n    ...\n}\n```\n\n## About Connected Components\n\n[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. 🧩\n\nCheck [Zeplin Connected Components Documentation](https://zpl.io/connected-components-docs) for getting started.\n\n[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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fcli-connect-react-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeplin%2Fcli-connect-react-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fcli-connect-react-plugin/lists"}