From fe61e1d536ab8cd78a60ace84e9f384868c9d3f9 Mon Sep 17 00:00:00 2001 From: Utsav Patel <75293077+up1512001@users.noreply.github.com> Date: Fri, 14 Jun 2024 19:49:45 +0530 Subject: [PATCH] Warning: Convert package to TypeScript (#62557) Co-authored-by: jpstevens Co-authored-by: youknowriad Co-authored-by: sirreal Co-authored-by: jsnajdr Co-authored-by: up1512001 --- packages/warning/CHANGELOG.md | 5 +++++ packages/warning/src/{index.js => index.ts} | 7 +++---- packages/warning/src/{utils.js => utils.ts} | 4 +--- 3 files changed, 9 insertions(+), 7 deletions(-) rename packages/warning/src/{index.js => index.ts} (86%) rename packages/warning/src/{utils.js => utils.ts} (66%) diff --git a/packages/warning/CHANGELOG.md b/packages/warning/CHANGELOG.md index cfc8338f86c597..c26fb1ea5d4ba2 100644 --- a/packages/warning/CHANGELOG.md +++ b/packages/warning/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +### Internal + +- Refactor to TypeScript ([#62557](https://github.com/WordPress/gutenberg/pull/62557)). + ## 3.0.0 (2024-05-31) ### Breaking Changes @@ -147,3 +151,4 @@ ## 1.0.0 (2020-02-04) Initial release. + diff --git a/packages/warning/src/index.js b/packages/warning/src/index.ts similarity index 86% rename from packages/warning/src/index.js rename to packages/warning/src/index.ts index 5744e99d94fd27..a5a092abbd2121 100644 --- a/packages/warning/src/index.js +++ b/packages/warning/src/index.ts @@ -3,7 +3,7 @@ */ import { logged } from './utils'; -function isDev() { +function isDev(): boolean { // eslint-disable-next-line @wordpress/wp-global-usage return globalThis.SCRIPT_DEBUG === true; } @@ -11,7 +11,7 @@ function isDev() { /** * Shows a warning with `message` if environment is not `production`. * - * @param {string} message Message to show in the warning. + * @param message Message to show in the warning. * * @example * ```js @@ -25,7 +25,7 @@ function isDev() { * } * ``` */ -export default function warning( message ) { +export default function warning( message: string ): void { if ( ! isDev() ) { return; } @@ -46,6 +46,5 @@ export default function warning( message ) { } catch ( x ) { // Do nothing. } - logged.add( message ); } diff --git a/packages/warning/src/utils.js b/packages/warning/src/utils.ts similarity index 66% rename from packages/warning/src/utils.js rename to packages/warning/src/utils.ts index fb087255f6bf6b..4f4b5d3e1f7976 100644 --- a/packages/warning/src/utils.js +++ b/packages/warning/src/utils.ts @@ -1,7 +1,5 @@ /** * Object map tracking messages which have been logged, for use in ensuring a * message is only logged once. - * - * @type {Set} */ -export const logged = new Set(); +export const logged: Set< string > = new Set();