webpack-federation-types-plugin 1.0.1 → 1.2.0

package/FederationTypesPlugin.js

@@ -3,6 +3,7 @@ const ts = require("typescript")
 const axios = require("axios")
 const fs = require("fs-extra")
 const path = require("path")
+const ms = require("ms")
 
 const PLUGIN_NAME = "FederationTypesPlugin"
 const MF_TYPES_DIR = "federation-types"
@@ -17,7 +18,7 @@ const tscOptions = {
 const optionsSchema = {
   type: "object",
   properties: {
-    ignoreRemotes: {
+    excludeRemotes: {
       type: "array",
     },
     exposeTypes: {
@@ -26,6 +27,9 @@ const optionsSchema = {
     importTypes: {
       type: "boolean",
     },
+    getTypesInterval: {
+      type: "string",
+    },
   },
 }
 
@@ -48,6 +52,7 @@ class FederationTypesPlugin {
    * @param {import("webpack").Compiler} compiler
    */
   apply(compiler) {
+    let getTypesInterval
     const federationPlugin =
       compiler.options.plugins && compiler.options.plugins.find((plugin) => plugin.constructor.name === "ModuleFederationPlugin")
     if (!federationPlugin) throw new Error("No ModuleFederationPlugin found.")
@@ -109,8 +114,8 @@ class FederationTypesPlugin {
       const remotes = federationPlugin._options.remotes
       if (!remotes) return
 
-      const ignoreRemotes = this._options.ignoreRemotes || []
-      const wantedRemotes = Object.entries(remotes).filter((remote) => ignoreRemotes.find((c) => c !== remote[0]))
+      const excludeRemotes = this._options.excludeRemotes || []
+      const wantedRemotes = Object.entries(remotes).filter((remote) => !excludeRemotes.find((c) => c === remote[0]))
 
       for (const [remoteName, remoteEntryUri] of wantedRemotes) {
         const {origin, pathname} = new URL(remoteEntryUri.split("@")[1])
@@ -164,7 +169,10 @@ class FederationTypesPlugin {
         if (pluginOptions.exposeTypes !== false) createTypesDefinitions(compilation)
         if (compilation.options.mode === "development" && pluginOptions.importTypes !== false) {
           getTypesDefinitions()
-          // TODO - call getTypesDefinitions using setInterval
+          if (pluginOptions.getTypesInterval) {
+            clearInterval(getTypesInterval)
+            getTypesInterval = setInterval(() => getTypesDefinitions(compilation), ms(pluginOptions.getTypesInterval))
+          }
         }
       })
     })

package/README.md

@@ -17,7 +17,7 @@ const FederationTypesPlugin = require("webpack-federation-types-plugin")
 
 module.exports = {
   // ...
-  plugins: [new FederationTypesPlugin({ignoreRemotes: ["remoteName"], importTypes: true, exposeTypes: true})],
+  plugins: [new FederationTypesPlugin({excludeRemotes: ["remoteName"], importTypes: true, exposeTypes: true})],
 }
 ```
 
@@ -36,9 +36,15 @@ Type: boolean
 Default: true
 Description: fetch the remotes declaration files and add them to the @types directory
 
-##### ignoreRemotes
+##### excludeRemotes
 
 Type: string[]
 Default: undefined
 Description: remotes to ignore
 
+##### getTypesInterval
+
+Type: string
+Default: undefined
+Description: the interval between types requests
+Example: "5 minutes", "30 seconds"

package/TODO

@@ -0,0 +1,5 @@
+cts\wedding\node_modules\@types\appJAMain\getJAData.d.ts'
+(Use `node --trace-warnings ...` to show where the warning was created)
+(node:10492) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 15)
+(node:10492) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
+

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "webpack-federation-types-plugin",
   "description": "This plugin adds type definitions for remote modules",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "main": "FederationTypesPlugin.js",
+  "types": "types.d.ts",
   "scripts": {
     "publish:patch": "npm version patch -m \"patch version - %s\" && npm publish",
     "publish:minor": "npm version minor -m \"minor version - %s\" && npm publish",
@@ -25,6 +26,7 @@
   "dependencies": {
     "axios": "^1.2.2",
     "fs-extra": "^11.1.0",
+    "ms": "^2.1.3",
     "schema-utils": "^4.0.0",
     "typescript": "^4.9.4"
   }

package/types.d.ts

@@ -0,0 +1,12 @@
+declare interface FederationTypesPluginOptions {
+  exposeTypes?: boolean
+  importTypes?: boolean
+  excludeRemotes?: string[]
+}
+
+declare class FederationTypesPlugin {
+  constructor(options?: FederationTypesPluginOptions)
+  apply(compiler: any): void
+}
+
+export default FederationTypesPlugin