Described all TS configs.

ckeditor · Mar 8, 2023 · f292ff6 · f292ff6
1 parent 0de972d
commit f292ff6
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 0 deletions.
diff --git a/tsconfig.dll.json b/tsconfig.dll.json
@@ -1,3 +1,6 @@
+/*
+ * The configuration is used when preparing DLL builds.
+ */
 {
   "extends": "./tsconfig.json",
   "include": [

diff --git a/tsconfig.docs.json b/tsconfig.docs.json
@@ -1,3 +1,7 @@
+/*
+ * The configuration is used when building docs (snippets adapter and content styles generator).
+ * This configuration is NOT used when building API docs using typedoc. See `tsconfig.typedoc.json`.
+ */
 {
   "extends": "./tsconfig.json",
   "include": [

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,3 +1,8 @@
+/*
+ * The base configuration used by all other configuration.
+ *
+ * Be careful when updating this file. It may affect building docs, preparing DLLs, executing tests, or impacts the release process.
+ */
 {
   "compilerOptions": {
     "lib": [

diff --git a/tsconfig.release-ckeditor5.json b/tsconfig.release-ckeditor5.json
@@ -1,3 +1,6 @@
+/*
+ * The configuration is used when releasing the `ckeditor5` package.
+ */
 {
   "extends": "./tsconfig.release.json",
   "include": [

diff --git a/tsconfig.release.json b/tsconfig.release.json
@@ -1,3 +1,6 @@
+/*
+ * The configuration is used when releasing all CKEditor 5 packages (from the `packages/` directory).
+ */
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {

diff --git a/tsconfig.test.json b/tsconfig.test.json
@@ -1,3 +1,6 @@
+/*
+ * The configuration is used when executing automated and manual tests.
+ */
 {
   "extends": "./tsconfig.json",
   "include": [

diff --git a/tsconfig.typedoc.json b/tsconfig.typedoc.json
@@ -1,3 +1,6 @@
+/*
+ * The configuration is used when preparing API docs using typedoc.
+ */
 {
   "extends": "./tsconfig.json",
   "include": [