Merge pull request #13626 from ckeditor/ck/13565-improve-module-augme…

…ntation-20230307 Internal: Improve module augmentation in numerous packages. Related to #13565.
ckeditor · Mar 7, 2023 · 8ab8453 · 8ab8453
2 parents c96f5b9 + 3ea9d1b
commit 8ab8453
Show file tree

Hide file tree

Showing 26 changed files with 125 additions and 105 deletions.
diff --git a/packages/ckeditor5-build-balloon-block/src/ckeditor.ts b/packages/ckeditor5-build-balloon-block/src/ckeditor.ts
@@ -20,9 +20,9 @@ import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEdit
 import { Indent } from '@ckeditor/ckeditor5-indent';
 import { Link } from '@ckeditor/ckeditor5-link';
 import { List } from '@ckeditor/ckeditor5-list';
-import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
+import { MediaEmbed } from '@ckeditor/ckeditor5-media-embed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
-import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
+import { PasteFromOffice } from '@ckeditor/ckeditor5-paste-from-office';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-balloon/src/ckeditor.ts b/packages/ckeditor5-build-balloon/src/ckeditor.ts
@@ -19,9 +19,9 @@ import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEdit
 import { Indent } from '@ckeditor/ckeditor5-indent';
 import { Link } from '@ckeditor/ckeditor5-link';
 import { List } from '@ckeditor/ckeditor5-list';
-import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
+import { MediaEmbed } from '@ckeditor/ckeditor5-media-embed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
-import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
+import { PasteFromOffice } from '@ckeditor/ckeditor5-paste-from-office';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-classic/src/ckeditor.ts b/packages/ckeditor5-build-classic/src/ckeditor.ts
@@ -19,9 +19,9 @@ import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEdit
 import { Indent } from '@ckeditor/ckeditor5-indent';
 import { Link } from '@ckeditor/ckeditor5-link';
 import { List } from '@ckeditor/ckeditor5-list';
-import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
+import { MediaEmbed } from '@ckeditor/ckeditor5-media-embed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
-import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
+import { PasteFromOffice } from '@ckeditor/ckeditor5-paste-from-office';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-decoupled-document/src/ckeditor.ts b/packages/ckeditor5-build-decoupled-document/src/ckeditor.ts
@@ -21,9 +21,9 @@ import { Image, ImageCaption, ImageResize, ImageStyle, ImageToolbar, ImageUpload
 import { Indent, IndentBlock } from '@ckeditor/ckeditor5-indent';
 import { Link } from '@ckeditor/ckeditor5-link';
 import { List, ListProperties } from '@ckeditor/ckeditor5-list';
-import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
+import { MediaEmbed } from '@ckeditor/ckeditor5-media-embed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
-import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
+import { PasteFromOffice } from '@ckeditor/ckeditor5-paste-from-office';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-inline/src/ckeditor.ts b/packages/ckeditor5-build-inline/src/ckeditor.ts
@@ -19,9 +19,9 @@ import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEdit
 import { Indent } from '@ckeditor/ckeditor5-indent';
 import { Link } from '@ckeditor/ckeditor5-link';
 import { List } from '@ckeditor/ckeditor5-list';
-import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
+import { MediaEmbed } from '@ckeditor/ckeditor5-media-embed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
-import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
+import { PasteFromOffice } from '@ckeditor/ckeditor5-paste-from-office';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-build-multi-root/src/ckeditor.ts b/packages/ckeditor5-build-multi-root/src/ckeditor.ts
@@ -15,18 +15,13 @@ import { CKBox } from '@ckeditor/ckeditor5-ckbox';
 import { CKFinder } from '@ckeditor/ckeditor5-ckfinder';
 import { EasyImage } from '@ckeditor/ckeditor5-easy-image';
 import { Heading } from '@ckeditor/ckeditor5-heading';
-import Image from '@ckeditor/ckeditor5-image/src/image';
-import ImageCaption from '@ckeditor/ckeditor5-image/src/imagecaption';
-import ImageStyle from '@ckeditor/ckeditor5-image/src/imagestyle';
-import ImageToolbar from '@ckeditor/ckeditor5-image/src/imagetoolbar';
-import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
+import { Image, ImageCaption, ImageStyle, ImageToolbar, ImageUpload, PictureEditing } from '@ckeditor/ckeditor5-image';
 import { Indent } from '@ckeditor/ckeditor5-indent';
-import Link from '@ckeditor/ckeditor5-link/src/link';
-import List from '@ckeditor/ckeditor5-list/src/list';
-import MediaEmbed from '@ckeditor/ckeditor5-media-embed/src/mediaembed';
+import { Link } from '@ckeditor/ckeditor5-link';
+import { List } from '@ckeditor/ckeditor5-list';
+import { MediaEmbed } from '@ckeditor/ckeditor5-media-embed';
 import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
-import PasteFromOffice from '@ckeditor/ckeditor5-paste-from-office/src/pastefromoffice';
-import PictureEditing from '@ckeditor/ckeditor5-image/src/pictureediting';
+import { PasteFromOffice } from '@ckeditor/ckeditor5-paste-from-office';
 import { Table, TableToolbar } from '@ckeditor/ckeditor5-table';
 import { TextTransformation } from '@ckeditor/ckeditor5-typing';
 import { CloudServices } from '@ckeditor/ckeditor5-cloud-services';

diff --git a/packages/ckeditor5-mention/src/augmentation.ts b/packages/ckeditor5-mention/src/augmentation.ts
@@ -0,0 +1,34 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type {
+	MentionConfig,
+	Mention,
+	MentionEditing,
+	MentionUI,
+	MentionCommand
+} from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface EditorConfig {
+
+		/**
+		 * The configuration of the {@link module:mention/mention~Mention} feature.
+		 *
+		 * Read more in {@link module:mention/mentionconfig~MentionConfig}.
+		 */
+		mention?: MentionConfig;
+	}
+
+	interface PluginsMap {
+		[ Mention.pluginName ]: Mention;
+		[ MentionEditing.pluginName ]: MentionEditing;
+		[ MentionUI.pluginName ]: MentionUI;
+	}
+
+	interface CommandsMap {
+		mention: MentionCommand;
+	}
+}
diff --git a/packages/ckeditor5-mention/src/index.ts b/packages/ckeditor5-mention/src/index.ts
@@ -10,3 +10,8 @@
 export { default as Mention } from './mention';
 export { default as MentionEditing } from './mentionediting';
 export { default as MentionUI } from './mentionui';
