webpack-federation-types-plugin 1.0.0 → 1.1.0

package/FederationTypesPlugin.js

@@ -1,4 +1,4 @@
-const validate = require("schema-utils")
+const validate = require("schema-utils").validate
 const ts = require("typescript")
 const axios = require("axios")
 const fs = require("fs-extra")
@@ -17,7 +17,7 @@ const tscOptions = {
 const optionsSchema = {
   type: "object",
   properties: {
-    ignoreRemotes: {
+    excludeRemotes: {
       type: "array",
     },
     exposeTypes: {
@@ -39,7 +39,7 @@ const getAssetData = (content) => {
 }
 
 class FederationTypesPlugin {
-  constructor(options) {
+  constructor(options = {}) {
     validate(optionsSchema, options)
     this._options = options
   }
@@ -109,8 +109,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])
@@ -159,9 +159,10 @@ class FederationTypesPlugin {
     }
 
     compiler.hooks.compilation.tap(PLUGIN_NAME, (compilation) => {
+      const pluginOptions = this._options || {}
       compilation.hooks.beforeCodeGeneration.tap(PLUGIN_NAME, () => {
-        if (this._options.exposeTypes !== false) createTypesDefinitions(compilation)
-        if (compilation.options.mode === "development" && this._options.importTypes !== false) {
+        if (pluginOptions.exposeTypes !== false) createTypesDefinitions(compilation)
+        if (compilation.options.mode === "development" && pluginOptions.importTypes !== false) {
           getTypesDefinitions()
           // TODO - call getTypesDefinitions using setInterval
         }

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,7 +36,7 @@ Type: boolean
 Default: true
 Description: fetch the remotes declaration files and add them to the @types directory
 
-##### ignoreRemotes
+##### excludeRemotes
 
 Type: string[]
 Default: undefined

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "webpack-federation-types-plugin",
   "description": "This plugin adds type definitions for remote modules",
-  "version": "1.0.0",
+  "version": "1.1.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",

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