From f429af4ec9b8fe1de8a32bd9fb6ad53085c7d7d1 Mon Sep 17 00:00:00 2001
From: Rohith Ramakrishnan <6977429+MadaraUchiha-314@users.noreply.github.com>
Date: Tue, 25 Jun 2024 17:56:55 -0700
Subject: [PATCH] chore: add comments to example (#60)

---
 packages/examples/project-a/src/index.js | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/packages/examples/project-a/src/index.js b/packages/examples/project-a/src/index.js
index 196d6ad..ddc0b5b 100644
--- a/packages/examples/project-a/src/index.js
+++ b/packages/examples/project-a/src/index.js
@@ -1,13 +1,18 @@
+/* eslint-disable import/no-unresolved */
+/* 'react' is shared and declared as eager. Hence it will be bundled as part of the remote entry. */
 import React, { Component, useMemo } from 'react';
+/* 'uuid' is shared. */
 import { v4 as uuidv4 } from 'uuid';
 
-/* eslint-disable-next-line import/no-unresolved */
+/* project-b is another federated remote. button is an exposed module from that federated remote */
 import Button, { someThingElse } from 'project-b/button';
-/* eslint-disable-next-line import/no-unresolved */
+/* project-b is another federated remote. link is an exposed module from that federated remote */
 import Link, { someThingDifferent } from 'project-b/link';
 
+/* Import from a local file. */
 import { ABC } from './abc.js';
 
+/* 'redux' is shared. Example shows that "export" syntax also works */
 export { createStore, compose } from 'redux';
 export { applyMiddleware as kindlyApplyMiddleware } from 'redux';
 
@@ -18,11 +23,13 @@ export async function doSomething() {
   console.log('React version is: ', React.version);
   console.log('typeof React.Component is: ', typeof Component);
   console.log(useMemo);
+  /* 'react-dom' is shared. */
   const ReactDOM = await import('react-dom');
 
   console.log('ReactDOM version is: ', ReactDOM.version);
   console.log('A random uuid for you: ', uuidv4());
   console.log('ABC = ', ABC);
+  /* './pqr' is an exposed module of this container */
   const { PQR } = await import('./pqr.js');
   console.log('PQR = ', PQR);
 
@@ -46,3 +53,5 @@ export async function doSomething() {
 }
 
 /* eslint-enable no-console */
+/* eslint-disable import/no-unresolved */
+