+
+export type { MentionConfig } from './mentionconfig';
+export type { default as MentionCommand } from './mentioncommand';
+
+import './augmentation';
diff --git a/packages/ckeditor5-mention/src/mention.ts b/packages/ckeditor5-mention/src/mention.ts
@@ -81,9 +81,3 @@ export type MentionAttribute = {
 	 */
 	_text?: string;
 };
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ Mention.pluginName ]: Mention;
-	}
-}
diff --git a/packages/ckeditor5-mention/src/mentioncommand.ts b/packages/ckeditor5-mention/src/mentioncommand.ts
@@ -154,9 +154,3 @@ export default class MentionCommand extends Command {
 		} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		mention: MentionCommand;
-	}
-}
diff --git a/packages/ckeditor5-mention/src/mentionconfig.ts b/packages/ckeditor5-mention/src/mentionconfig.ts
@@ -280,15 +280,3 @@ export type MentionFeedObjectItem = {
 	 */
 	text?: string;
 };
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface EditorConfig {
-
-		/**
-		 * The configuration of the {@link module:mention/mention~Mention} feature.
-		 *
-		 * Read more in {@link module:mention/mentionconfig~MentionConfig}.
-		 */
-		mention?: MentionConfig;
-	}
-}
diff --git a/packages/ckeditor5-mention/src/mentionediting.ts b/packages/ckeditor5-mention/src/mentionediting.ts
@@ -304,9 +304,3 @@ function checkAndFix( textNode: Item | null, writer: Writer ): boolean {
 
 	return false;
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ MentionEditing.pluginName ]: MentionEditing;
-	}
-}
diff --git a/packages/ckeditor5-mention/src/mentionui.ts b/packages/ckeditor5-mention/src/mentionui.ts
@@ -888,9 +888,3 @@ type MarkerDefinition = {
 	pattern: RegExp;
 	position: number;
 };
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ MentionUI.pluginName ]: MentionUI;
-	}
-}
diff --git a/packages/ckeditor5-minimap/src/augmentation.ts b/packages/ckeditor5-minimap/src/augmentation.ts
@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type {
+	MinimapConfig,
+	Minimap
+} from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface EditorConfig {
+
+		/**
+		 * The configuration of the minimap feature. Introduced by the {@link module:minimap/minimap~Minimap} feature.
+		 *
+		 * Read more in {@link module:minimap/minimapconfig~MinimapConfig}.
+		 */
+		minimap?: MinimapConfig;
+	}
+
+	interface PluginsMap {
+		[ Minimap.pluginName ]: Minimap;
+	}
+}
+
diff --git a/packages/ckeditor5-minimap/src/index.ts b/packages/ckeditor5-minimap/src/index.ts
@@ -8,3 +8,7 @@
  */
 
 export { default as Minimap } from './minimap';
