@zeplin/cli - npm Package Compare versions

Comparing version 0.5.0 to 1.0.0

docs/cli.styleguidistcomponentconfig.name.md

dist/package.json

dist/src/commands/connect/config.js

		@@ -36,3 +36,3 @@ "use strict";
		styleguidist: joi_1.default.object({
		kind: joi_1.default.string()
		name: joi_1.default.string()
		}).optional()
		@@ -39,0 +39,0 @@ });

dist/src/commands/connect/plugin.js

		@@ -23,2 +23,3 @@ "use strict";
		const chalk_1 = __importDefault(require("chalk"));
		const path_1 = __importDefault(require("path"));
		const ts_dedent_1 = __importDefault(require("ts-dedent"));
		@@ -96,8 +97,8 @@ const url_join_1 = __importDefault(require("url-join"));
		const branch = gitConfig.branch \|\| repoDefaults.branch;
		const path = encodeURIComponent(gitConfig.path \|\| "");
		const encodedPath = encodeURIComponent(componentPath);
		const basePath = gitConfig.path \|\| "";
		const prefix = repoDefaults.prefix \|\| "";
		const filePath = componentPath.split(path_1.default.sep);
		return {
		type: repoDefaults.type,
		url: url_join_1.default(url, repository, prefix, branch, path, encodedPath)
		url: encodeURI(url_join_1.default(url, repository, prefix, branch, basePath, ...filePath))
		};
		@@ -150,3 +151,3 @@ };
		if (type === "styleguidist" && component.styleguidist) {
		const encodedKind = encodeURIComponent(component.styleguidist.kind);
		const encodedKind = encodeURIComponent(component.styleguidist.name);
		urlPaths.push({ name, type: "styleguidist" /* styleguidist */, url: url_join_1.default(url, `#${encodedKind}`) });
		@@ -153,0 +154,0 @@ }

dist/types/index.d.ts

		@@ -263,5 +263,5 @@
		export declare interface StyleguidistComponentConfig {
		kind: string;
		name: string;
		}

		export { }

docs/cli.styleguidistcomponentconfig.md

		@@ -18,3 +18,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
		\| --- \| --- \| --- \|
		\| [kind](./cli.styleguidistcomponentconfig.kind.md) \| <code>string</code> \| \|
		\| [name](./cli.styleguidistcomponentconfig.name.md) \| <code>string</code> \| \|

package.json

README.md

		@@ -17,7 +17,7 @@ # Zeplin CLI

		[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. 🧩
		[Connected Components](https://zpl.io/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. 🧩

		CLI `connect` command uses plugins to analyze component source code and publishes a high-level overview to be displayed in Zeplin. You can either publish changes to your components manually, or better yet, you can always keep them in sync by running the CLI as a step in your CI workflow.

		Make sure that you created a configuration file (`.zeplin/components.json`) following [Connected Components documentation]() and run the `connect` command:
		Make sure that you created a configuration file (`.zeplin/components.json`) following [Connected Components documentation](https://github.com/zeplin/connected-components-docs) and run the `connect` command:

		@@ -24,0 +24,0 @@ ```sh

docs/cli.styleguidistcomponentconfig.kind.md

dist/src/commands/connect/plugin.js.map

Sorry, the diff of this file is not supported yet

temp/cli.api.json

Sorry, the diff of this file is too big to display

		@@ -18,3 +18,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
		\| --- \| --- \| --- \|
		\| [kind](./cli.styleguidistcomponentconfig.kind.md) \| <code>string</code> \| \|
		\| [name](./cli.styleguidistcomponentconfig.name.md) \| <code>string</code> \| \|

New alerts