bacafb8d-031f-40a8-975f-c8290cc8e33a

Committed 15 Jul 2024 07:54AM UTC coverage: 100.0%. Remained the same

Build # bacafb8d-031f-40a8-975f-c8290cc8e33a

Build Type

Pull #292

circleci

Committed by

filipsobol

Commit Message

MINOR BREAKING CHANGE: Rename exports back to `CkeditorPlugin` and `Ckeditor`.

Pull Request Pull Request #292: Rename exports back to `CkeditorPlugin` and `Ckeditor`.

Run Details

24 of 24 branches covered (100.0%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

57 of 57 relevant lines covered (100.0%)

41.56 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/plugin.ts

/**
 * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md.
 */

/* eslint-env browser */
import * as Vue from 'vue';
import Ckeditor from './ckeditor.vue';

/* istanbul ignore if -- @preserve */
if ( !Vue.version || !Vue.version.startsWith( '3.' ) ) {
        throw new Error(
                'The CKEditor plugin works only with Vue 3+. ' +
                'For more information, please refer to ' +
                'https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v3.html'
        );
}

const CkeditorPlugin = {
        /**
         * Installs the plugin, registering the `<ckeditor>` component.
         *
         * @param app The application instance.
         */
        install( app: Vue.App ): void {
                app.component( 'Ckeditor', Ckeditor );
        }
};

/**
 * The component is exported as `Ckeditor` and not `CKEditor`, because of how Vue handles components with
 * capitalized names. The component with more than one consecutive capital letter will also be be available
 * in kebab-case, where each capital letter is separated by `-`. This way, the `CKEditor` component will
 * be available as `c-k-editor`, which doesn't look good.
 */
export {
        CkeditorPlugin,
        Ckeditor
};

declare module 'vue' {
        export interface GlobalComponents {
                Ckeditor: typeof Ckeditor;
        }
}

1	/**
2	* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3	* For licensing, see LICENSE.md.
4	*/
5
6	/* eslint-env browser */
7	import * as Vue from 'vue';
8	import Ckeditor from './ckeditor.vue';
9
10	/* istanbul ignore if -- @preserve */
11	if ( !Vue.version \|\| !Vue.version.startsWith( '3.' ) ) {	4✔
12	throw new Error(
13	'The CKEditor plugin works only with Vue 3+. ' +
14	'For more information, please refer to ' +
15	'https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/frameworks/vuejs-v3.html'
16	);
17	}
18
19	const CkeditorPlugin = {	4✔
20	/**
21	* Installs the plugin, registering the `<ckeditor>` component.
22	*
23	* @param app The application instance.
24	*/
25	install( app: Vue.App ): void {
26	app.component( 'Ckeditor', Ckeditor );	1✔
27	}
28	};
29
30	/**
31	* The component is exported as `Ckeditor` and not `CKEditor`, because of how Vue handles components with
32	* capitalized names. The component with more than one consecutive capital letter will also be be available
33	* in kebab-case, where each capital letter is separated by `-`. This way, the `CKEditor` component will
34	* be available as `c-k-editor`, which doesn't look good.
35	*/
36	export {
37	CkeditorPlugin,
38	Ckeditor
39	};
40
41	declare module 'vue' {
42	export interface GlobalComponents {
43	Ckeditor: typeof Ckeditor;
44	}
45	}

ckeditor / ckeditor5-vue / bacafb8d-031f-40a8-975f-c8290cc8e33a

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous