@servicetitan/docs-uikit 32.0.1 → 32.1.0

package/docs/startup/review.mdx

@@ -43,6 +43,11 @@ npx startup review
 
 ## Options
 
+| Option              | Description                                           |
+| :------------------ | :---------------------------------------------------- |
+| [`--fix`](#--fix)   | Automatically fix problems detected by enabled rules. |
+| [`--rule`](#--rule) | Limit checks to one or more rules.                    |
+
 ### --fix
 
 You can run `startup review` with the `--fix` flag to automatically fix certain problems detected by enabled rules.
@@ -140,6 +145,132 @@ And, this configuration requires all libraries except `utils` to have explicit `
 
 ## Rules
 
+### no-deprecated-content-base
+
+Detects use of the deprecated `contentBase` `webpack-dev-server` option.
+
+Previously, `contentBase` was used to specify the directory from which `webpack-dev-server` should serve static files. It was removed in `webpack-dev-server@4.0.0` and replaced with the `static` option.
+
+#### ✅ Autofix
+
+This rule supports autofix.
+It migrates `cli.webpack.contentBase` to `cli.webpack.static.directory`.
+For example, given:
+
+```json title="packages/app/package.json"
+{
+    "cli": {
+        "webpack": {
+            "contentBase": "src/public"
+        }
+    }
+}
+```
+
+It runs:
+
+```sh
+npm pkg set cli.webpack.static.directory="src/public" -w packages/app
+npm pkg delete cli.webpack.contentBase -w packages/app
+```
+
+---
+
+### no-direct-peer-dependencies
+
+Detects when a package is listed as both a direct dependency and a peer dependency.
+
+Packages should declare a peer dependency when they expect the consumer to provide it; listing the same package as a direct dependency defeats that contract and can cause duplication and version conflicts.
+
+#### ✅ Autofix
+
+This rule supports autofix.
+It moves the peer package from `dependencies` to `devDependencies`.
+For example, given
+
+```json title="packages/lib/package.json"
+{
+    "dependencies": {
+        "react": "^18.3.1"
+    },
+    "peerDependencies": {
+        "react": ">=17"
+    }
+}
+```
+
+It runs
+
+```sh
+npm pkg set devDependencies["react"]="^18.3.1" -w packages/lib
+npm pkg delete dependencies["react"] -w packages/lib
+
+```
+
+---
+
+### prefer-open-ended-peer-dependencies
+
+Enforces open‑ended peer dependency ranges so consumers can choose compatible versions.
+
+Closed‑ended ranges like `^1.2.3` or `~1.2.3` are discouraged for peer dependencies because they limit consumers' ability to resolve a single compatible version across a workspace. Closed-ended ranges should only be used when there is a known incompatibility with a later version.
+
+#### ✅ Autofix
+
+The rule supports autofix.
+It converts simple closed-ended ranges, using tilde (`~`) or caret (`^`), to an open-ended `>=` range that preserves the original minimum version. For example,
+
+- `^12.3.0` → `>=12.3.0`
+- `~1.2.3` → `>=1.2.3`
+
+For example, given
+
+```json title="packages/lib/package.json"
+{
+    "peerDependencies": {
+        "react": "^18.3.1"
+    }
+}
+```
+
+It runs
+
+```sh
+npm pkg set peerDependencies["react"]=">=18.3.1" -w packages/lib
+```
+
+:::caution
+Complex ranges that cannot be expressed as a single open‑ended minimum are not auto‑fixable and must be fixed manually. Examples:
+
+- `<1`
+- `^1 || ^2`
+- `>1 <2`
+- `1.0 - 2.0`
+
+:::
+
+#### ⚙️ Configuration
+
+This rule supports an extended `exclude` configuration that allows you to omit specific dependencies from the check. The `exclude` option can be an object that maps packages to a list of peer dependencies.
+
+For example, this configuration allows `@servicetitan/hash-browser-router` to use closed-ended peer dependencies for `history` and `react-router-dom`.
+
+```json
+"prefer-open-ended-peer-dependencies": [
+    "warn",
+    {
+        "exclude": {
+            "@servicetitan/hash-browser-router": [
+                "history",
+                "react-router-dom"
+            ],
+        }
+    }
+]
+```
+
+---
+
 ### no-typescript-entry-point
 
 Ensures that no package uses a TypeScript file as its main entry point or in its `exports`.
@@ -218,6 +349,18 @@ npm pkg set dependencies["react-dom"]="^18.3.1"
 
 ---
 
+### require-compatible-launch-darkly-sdk
+
+Ensures that any package depending on `@servicetitan/launchdarkly-service` uses a compatible version of `launchdarkly-js-client-sdk`.
+
+Using an incompatible version of `launchdarkly-js-client-sdk` prevents `@servicetitan/launchdarkly-service` from sharing and reusing client connections, which can degrade performance and cause the UI to behave inconsistently. It also harms performance to teardown and recreate connections each time an MFE is unloaded and reloaded.
+
+#### ✅ Autofix
+
+This rule supports autofix. It updates dependencies on `launchdarkly-js-client-sdk` to match `@servicetitan/launchdarkly-service`.
+
+---
+
 ### require-explicit-side-effects
 
 Warns if a package is missing the `sideEffects` property in its `package.json`.

package/docs/startup/test.mdx

@@ -146,21 +146,21 @@ Or override it per invocation with the `--runner` option.
 The Vitest runner uses a layered configuration approach to provide sensible defaults while allowing full customization.
 
 - Uses the default, built-in configuration as a base.
-- Applies workspace overrides from `package.json`.
-- Applies overrides from your Vitest config file.
-- Applies command line options last.
+- Merges workspace settings from `package.json`.
+- Merges settings from your Vitest config file.
+- Merges command line options last.
 
 1. **Default Configuration:**  
    The runner starts with a built-in default configuration optimized for ServiceTitan workspaces. This includes sensible coverage settings, the environment (`jsdom`), file exclusions, and more.
 
 2. **Workspace Configuration:**  
-   You can override defaults by specifying [Vitest options](https://vitest.dev/config) in your workspace `package.json` under the `"cli.vitest"` key.
+   You can customize the configuration by specifying [Vitest options](https://vitest.dev/config) in your workspace `package.json` under the `"cli.vitest"` key.
 
 3. **Vitest Config File:**  
-   If your project includes a standard Vitest config file (such as `vitest.config.ts` or `vite.config.ts`), its settings will override both the defaults and workspace configuration.
+   If your project includes a standard Vitest config file (such as `vitest.config.ts` or `vite.config.ts`), its settings will merged with the defaults and workspace configuration.
 
 4. **Command Line Arguments:**  
-   Any options passed directly via the command line (e.g., `npx startup test --runner vitest --coverage`) take highest precedence and override all previous configuration layers.
+   Any options passed directly via the command line (e.g., `npx startup test --runner vitest --coverage`) take highest precedence over previous configuration layers.
 
 ### Examples
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "32.0.1",
+    "version": "32.1.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "2b74dd72d39c2023151699d1cf7a6e6130d64279"
+    "gitHead": "5686f75473bd25104356c3fc6e7c8ffe478ca125"
 }