+
+export type { MinimapConfig } from './minimapconfig';
+
+import './augmentation';
diff --git a/packages/ckeditor5-minimap/src/minimap.ts b/packages/ckeditor5-minimap/src/minimap.ts
@@ -20,7 +20,6 @@ import {
 
 // @if CK_DEBUG_MINIMAP // const RectDrawer = require( '@ckeditor/ckeditor5-utils/tests/_utils/rectdrawer' ).default;
 
-import './minimapconfig';
 import '../theme/minimap.css';
 
 /**
@@ -210,9 +209,3 @@ export default class Minimap extends Plugin {
 		minimapView.setScrollProgress( scrollProgress );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ Minimap.pluginName ]: Minimap;
-	}
-}
diff --git a/packages/ckeditor5-minimap/src/minimapconfig.ts b/packages/ckeditor5-minimap/src/minimapconfig.ts
@@ -89,15 +89,3 @@ export interface MinimapConfig {
 	extraClasses?: string;
 
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface EditorConfig {
-
-		/**
-		 * The configuration of the minimap feature. Introduced by the {@link module:minimap/minimap~Minimap} feature.
-		 *
-		 * Read more in {@link module:minimap/minimapconfig~MinimapConfig}.
-		 */
-		minimap?: MinimapConfig;
-	}
-}
diff --git a/packages/ckeditor5-page-break/src/augmentation.ts b/packages/ckeditor5-page-break/src/augmentation.ts
@@ -0,0 +1,23 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type {
+	PageBreak,
+	PageBreakEditing,
+	PageBreakUI,
+	PageBreakCommand
+} from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface PluginsMap {
+		[ PageBreak.pluginName ]: PageBreak;
+		[ PageBreakEditing.pluginName ]: PageBreakEditing;
+		[ PageBreakUI.pluginName ]: PageBreakUI;
+	}
+
+	interface CommandsMap {
+		pageBreak: PageBreakCommand;
+	}
+}
diff --git a/packages/ckeditor5-page-break/src/index.ts b/packages/ckeditor5-page-break/src/index.ts
@@ -10,3 +10,7 @@
 export { default as PageBreak } from './pagebreak';
 export { default as PageBreakEditing } from './pagebreakediting';
 export { default as PageBreakUI } from './pagebreakui';
+
+export type { default as PageBreakCommand } from './pagebreakcommand';
+
+import './augmentation';
diff --git a/packages/ckeditor5-page-break/src/pagebreak.ts b/packages/ckeditor5-page-break/src/pagebreak.ts
@@ -35,9 +35,3 @@ export default class PageBreak extends Plugin {
 		return 'PageBreak';
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ PageBreak.pluginName ]: PageBreak;
-	}
-}
diff --git a/packages/ckeditor5-page-break/src/pagebreakcommand.ts b/packages/ckeditor5-page-break/src/pagebreakcommand.ts
@@ -72,9 +72,3 @@ function getInsertPageBreakParent( selection: DocumentSelection, model: Model ):
 
 	return parent as Element;
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface CommandsMap {
-		pageBreak: PageBreakCommand;
-	}
-}
diff --git a/packages/ckeditor5-page-break/src/pagebreakediting.ts b/packages/ckeditor5-page-break/src/pagebreakediting.ts
@@ -128,9 +128,3 @@ function toPageBreakWidget( viewElement: ViewElement, writer: DowncastWriter, la
 
 	return toWidget( viewElement, writer, { label } );
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ PageBreakEditing.pluginName ]: PageBreakEditing;
-	}
-}
diff --git a/packages/ckeditor5-page-break/src/pagebreakui.ts b/packages/ckeditor5-page-break/src/pagebreakui.ts
@@ -53,9 +53,3 @@ export default class PageBreakUI extends Plugin {
 		} );
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ PageBreakUI.pluginName ]: PageBreakUI;
-	}
-}
diff --git a/packages/ckeditor5-paste-from-office/src/augmentation.ts b/packages/ckeditor5-paste-from-office/src/augmentation.ts
@@ -0,0 +1,12 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type { PasteFromOffice } from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface PluginsMap {
+		[ PasteFromOffice.pluginName ]: PasteFromOffice;
+	}
+}
diff --git a/packages/ckeditor5-paste-from-office/src/index.ts b/packages/ckeditor5-paste-from-office/src/index.ts
@@ -8,3 +8,5 @@
  */
 
 export { default as PasteFromOffice } from './pastefromoffice';
+
+import './augmentation';
diff --git a/packages/ckeditor5-paste-from-office/src/pastefromoffice.ts b/packages/ckeditor5-paste-from-office/src/pastefromoffice.ts
@@ -85,9 +85,3 @@ export default class PasteFromOffice extends Plugin {
 		);
 	}
 }
-
-declare module '@ckeditor/ckeditor5-core' {
-	interface PluginsMap {
-		[ PasteFromOffice.pluginName ]: PasteFromOffice;
-	}
-}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -8,3 +8,5 @@
		*/

		export { default as PasteFromOffice } from './pastefromoffice';

		import './augmentation';