@discord/intl-loader-core 0.11.3 → 0.11.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl-loader-core",
-  "version": "0.11.3",
+  "version": "0.11.4",
   "license": "MIT",
   "description": "Core utilities for writing loaders and transformers using @discord/intl",
   "author": "Jon Egeland",
@@ -28,7 +28,7 @@
   "dependencies": {
     "chokidar": "^3.6.0",
     "debug": "^4.3.6",
-    "@discord/intl-message-database": "0.11.3"
+    "@discord/intl-message-database": "0.11.4"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",

package/src/watcher.js

@@ -28,6 +28,12 @@ const ALWAYS_IGNORE_PATTERNS = [
 const MESSAGES_FILE_PATTERNS = ['**/*.messages.*'];
 const DEFAULT_LOCALE = 'en-US';
 
+/**
+ * @typedef {{
+ *   on(event: string, callback: (event: string, path: string) => void): void
+ * }} BasicWatcher
+ */
+
 /**
  * Start a new filesystem watcher to discover and monitor messages files, allowing consumers to
  * react to changes in a single, consistent way.
@@ -39,9 +45,7 @@ const DEFAULT_LOCALE = 'en-US';
  *  persistent?: boolean,
  *  once?: boolean,
  * }} options
- * @returns {Promise<{
- *   on(event: string, callback: (event: string, path: string) => void): void
- * }>}
+ * @returns {Promise<BasicWatcher>}
  */
 async function watchMessagesFiles(
   watchedFolders,
@@ -94,7 +98,7 @@ async function watchMessagesFiles(
 /**
  * Watch the file system for any changes to message files and regenerate their types.
  *
- * @param {chokidar.FSWatcher} watcher
+ * @param {BasicWatcher} watcher
  * @param {{
  *  allowNullability?: boolean
  * }} options
@@ -111,7 +115,7 @@ async function generateMessageTypes(watcher, { allowNullability }) {
  * Watch the file system for changes to message _definitions_ files, and pre-process them into
  * compiled assets (with the extension `.compiled.messages.${assetExtension}`).
  *
- * @param {chokidar.FSWatcher} watcher
+ * @param {BasicWatcher} watcher
  * @param {{
  *  ignore?: string[],
  *  assetExtension?: string

package/types/src/watcher.d.ts

@@ -1,3 +1,11 @@
+export type BasicWatcher = {
+    on(event: string, callback: (event: string, path: string) => void): void;
+};
+/**
+ * @typedef {{
+ *   on(event: string, callback: (event: string, path: string) => void): void
+ * }} BasicWatcher
+ */
 /**
  * Start a new filesystem watcher to discover and monitor messages files, allowing consumers to
  * react to changes in a single, consistent way.
@@ -9,30 +17,26 @@
  *  persistent?: boolean,
  *  once?: boolean,
  * }} options
- * @returns {Promise<{
- *   on(event: string, callback: (event: string, path: string) => void): void
- * }>}
+ * @returns {Promise<BasicWatcher>}
  */
 export function watchMessagesFiles(watchedFolders: string[], { ignore, skipInitial, once }?: {
     ignore?: string[];
     skipInitial?: boolean;
     persistent?: boolean;
     once?: boolean;
-}): Promise<{
-    on(event: string, callback: (event: string, path: string) => void): void;
-}>;
+}): Promise<BasicWatcher>;
 /**
  * Watch the file system for changes to message _definitions_ files, and pre-process them into
  * compiled assets (with the extension `.compiled.messages.${assetExtension}`).
  *
- * @param {chokidar.FSWatcher} watcher
+ * @param {BasicWatcher} watcher
  * @param {{
  *  ignore?: string[],
  *  assetExtension?: string
  *  precompileOptions?: import('./processing').IntlPrecompileOptions,
  * }} options
  */
-export function precompileMessageDefinitionsFiles(watcher: chokidar.FSWatcher, { assetExtension, precompileOptions }?: {
+export function precompileMessageDefinitionsFiles(watcher: BasicWatcher, { assetExtension, precompileOptions }?: {
     ignore?: string[];
     assetExtension?: string;
     precompileOptions?: import("./processing").IntlPrecompileOptions;
@@ -40,13 +44,12 @@ export function precompileMessageDefinitionsFiles(watcher: chokidar.FSWatcher, {
 /**
  * Watch the file system for any changes to message files and regenerate their types.
  *
- * @param {chokidar.FSWatcher} watcher
+ * @param {BasicWatcher} watcher
  * @param {{
  *  allowNullability?: boolean
  * }} options
  */
-export function generateMessageTypes(watcher: chokidar.FSWatcher, { allowNullability }: {
+export function generateMessageTypes(watcher: BasicWatcher, { allowNullability }: {
     allowNullability?: boolean;
 }): Promise<void>;
 export const ALWAYS_IGNORE_PATTERNS: string[];
-import chokidar = require("chokidar");