From bd8d3770f7a8ef61bdba0fb94d66c387cdfcf911 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Wed, 21 Jun 2023 06:19:27 -0500 Subject: [PATCH] docs(CHANGELOG): Note typescript workaround --- CHANGELOG.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a97fda9e6..913386720 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,31 @@ ([release notes](https://github.com/ckeditor/ckeditor5-linters-config/blob/v5.1.0/CHANGELOG.md)) +- README: Note typing workaround for TypeScript builds (#105) + + 1. Create a `d.ts` declaration file, e.g. `typings/ckeditor5-math.d.ts` + + ```typescript + declare module '@isaul32/ckeditor5-math'; + declare module '@isaul32/ckeditor5-math/src/math'; + declare module '@isaul32/ckeditor5-math/src/autoformatmath'; + ``` + + 2. In your [`tsconfig.json`](https://www.typescriptlang.org/tsconfig)'s + root-level [`include`](https://www.typescriptlang.org/tsconfig#include) + option, make sure your declaration file is covered, e.g. + + ```json + { + "extends": "ckeditor5/tsconfig.json", + "include": [ + "src", + "typings", + "../../typings" + ] + } + ``` + ## [38.0.1](https://github.com/isaul32/ckeditor5-math/compare/v38.0.0...v38.0.1) (2023-06-20) - Update dependencies for CKEditor 38.0.1 ([Release