+If you are having issues with the wepack configuration that are not related to module federation, refer to the @workleap/webpack-configs documentation.
If the application does not not include any remote modules, use the defineDevConfig function instead of defineDevHostConfig.
++If you are having issues with the wepack configuration that are not related to module federation, refer to the @workleap/webpack-configs documentation.
If the application does not not include any remote modules, use the defineBuildConfig function instead of defineBuildHostConfig.
+pnpm add -D @workleap/tsup-configs tsup typescript @types/react @types/react-dom
+pnpm add -D typescript @types/react @types/react-dom
pnpm add @squide/firefly react react-dom react-router-dom @tanstack/react-query
yarn add -D @workleap/tsup-configs tsup typescript @types/react @types/react-dom
+yarn add -D typescript @types/react @types/react-dom
yarn add @squide/firefly react @squide/firefly react-dom react-router-dom @tanstack/react-query
npm add -D @workleap/tsup-configs tsup typescript @types/react @types/react-dom
+npm add -D typescript @types/react @types/react-dom
npm install @squide/firefly react react-dom react-router-dom @tanstack/react-query
Then, ensure that you are developing your module using ESM syntax by specifying type: module in your package.json file:
{
"name": "@getting-started/local-module",
"version": "0.0.1",
- "exports": {
- ".": {
- "types": "./dist/register.d.ts",
- "import": "./dist/register.js",
- "default": "./dist/register.js"
- }
- }
+ "exports": "./src/register.tsx"
}+For more information about the
+exportsfield, refer to this resource on Just-In-Time Packages.
If you are having issues with the tsup configuration, refer to the @workleap/tsup-configs documentation.
-To configure tsup for a development environment, open the tsup.dev.ts file and copy/paste the following code:
import { defineDevConfig } from "@workleap/tsup-configs";
-
-export default defineDevConfig();To configure tsup for a build environment, open the tsup.build.ts file and copy/paste the following code:
import { defineBuildConfig } from "@workleap/tsup-configs";
-
-export default defineBuildConfig();To initiate the development server, add the following script to the application package.json file:
{
- "dev": "tsup --config ./tsup.dev.ts"
-}To build the module, add the following script to the application package.json file:
{
- "build": "tsup --config ./tsup.build.ts"
-}Start the host, remote-module and local-module applications in development mode using the dev script. You should notice an additional link labelled Local/Page in the navigation menu. Click on the link to navigate to the page of your new local module!
Start the host and remote-module applications in development mode using the dev script. You should notice an additional link labelled Local/Page in the navigation menu. Click on the link to navigate to the page of your new local module!
Then, install the package dependencies and configure the new package with tsup.
-Then, create an AppRouter component in the shell package to provide a reusable router configuration that can be shared between the host application and the isolated modules. This new AppRouter component should wrap the @squide/firefly AppRouter component:
Then, install the package dependencies and create an AppRouter component in the shell package to provide a reusable router configuration that can be shared between the host application and the isolated modules. This new AppRouter component should wrap the @squide/firefly AppRouter component:
import { AppRouter as FireflyAppRouter } from "@squide/firefly";
diff --git a/guides/fetch-global-data/index.html b/guides/fetch-global-data/index.html
index aa4c1e9e5..3e1eeba64 100644
--- a/guides/fetch-global-data/index.html
+++ b/guides/fetch-global-data/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/fetch-page-data/index.html b/guides/fetch-page-data/index.html
index bba41fe1f..48f43d7d4 100644
--- a/guides/fetch-page-data/index.html
+++ b/guides/fetch-page-data/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/implement-a-custom-logger/index.html b/guides/implement-a-custom-logger/index.html
index 28a8e3eef..8a60da501 100644
--- a/guides/implement-a-custom-logger/index.html
+++ b/guides/implement-a-custom-logger/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/index.html b/guides/index.html
index 4e892e49b..9faef4967 100644
--- a/guides/index.html
+++ b/guides/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,11 +32,11 @@
-
+
-
+
-
+
diff --git a/guides/isolate-module-failures/index.html b/guides/isolate-module-failures/index.html
index da0fbf55c..af06729ac 100644
--- a/guides/isolate-module-failures/index.html
+++ b/guides/isolate-module-failures/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/manage-shared-state/index.html b/guides/manage-shared-state/index.html
index 25917bb8a..f3a21f996 100644
--- a/guides/manage-shared-state/index.html
+++ b/guides/manage-shared-state/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,11 +32,11 @@
-
+
-
+
-
+
diff --git a/guides/override-a-react-context/index.html b/guides/override-a-react-context/index.html
index 182c501a1..6645710df 100644
--- a/guides/override-a-react-context/index.html
+++ b/guides/override-a-react-context/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/override-the-host-layout/index.html b/guides/override-the-host-layout/index.html
index 10a6d4aa9..eb616c727 100644
--- a/guides/override-the-host-layout/index.html
+++ b/guides/override-the-host-layout/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/setup-honeycomb/index.html b/guides/setup-honeycomb/index.html
index 0c85c51f6..5615305db 100644
--- a/guides/setup-honeycomb/index.html
+++ b/guides/setup-honeycomb/index.html
@@ -4,7 +4,7 @@
-
+
@@ -34,12 +34,12 @@
-
+
-
+
-
-
+
+
@@ -336,19 +336,19 @@
pnpm
-pnpm add @squide/firefly-honeycomb @honeycombio/opentelemetry-web @opentelemetry/api @opentelemetry/auto-instrumentations-web
+pnpm add @squide/firefly-honeycomb @honeycombio/opentelemetry-web @opentelemetry/api @opentelemetry/auto-instrumentations-web @opentelemetry/instrumentation-fetch @opentelemetry/sdk-trace-web
yarn
-yarn add @squide/firefly-honeycomb @honeycombio/opentelemetry-web @opentelemetry/api @opentelemetry/auto-instrumentations-web
+yarn add @squide/firefly-honeycomb @honeycombio/opentelemetry-web @opentelemetry/api @opentelemetry/auto-instrumentations-web @opentelemetry/instrumentation-fetch @opentelemetry/sdk-trace-web
npm
-npm install @squide/firefly-honeycomb @honeycombio/opentelemetry-web @opentelemetry/api @opentelemetry/auto-instrumentations-web
+npm install @squide/firefly-honeycomb @honeycombio/opentelemetry-web @opentelemetry/api @opentelemetry/auto-instrumentations-web @opentelemetry/instrumentation-fetch @opentelemetry/sdk-trace-web
diff --git a/guides/setup-i18next/index.html b/guides/setup-i18next/index.html
index dd9e9ba65..bec2b83e0 100644
--- a/guides/setup-i18next/index.html
+++ b/guides/setup-i18next/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/setup-msw/index.html b/guides/setup-msw/index.html
index 9955e8c45..daca131bd 100644
--- a/guides/setup-msw/index.html
+++ b/guides/setup-msw/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
diff --git a/guides/use-environment-variables/index.html b/guides/use-environment-variables/index.html
index 0b102bdc4..8af3bb579 100644
--- a/guides/use-environment-variables/index.html
+++ b/guides/use-environment-variables/index.html
@@ -4,7 +4,7 @@
-
+
@@ -32,12 +32,12 @@
-
+
-
+
-
-
+
+
@@ -483,6 +483,15 @@
"exclude": ["dist", "node_modules"]
}
If the project contains Typescript files at its root that need to be linted (such as tooling configuration files), consider including all project files instead of specific directories:
+{
+ "extends": "@workleap/typescript-configs/web-application.json",
+ "include": ["."],
+ "exclude": ["dist", "node_modules"]
+}