{"id":13343891,"url":"https://github.com/zeplin/cli-connect-angular-plugin","last_synced_at":"2025-07-10T05:30:44.025Z","repository":{"id":39660469,"uuid":"228799366","full_name":"zeplin/cli-connect-angular-plugin","owner":"zeplin","description":"Zeplin CLI plugin for Angular components","archived":false,"fork":false,"pushed_at":"2023-01-07T06:50:12.000Z","size":1447,"stargazers_count":3,"open_issues_count":13,"forks_count":5,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-06-13T07:44:00.489Z","etag":null,"topics":["angular","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}},"created_at":"2019-12-18T09:00:56.000Z","updated_at":"2022-09-21T04:48:54.000Z","dependencies_parsed_at":"2023-02-06T14:30:52.019Z","dependency_job_id":null,"html_url":"https://github.com/zeplin/cli-connect-angular-plugin","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/zeplin/cli-connect-angular-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-angular-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-angular-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-angular-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-angular-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeplin","download_url":"https://codeload.github.com/zeplin/cli-connect-angular-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeplin%2Fcli-connect-angular-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261622817,"owners_count":23186024,"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":["angular","zeplin","zeplin-cli"],"created_at":"2024-07-29T19:32:05.100Z","updated_at":"2025-07-10T05:30:43.741Z","avatar_url":"https://github.com/zeplin.png","language":"TypeScript","readme":"# Zeplin CLI Angular Plugin\n\n[Zeplin CLI](https://github.com/zeplin/cli) plugin to generate descriptions and code snippets for Angular components.\n\n## Installation\n\nInstall plugin using npm.\n\n```sh\nnpm install -g @zeplin/cli-connect-angular-plugin\n```\n\n## Usage\n\nRun CLI `connect` command using the plugin.\n\n```sh\nzeplin connect -p @zeplin/cli-connect-angular-plugin\n```\n\nZeplin CLI Angular Plugin uses a fork of [Compodoc](https://github.com/compodoc/compodoc) to analyze and collect information from Angular components.\n\n### Configuration\n\nIf necessary, Zeplin CLI Angular Plugin can generate more detailed snippets and descriptions. Update your [components configuration file](./docs/cli.componentconfigfile.plugins.md) to add the properties you need.\n\n| Property             | Description                                                                  |\n|----------------------|------------------------------------------------------------------------------|\n| `useFullSnippet`     | Generates a distinct snippet for all combinations of the component selectors |\n| `useFullDescription` | Generates descriptions with implemented interface names                      |\n\nHere's a sample configuration file (`.zeplin/components.json`):\n\n```json\n{\n    ...\n    \"plugins\" : [{\n        \"name\": \"@zeplin/cli-connect-angular-plugin\",\n        \"config\": {\n            \"useFullSnippet\": true,\n            \"useFullDescription\": true,\n        }\n    }],\n    ...\n}\n```\n\n☝️ _Note that after adding the plugin to the configuration file, you don't need to pass it as the `-p` argument to the `connect` command—running `zeplin connect` should be enough._\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\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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fcli-connect-angular-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeplin%2Fcli-connect-angular-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeplin%2Fcli-connect-angular-plugin/lists"}