Merge pull request #147 from ckeditor/i/144

Feature: Add `augmentation.ts` to the TypeScript package generator. Closes #144.
ckeditor · Apr 20, 2023 · f736d08 · f736d08
2 parents fddaa52 + 1e00b93
commit f736d08
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 1 deletion.
diff --git a/packages/ckeditor5-package-generator/lib/templates/ts/sample/index.html b/packages/ckeditor5-package-generator/lib/templates/ts/sample/index.html
@@ -72,6 +72,7 @@ <h3>The directory structure</h3>
 │  └─ ckeditor.ts      # The editor initialization script.
 ├─ src
 │  ├─ <%= formattedNames.plugin.lowerCaseMerged %>.ts
+│  ├─ augmentation.ts  # Type augmentations for the `@ckeditor/ckeditor5-core` module. Read more in <a href="https://ckeditor.com/docs/ckeditor5/latest/api/module_core_plugincollection-PluginsMap.html">PluginsMap</a> and <a href="https://ckeditor.com/docs/ckeditor5/latest/api/module_core_commandcollection-CommandsMap.html">CommandsMap</a>.
 │  ├─ index.ts         # The modules exported by the package when using the DLL builds.
 │  └─ **/*.ts          # All TypeScript source files should be saved here.
 ├─ tests

diff --git a/packages/ckeditor5-package-generator/lib/templates/ts/src/augmentation.ts.txt b/packages/ckeditor5-package-generator/lib/templates/ts/src/augmentation.ts.txt
@@ -0,0 +1,7 @@
+import type { <%= formattedNames.plugin.pascalCase %> } from './index';
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface PluginsMap {
+		[ <%= formattedNames.plugin.pascalCase %>.pluginName ]: <%= formattedNames.plugin.pascalCase %>;
+	}
+}
diff --git a/packages/ckeditor5-package-generator/lib/templates/ts/src/index.ts.txt b/packages/ckeditor5-package-generator/lib/templates/ts/src/index.ts.txt
@@ -1,4 +1,5 @@
 import ckeditor from './../theme/icons/ckeditor.svg';
+import './augmentation';
 
 export { default as <%= formattedNames.plugin.pascalCase %> } from './<%= formattedNames.plugin.lowerCaseMerged %>';
 

diff --git a/packages/ckeditor5-package-generator/lib/templates/ts/tsconfig.json.txt b/packages/ckeditor5-package-generator/lib/templates/ts/tsconfig.json.txt
@@ -1,7 +1,8 @@
 {
   "compilerOptions": {
     "lib": [
-      "DOM"
+      "DOM",
+      "DOM.Iterable"
     ],
     "noImplicitAny": true,
     "noImplicitOverride": true,

diff --git a/scripts/ci/travis-check.js b/scripts/ci/travis-check.js
@@ -33,8 +33,10 @@ const EXPECTED_PUBLISH_FILES = {
 		'ckeditor5-metadata.json'
 	],
 	ts: [
+		'src/augmentation.js',
 		'src/index.js',
 		'src/testpackage.js',
+		'src/augmentation.d.ts',
 		'src/index.d.ts',
 		'src/testpackage.d.ts',
 
@@ -55,6 +57,7 @@ const EXPECTED_SRC_DIR_FILES = {
 		'testpackage.js'
 	],
 	ts: [
+		'augmentation.ts',
 		'index.ts',
 		'testpackage.ts'
 	]