docs(nf): remarks for the postinstall script

Author: manfredsteyer

libs/native-federation/README.md

@@ -26,6 +26,12 @@ We will at least provide a new version of this package per Angular major. If nec
 - Use version 17.1.x for Angular 17.1+
 - Use version 18.x for Angular 18+
 
+## Updates
+
+You can use ng update for updating Native Federation.
+
+Notes for [updating to version 18](https://github.com/angular-architects/module-federation-plugin/blob/main/libs/native-federation/docs/update18.md)
+
 ## Angular Integration
 
 Since 17.1, Native Federation for Angular uses the Angular CLI's `esbuild`-based **Application Builder** and the CLI's **Dev Server** to keep track with all the innovations and performance-improvements in that space.

libs/native-federation/docs/update18.md

@@ -1,10 +1,10 @@
 # Update to Native Federation for Angular 18
 
-The package ``@angular-architects/native-federation`` version 18 was successfully tested with Angular 18.
+The package `@angular-architects/native-federation` version 18 was successfully tested with Angular 18.
 
 ## Option 1
 
-Just use ``ng update``:
+Just use `ng update`:
 
 ```
 ng update @angular-architects/native-federation
@@ -18,7 +18,7 @@ Use npm install:
 npm i @angular-architects/native-federation@^18
 ```
 
-Make sure you have the following ``postinstall`` script in your ``package.json``:
+Make sure you have the following `postinstall` script in your `package.json`:
 
 ```json
 "scripts": {
@@ -27,8 +27,10 @@ Make sure you have the following ``postinstall`` script in your ``package.json``
 },
 ```
 
-Run the ``postinstall`` script once manually for initialization:
+**Remarks:** This script is just a temporary solution. It won't be necessary in future versions.
+
+Run the `postinstall` script once manually for initialization:
 
 ```
 npm run postinstall
-```
+```

libs/native-federation/src/builders/build/builder.ts

@@ -11,12 +11,13 @@ import {
   createBuilder,
 } from '@angular-devkit/architect';
 
-import { buildApplication, buildApplicationInternal } from '@angular/build/src/builders/application';
+import {
+  buildApplication,
+  buildApplicationInternal,
+} from '@angular/build/src/builders/application';
 import { serveWithVite } from '@angular/build/src/builders/dev-server/vite-server';
 
-import {
-  DevServerBuilderOptions,
-} from '@angular-devkit/build-angular';
+import { DevServerBuilderOptions } from '@angular-devkit/build-angular';
 import { normalizeOptions } from '@angular-devkit/build-angular/src/builders/dev-server/options';
 
 import { setLogLevel, logger } from '@softarc/native-federation/build';
@@ -59,11 +60,15 @@ function _buildApplication(options, context, pluginsOrExtensions) {
     extensions = {
       codePlugins: pluginsOrExtensions,
     };
-  }
-  else {
+  } else {
     extensions = pluginsOrExtensions;
   }
-  return buildApplicationInternal(options, context, { write: false }, extensions);
+  return buildApplicationInternal(
+    options,
+    context,
+    { write: false },
+    extensions
+  );
 }
 
 export async function* runBuilder(
@@ -235,18 +240,18 @@ export async function* runBuilder(
 
   const builderRun = nfOptions.dev
     ? serveWithVite(
-      normOuterOptions,
-      appBuilderName,
-      _buildApplication,
-      context,
-      nfOptions.skipHtmlTransform
-        ? {}
-        : { indexHtml: transformIndexHtml(nfOptions) },
-      {
-        buildPlugins: plugins,
-        middleware,
-      }
-    )
+        normOuterOptions,
+        appBuilderName,
+        _buildApplication,
+        context,
+        nfOptions.skipHtmlTransform
+          ? {}
+          : { indexHtml: transformIndexHtml(nfOptions) },
+        {
+          buildPlugins: plugins,
+          middleware,
+        }
+      )
     : buildApplication(options, context, plugins);
 
   // builderRun.output.subscribe(async (output) => {

libs/native-federation/src/schematics/init/schematic.ts

@@ -37,7 +37,8 @@ type NormalizedOptions = {
 export function updatePackageJson(tree: Tree): void {
   const packageJson = tree.readJson('package.json');
 
-  const scriptCall = 'node node_modules/@angular-architects/native-federation/src/patch-angular-build.js';
+  const scriptCall =
+    'node node_modules/@angular-architects/native-federation/src/patch-angular-build.js';
 
   if (!packageJson['scripts']) {
     packageJson['scripts'] = {};
@@ -57,7 +58,6 @@ export function updatePackageJson(tree: Tree): void {
   packageJson['scripts']['postinstall'] = postInstall;
 
   tree.overwrite('package.json', JSON.stringify(packageJson, null, 2));
-
 }
 
 export default function config(options: MfSchematicSchema): Rule {
@@ -117,9 +117,14 @@ export default function config(options: MfSchematicSchema): Rule {
 }
 
 export function patchAngularBuild(tree) {
-  const packageJson = JSON.parse(tree.read('node_modules/@angular/build/package.json'));
+  const packageJson = JSON.parse(
+    tree.read('node_modules/@angular/build/package.json')
+  );
   patchAngularBuildPackageJson(packageJson);
-  tree.overwrite('node_modules/@angular/build/package.json', JSON.stringify(packageJson, null, 2));
+  tree.overwrite(
+    'node_modules/@angular/build/package.json',
+    JSON.stringify(packageJson, null, 2)
+  );
 }
 
 function updateWorkspaceConfig(

libs/native-federation/src/schematics/update18/schema.json

@@ -3,6 +3,5 @@
   "$id": "mf",
   "title": "",
   "type": "object",
-  "properties": {
-  }
+  "properties": {}
 }

libs/native-federation/src/utils/patch-angular-build.ts

@@ -2,29 +2,32 @@ import * as path from 'path';
 import * as fs from 'fs';
 
 export function patchAngularBuildPackageJson(packageJson: unknown): void {
-    const exportsMap = packageJson['exports'];
+  const exportsMap = packageJson['exports'];
 
-    if (!exportsMap) {
-        console.log('No need to patch @angular/build/package.json')
-        return;
-    }
+  if (!exportsMap) {
+    console.log('No need to patch @angular/build/package.json');
+    return;
+  }
 
-    packageJson['_exports'] = exportsMap;
-    delete packageJson['exports'];
+  packageJson['_exports'] = exportsMap;
+  delete packageJson['exports'];
 
-    packageJson['types'] = './src/index.d.ts';
-    packageJson['main'] = './src/index.js';
-    packageJson['module'] = './src/index.js';
+  packageJson['types'] = './src/index.d.ts';
+  packageJson['main'] = './src/index.js';
+  packageJson['module'] = './src/index.js';
 }
 
 export function patchAngularBuild(workspaceRoot: string): void {
-    const packagePath = path.join(workspaceRoot, 'node_modules/@angular/build/package.json');
+  const packagePath = path.join(
+    workspaceRoot,
+    'node_modules/@angular/build/package.json'
+  );
 
-    const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf-8'));
+  const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf-8'));
 
-    patchAngularBuildPackageJson(packageJson);
+  patchAngularBuildPackageJson(packageJson);
 
-    fs.writeFileSync(packagePath, JSON.stringify(packageJson, null, 2));
+  fs.writeFileSync(packagePath, JSON.stringify(packageJson, null, 2));
 
-    console.log('@angular/build/package.json patched');
-}
+  console.log('@angular/build/package.json patched');
+}