@servicetitan/docs-uikit 25.0.0 → 26.0.0

package/docs/startup.mdx

@@ -8,6 +8,24 @@ import { VersionHistory, Changes } from '@site/src/components/version-history';
 [@servicetitan/startup](https://github.com/servicetitan/uikit/tree/master/packages/startup) is a command-line interface (CLI) to create multi-package Lerna projects with the support of TypeScript Project References and React. It offers a modern build setup with no configuration.
 
 <VersionHistory>
+    <Changes forVersion="26.0.0">
+        <Admonition type="caution">
+            Upgraded <code>webpack-dev-server</code> from v3 to v5.
+            Version 5 introduces many breaking changes to the <code>webpack-dev-server</code> configuration.
+            For a complete list see the <a href="https://github.com/webpack/webpack-dev-server/blob/master/migration-v4.md">v4</a> and <a href="https://github.com/webpack/webpack-dev-server/blob/master/migration-v5.md">v5</a> migration guides.
+            Some common issues are:
+            <ul>
+            <li><strong>contentBase</strong> and <strong>watchContentBase</strong> were removed; use <strong>static</strong></li>
+            <li><strong>disableHostCheck</strong> was removed; use <code>allowedHosts: 'all'</code></li>
+            <li><strong>hotOnly</strong> was removed; use <code>hot: 'only'</code></li>
+            <li><strong>http2</strong> and <strong>https</strong> were removed; use <strong>server</strong></li>
+            <li><strong>injectClient</strong> and <strong>injectHot</strong> were removed in favor of manual setup entries</li>
+            <li><strong>inline</strong> was removed without replacement</li>
+            <li><strong>proxy</strong> only accepts an array</li>
+            <li><strong>publicPath</strong>, <strong>stats</strong> and <strong>writeToDisk</strong> were moved to <strong>devMiddleware</strong></li>
+            </ul>
+        </Admonition>
+    </Changes>
     <Changes forVersion="24.1.0">
         Changed <code>init</code> command to generate React 18 project by default
         and added <code>--react17</code> switch to generate React 17 project.
@@ -15,7 +33,7 @@ import { VersionHistory, Changes } from '@site/src/components/version-history';
     <Changes forVersion="24.0.0">
         <Admonition type="caution">
             <p>
-            Upgraded <code>Typescript</code> from version v4 to v5.
+            Upgraded <code>Typescript</code> from v4 to v5.
             Version 5 adds correctness improvements that will reveal
             previously undetected ambiguities. In particular,
             </p>
@@ -308,17 +326,33 @@ import CheckIcon from '@servicetitan/anvil2/assets/icons/material/round/check.sv
 
 ## Configuration Customization
 
-The zero-configuration approach is a good fit for most use cases, but sometimes applications may need to extend or override configuration.
+The zero-configuration approach is a good fit for most use cases, but sometimes applications need to extend or override configurations.
+Use the `cli` node in `package.json` to customize `startup` behavior.
 
-### Project Root
+### Project-wide settings
 
-#### `package.json` Configuration
+Use the `cli` node in the root `package.json` to customize project-wide settings.
 
-Sometimes you may need to change the configuration of project-wide tools, e.g., extend the ESLint configuration. For these purposes, we support the `cli` node in the root `package.json` file with the following options:
+#### Jest
+
+Use `test` to set or override Jest options. E.g.,
+
+```json title="package.json"
+{
+    "cli": {
+        "test": {
+            // Jest options (https://jestjs.io/docs/next/configuration)
+        }
+    }
+}
+```
+
+#### Linting
+
+Use `lint` to set or override `ESLint` and `Stylelint` options. E.g,
 
 ```json title="package.json"
 {
-    ...
     "cli": {
         "lint": {
             "eslint": {
@@ -327,85 +361,94 @@ Sometimes you may need to change the configuration of project-wide tools, e.g.,
             "stylelint": {
                 // Stylelint options (https://stylelint.io/user-guide/configure)
             }
-        },
-        "test": {
-            // Jest options (https://jestjs.io/docs/next/configuration)
         }
     }
-    ...
 }
 ```
 
 #### NODE_OPTIONS
 
-To set or override Node options for startup commands, add **NODE_OPTIONS** to the `cli` node in the root `package.json`. Note, startup already runs all commands with `--max_old_space_size=8192` by default.
+Use `NODE_OPTIONS` to set or override Node options for some or all commands. E.g.,
+
+:::info
+Note, `startup` runs all commands with `--max_old_space_size=8192` by default.
+:::
 
 ```json title="package.json"
 {
-    ...
     "cli": {
-        // NODE_OPTIONS for all commands. E.g.,
-        "NODE_OPTIONS": [
-            "--max_old_space_size=4096"
-        ],
+        "NODE_OPTIONS": ["--max_old_space_size=4096"], // NODE_OPTIONS for all commands
         "lint": {
-            // NODE_OPTIONS for lint command only
+            "NODE_OPTIONS": [
+                /* NODE_OPTIONS for lint command */
+            ]
         },
         "test": {
-            // NODE_OPTIONS for test command only
+            "NODE_OPTIONS": [
+                /* NODE_OPTIONS for test command */
+            ]
         }
     }
-    ...
 }
 ```
 
-### Package
-
-#### `package.json` Configuration
+### Package-specific settings
 
-[@servicetitan/startup](https://github.com/servicetitan/uikit/tree/master/packages/startup) supports different build behaviors for packages. You may change it through the `cli` node in the package's `package.json` file. By default, it applies the regular Webpack bundling.
+To customize the settings for a specific package, use the `cli` node in its `package.jon`.
 
 ##### Non-application packages
 
-A project can contain supporting packages such as shared components, utilities, etc. It's recommended to disable the Webpack bundle for them.
+Set `webpack` to `false` to disable Webpack bundling for non-application NPM packages, such as component and utility libraries. E.g.,
 
 ```json title="package.json"
 {
-    ...
     "cli": {
         "webpack": false
     }
-    ...
 }
 ```
 
-##### Microfrontends
+##### Microfrontends (MFEs)
 
-You can find detailed information [here](/docs/frontend/micro-frontends).
+Set `web-component` to `true` to create the support files and `light` and `full` bundles for MFE applications. E.g.,
 
 ```json title="package.json"
 {
-    ...
     "cli": {
         "web-component": true
     }
-    ...
 }
 ```
 
+See [MFE configuration](/docs/frontend/micro-frontends/#mfe-configuration) for detailed instructions on configuring MFE applications.
+
 ##### Application Port
 
-Sometimes you may need to have a fixed port for the started application.
+Use `port` to set the port that `webpack-dev-server` uses for the application. E.g.,
 
 ```json title="package.json"
 {
-    ...
     "cli": {
         "webpack": {
             "port": 8888
         }
     }
-    ...
+}
+```
+
+#### webpack-dev-server
+
+Use `webpack.devServer` to set or override `webpack-dev-server` options. E.g.,
+
+```json title="package.json"
+{
+    "cli": {
+        "webpack": {
+            "devServer": {
+                // webpack-dev-server options (https://webpack.js.org/configuration/dev-server/#devserver)
+            }
+        }
+    }
 }
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "25.0.0",
+    "version": "26.0.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "db04847b5e4d8f0e679ce6c6f561aab10ade927d"
+    "gitHead": "c19b559c2183cbd7f74814b7b913f3343270756a"
 }