@servicetitan/docs-uikit 27.3.0 → 28.0.0

package/docs/BREAKING_CHANGES.mdx

@@ -2,6 +2,12 @@
 title: BREAKING CHANGES
 ---
 
+## v28.0.0
+
+### [servicetitan/startup](./startup)
+
+-   Changed the default [moduleResolution](https://www.typescriptlang.org/tsconfig/#moduleResolution) from `node` to `bundler` to support importing from `@servicetitan/anvil2/token`. CommonJS packages that require the previous value must override `moduleResolution` in the package's `tsconfig.json`.
+
 ## v27.0.0
 
 ### [@servicetitan/startup](./startup)

package/docs/startup.mdx

@@ -30,19 +30,15 @@ Experimental flags don't follow semver. There might be breaking changes in minor
 
 Generates initial project structure. This command should be run via `npx` in an empty folder.
 
+```sh
+$ npx -y @servicetitan/startup@latest init
 ```
-npx -y @servicetitan/startup@latest init
-```
-
-#### Arguments
-
--   `--react17` - Generate a project that uses React 17.x instead of React 18.x
 
 ### install
 
 Installs the package dependencies. This command should be run via `npx` before the build.
 
-See [configuration example in the `init` template](https://github.com/servicetitan/uikit/blob/master/packages/startup/template/package.json)
+See [package.json in the example project](https://github.com/search?q=repo%3Aservicetitan%2Ffrontend-example+path%3A**%2Fpackage.json+%22startup+install%22&type=code).
 
 ### start
 
@@ -77,7 +73,7 @@ Runs all existing tests in all packages.
 To run tests a subset of tests is possible to pass paths to specific directories or test files as positional parameters.
 
 ```sh
-startup test -- packages/desktop/app/modules/inventory/
+$ npx startup test -- packages/desktop/app/modules/inventory/
 ```
 
 ### lint
@@ -87,14 +83,14 @@ Runs ESLint and Stylelint for all codebase projects.
 To run ESLint and Stylelint on certain packages or subsystems it is possible to pass paths to specific directories as positional parameters.
 
 ```sh
-startup lint -- packages/desktop/app/modules/inventory/
+$ npx startup lint -- packages/desktop/app/modules/inventory/
 ```
 
 You can use multiple paths and your shell expressions which expand to directories.
 
 ```sh
-startup lint -- packages/desktop/app/modules/lead/ packages/desktop/app/modules/inventory/
-startup lint -- packages/desktop/app/modules/{lead,inventory}/
+$ npx startup lint -- packages/desktop/app/modules/lead/ packages/desktop/app/modules/inventory/
+$ npx startup lint -- packages/desktop/app/modules/{lead,inventory}/
 ```
 
 #### Arguments
@@ -120,8 +116,7 @@ This is an umbrella command for both unpublishing (cleaning up, `mfe-package-cle
 -   `--dry` - Invoke [npm publish --dry-run](https://docs.npmjs.com/cli/v7/commands/npm-publish#dry-run) instead of actually publishing anything.
 -   `--branch <string>` - Optional branch name. The current branch name is used if no value is specified. The branch name is used in constructing the build version in case `--build` is not specified.
 -   `--force` - Attempts to force publish the package in case no branch configuration is found for the specified branch (`--branch` or current branch).
--   `--tag <string> | false` - If the value is `false` the package will be published without a custom [tag](https://docs.npmjs.com/cli/v7/commands/npm-publish#tag) (meaning it will be published with the default `latest` tag). If another value is specified it will be used as the tag name otherwise the tag value will be mapped from [following object](https://github.com/servicetitan/uikit/blob/master/packages/startup/src/cli/commands/mfe-publish.ts#L311-L316). For example, in case of branch name `master` the package will be published with the `prod` tag, etc.
--   `--noTag <string>` - This argument is currently not used.
+-   `--tag <string> | false` - If the value is `false` the package will be published without a custom [tag](https://docs.npmjs.com/cli/v7/commands/npm-publish#tag) (meaning it will be published with the default `latest` tag). If another value is specified it will be used as the tag name otherwise the tag value will be mapped from [following object](https://github.com/servicetitan/uikit/blob/master/packages/startup/src/cli/commands/get-branch-configs.ts#L3). For example, in case of branch name `master` the package will be published with the `prod` tag, etc.
 
 #### Other auxiliary mfe-publish commands
 
@@ -368,6 +363,8 @@ Use `webpack.devServer` to set or override `webpack-dev-server` options. E.g.,
 }
 ```
 
+`webpack.devServer` can also be set to `false` in order to disable `webpack-dev-server` altogether.
+
 #### Webpack Configuration
 
 If you need to add additional rules or change the build output path or make any other customization of the Webpack configuration, you should create `webpack.{env}.config.js` files in the package's root folder. These files should call `createWebpackConfig` with the required configuration.

package/docs/web-components.mdx

@@ -41,7 +41,7 @@ export const Foo: React.FC = () => {
 | `loadingFallbackDelayed` | controls whether to render the loading fallback immediately, or after a short delay [(see below)](#fallback-delay)                                  |
 | `errorFallback`          | optional JSX element to render when the MFE fails to load                                                                                           |
 | `className`              | additional CSS classes for the MFE web component element                                                                                            |
-| `cache`                  | optional cache strategy for the MFE [(see below)](#cache)                                                                                           |
+| `cache`                  | optional cache strategy for the MFE [(see below)](#cache-strategy)                                                                                  |
 
 #### Loading fallback delay {#fallback-delay}
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicetitan/docs-uikit",
-    "version": "27.3.0",
+    "version": "28.0.0",
     "description": "",
     "repository": {
         "type": "git",
@@ -16,5 +16,5 @@
     "cli": {
         "webpack": false
     },
-    "gitHead": "692cebef0a151c37135dabd851dbe50de7b99ea6"
+    "gitHead": "7b905cd6ecfd5bb4a748050a83ebd8ca4e185e09"
 }