@elliemae/pui-cli 9.0.0-alpha.11 → 9.0.0-alpha.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/build/docs/404.html +4 -4
- package/build/docs/api/functions/loadRoutes/index.html +9 -9
- package/build/docs/api/index.html +8 -8
- package/build/docs/api/type-aliases/LIB_NAME/index.html +5 -5
- package/build/docs/api/variables/babelConfig/index.html +5 -28
- package/build/docs/api/variables/commitlintConfig/index.html +5 -8
- package/build/docs/api/variables/eslintFlatBaseConfig/index.html +6 -6
- package/build/docs/api/variables/eslintFlatBaseConfigStrict/index.html +6 -6
- package/build/docs/api/variables/eslintFlatConfig/index.html +6 -6
- package/build/docs/api/variables/eslintFlatConfigStrict/index.html +6 -6
- package/build/docs/api/variables/jestConfig/index.html +86 -86
- package/build/docs/api/variables/jestNodeConfig/index.html +86 -86
- package/build/docs/api/variables/lintStagedConfig/index.html +22 -12
- package/build/docs/api/variables/prettierConfig/index.html +5 -18
- package/build/docs/api/variables/stylelintConfig/index.html +5 -5
- package/build/docs/api/variables/vitestConfig/index.html +5 -5
- package/build/docs/assets/css/{styles.74603f39.css → styles.3cba4e67.css} +1 -1
- package/build/docs/assets/js/04ee7372.c6c3d513.js +1 -0
- package/build/docs/assets/js/0551d4dd.a6b1d9fa.js +1 -0
- package/build/docs/assets/js/0a1d0315.43980061.js +1 -0
- package/build/docs/assets/js/13097d8d.4ac8ef79.js +1 -0
- package/build/docs/assets/js/{16b7bc88.c3779e27.js → 16b7bc88.2ac57556.js} +1 -1
- package/build/docs/assets/js/{17896441.84339068.js → 17896441.705d85a0.js} +1 -1
- package/build/docs/assets/js/{1b9df811.aaa95da1.js → 1b9df811.ec75cfdc.js} +1 -1
- package/build/docs/assets/js/{232a0286.33b2782b.js → 232a0286.6f749ae5.js} +1 -1
- package/build/docs/assets/js/{2399.cc5803e0.js → 2399.5d123cba.js} +1 -1
- package/build/docs/assets/js/{37d86055.47211796.js → 37d86055.1e73f036.js} +1 -1
- package/build/docs/assets/js/3992.b9b54f94.js +2 -0
- package/build/docs/assets/js/4fb6949f.13bde4a8.js +1 -0
- package/build/docs/assets/js/5befad71.96f04f67.js +1 -0
- package/build/docs/assets/js/5d5f1db0.e7607cd2.js +1 -0
- package/build/docs/assets/js/5e8c322a.0b86bf5a.js +1 -0
- package/build/docs/assets/js/5e95c892.de377e27.js +1 -0
- package/build/docs/assets/js/{5fb3c522.da5628e8.js → 5fb3c522.3ec831ee.js} +1 -1
- package/build/docs/assets/js/6bd11e52.c61bfcd5.js +1 -0
- package/build/docs/assets/js/6e96545e.1b545333.js +1 -0
- package/build/docs/assets/js/{71f6d02b.cfd98385.js → 71f6d02b.4b381360.js} +1 -1
- package/build/docs/assets/js/{6704.2615a5c6.js → 7843.f4b19776.js} +1 -1
- package/build/docs/assets/js/80e87108.8c451f49.js +1 -0
- package/build/docs/assets/js/{8585.3cb09ff7.js → 8585.e2298db3.js} +1 -1
- package/build/docs/assets/js/{a7bd4aaa.30ffad02.js → a7bd4aaa.aceac89c.js} +1 -1
- package/build/docs/assets/js/a94703ab.248144c2.js +1 -0
- package/build/docs/assets/js/b7b585d8.7d50f3f6.js +1 -0
- package/build/docs/assets/js/{bde5209a.f5bca8b2.js → bde5209a.480cc8d8.js} +1 -1
- package/build/docs/assets/js/c377a04b.c6b6b394.js +1 -0
- package/build/docs/assets/js/{dfd75424.51c4e2cb.js → dfd75424.459da76b.js} +1 -1
- package/build/docs/assets/js/f736c962.ab424879.js +1 -0
- package/build/docs/assets/js/main.3ae939d4.js +2 -0
- package/build/docs/assets/js/runtime~main.9ecf1839.js +1 -0
- package/build/docs/eslint-rules-migration/index.html +43 -43
- package/build/docs/index.html +70 -71
- package/build/docs/pui-cli-9-migration/index.html +191 -70
- package/build/docs/sitemap.xml +1 -1
- package/build/docs/ssl-certificate-setup/index.html +23 -23
- package/build/docs/stylelint-migration/index.html +19 -21
- package/build/docs/usage-guide/index.html +91 -91
- package/dist/cjs/babel.config.js +124 -0
- package/dist/cjs/commands/storybook.js +33 -4
- package/dist/cjs/index.js +5 -9
- package/dist/cjs/lint-config/commitlint/export.mjs +1 -0
- package/dist/cjs/lint-config/commitlint.config.mjs +6 -0
- package/dist/cjs/lint-config/eslint/common.cjs +8 -1
- package/dist/cjs/lint-config/eslint/flat/compat.mjs +5 -5
- package/dist/cjs/lint-config/eslint/flat/rules.mjs +1 -0
- package/dist/cjs/lint-config/lint-staged.config.js +17 -5
- package/dist/cjs/lint-config/prettier/export.mjs +1 -0
- package/dist/cjs/lint-config/{prettier.config.cjs → prettier.config.mjs} +4 -1
- package/dist/cjs/skills/migrate-storybook-out-of-cjs/SKILL.md +242 -0
- package/dist/cjs/skills/migrate-to-pui-cli-9/SKILL.md +188 -25
- package/dist/cjs/testing/{jest.config.cjs → jest.config.mjs} +14 -6
- package/dist/{esm/testing/jest.node.config.cjs → cjs/testing/jest.node.config.mjs} +3 -2
- package/dist/cjs/testing/setup-textencoder.cjs +4 -0
- package/dist/cjs/webpack/webpack.storybook.js +62 -0
- package/dist/esm/babel.config.js +94 -0
- package/dist/esm/commands/storybook.js +22 -4
- package/dist/esm/index.js +5 -9
- package/dist/esm/lint-config/commitlint/export.mjs +1 -0
- package/dist/esm/lint-config/commitlint.config.mjs +6 -0
- package/dist/esm/lint-config/eslint/common.cjs +8 -1
- package/dist/esm/lint-config/eslint/flat/compat.mjs +5 -5
- package/dist/esm/lint-config/eslint/flat/rules.mjs +1 -0
- package/dist/esm/lint-config/lint-staged.config.js +17 -5
- package/dist/esm/lint-config/prettier/export.mjs +1 -0
- package/{lib/lint-config/prettier.config.cjs → dist/esm/lint-config/prettier.config.mjs} +4 -1
- package/dist/esm/skills/migrate-storybook-out-of-cjs/SKILL.md +242 -0
- package/dist/esm/skills/migrate-to-pui-cli-9/SKILL.md +188 -25
- package/dist/esm/testing/{jest.config.cjs → jest.config.mjs} +14 -6
- package/dist/{cjs/testing/jest.node.config.cjs → esm/testing/jest.node.config.mjs} +3 -2
- package/dist/esm/testing/setup-textencoder.cjs +4 -0
- package/dist/esm/webpack/webpack.storybook.js +61 -0
- package/dist/types/lib/babel.config.d.ts +3 -0
- package/dist/types/lib/commands/storybook.d.ts +1 -0
- package/dist/types/lib/index.d.ts +5 -9
- package/dist/types/lib/lint-config/commitlint/export.d.mts +1 -0
- package/dist/types/lib/lint-config/commitlint.config.d.mts +3 -0
- package/dist/types/lib/lint-config/eslint/common.d.cts +8 -2
- package/dist/types/lib/lint-config/eslint/flat/compat.d.mts +1 -1
- package/dist/types/lib/lint-config/eslint/non-react.d.cts +8 -1
- package/dist/types/lib/lint-config/eslint/react.d.cts +8 -1
- package/dist/types/lib/lint-config/eslint/typescript/non-react.d.cts +8 -1
- package/dist/types/lib/lint-config/eslint/typescript/react.d.cts +8 -1
- package/dist/types/lib/lint-config/lint-staged.config.d.ts +2 -2
- package/dist/types/lib/lint-config/prettier/export.d.mts +1 -0
- package/dist/types/lib/lint-config/prettier.config.d.mts +3 -0
- package/dist/types/lib/testing/setup-textencoder.d.cts +1 -0
- package/dist/types/lib/utils.d.cts +1 -1
- package/dist/types/lib/utils.d.ts +1 -1
- package/dist/types/lib/webpack/webpack.storybook.d.ts +2 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/lib/lint-config/commitlint/export.mjs +1 -0
- package/lib/lint-config/commitlint.config.mjs +6 -0
- package/lib/lint-config/eslint/common.cjs +8 -1
- package/lib/lint-config/eslint/flat/compat.mjs +5 -5
- package/lib/lint-config/eslint/flat/rules.mjs +1 -0
- package/lib/lint-config/lint-staged.config.js +20 -5
- package/lib/lint-config/prettier/export.mjs +1 -0
- package/{dist/esm/lint-config/prettier.config.cjs → lib/lint-config/prettier.config.mjs} +4 -1
- package/lib/skills/migrate-storybook-out-of-cjs/SKILL.md +242 -0
- package/lib/skills/migrate-to-pui-cli-9/SKILL.md +188 -25
- package/lib/testing/jest.config.mjs +124 -0
- package/lib/testing/jest.node.config.mjs +9 -0
- package/package.json +46 -36
- package/build/docs/api/variables/eslintBaseConfig/index.html +0 -132
- package/build/docs/api/variables/eslintConfig/index.html +0 -180
- package/build/docs/assets/js/04ee7372.eaa386ed.js +0 -1
- package/build/docs/assets/js/0551d4dd.ebb18f4f.js +0 -1
- package/build/docs/assets/js/0a1d0315.fc8f91a7.js +0 -1
- package/build/docs/assets/js/13097d8d.af480dfd.js +0 -1
- package/build/docs/assets/js/3992.0ac29b2f.js +0 -2
- package/build/docs/assets/js/4fb6949f.369cc1b9.js +0 -1
- package/build/docs/assets/js/5befad71.5f19afb5.js +0 -1
- package/build/docs/assets/js/5d5f1db0.c5aa5afa.js +0 -1
- package/build/docs/assets/js/5e8c322a.ef3b894b.js +0 -1
- package/build/docs/assets/js/5e95c892.f550b901.js +0 -1
- package/build/docs/assets/js/6bd11e52.08b95209.js +0 -1
- package/build/docs/assets/js/6e96545e.30c1b801.js +0 -1
- package/build/docs/assets/js/80e87108.f9507b95.js +0 -1
- package/build/docs/assets/js/a94703ab.f1796514.js +0 -1
- package/build/docs/assets/js/b7b585d8.6d53e73f.js +0 -1
- package/build/docs/assets/js/b8ac1d98.62684003.js +0 -1
- package/build/docs/assets/js/c377a04b.0f8625c6.js +0 -1
- package/build/docs/assets/js/e5f79924.c793a74d.js +0 -1
- package/build/docs/assets/js/f736c962.dbd0d004.js +0 -1
- package/build/docs/assets/js/main.7f815b7e.js +0 -2
- package/build/docs/assets/js/runtime~main.f7c5bef0.js +0 -1
- package/dist/cjs/babel.config.cjs +0 -97
- package/dist/cjs/index.cjs +0 -35
- package/dist/cjs/lint-config/commitlint.config.cjs +0 -1
- package/dist/cjs/lint-config/stylelint.config.cjs +0 -3
- package/dist/esm/babel.config.cjs +0 -97
- package/dist/esm/index.cjs +0 -35
- package/dist/esm/lint-config/commitlint.config.cjs +0 -1
- package/dist/esm/lint-config/stylelint.config.cjs +0 -3
- package/dist/types/lib/babel.config.d.cts +0 -59
- package/dist/types/lib/index.d.cts +0 -13
- package/dist/types/lib/lint-config/commitlint.config.d.cts +0 -4
- package/dist/types/lib/lint-config/prettier.config.d.cts +0 -8
- package/dist/types/lib/lint-config/stylelint.config.d.cts +0 -2
- package/lib/lint-config/commitlint.config.cjs +0 -1
- package/lib/lint-config/stylelint.config.cjs +0 -3
- /package/build/docs/assets/js/{3992.0ac29b2f.js.LICENSE.txt → 3992.b9b54f94.js.LICENSE.txt} +0 -0
- /package/build/docs/assets/js/{main.7f815b7e.js.LICENSE.txt → main.3ae939d4.js.LICENSE.txt} +0 -0
- /package/dist/types/lib/testing/{jest.config.d.cts → jest.config.d.mts} +0 -0
- /package/dist/types/lib/testing/{jest.node.config.d.cts → jest.node.config.d.mts} +0 -0
|
@@ -3,17 +3,17 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.10.1">
|
|
6
|
-
<title data-rh="true">Usage Guide | Cli</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/cli/usage-guide"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Usage Guide | Cli"><meta data-rh="true" name="description" content="This guide provides detailed documentation for all available commands in @elliemae/pui-cli."><meta data-rh="true" property="og:description" content="This guide provides detailed documentation for all available commands in @elliemae/pui-cli."><link data-rh="true" rel="icon" href="/cli/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/cli/usage-guide"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/usage-guide" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/usage-guide" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Usage Guide","item":"https://pui.ice.com/cli/usage-guide"}]}</script><link rel="stylesheet" href="/cli/assets/css/styles.
|
|
7
|
-
<script src="/cli/assets/js/runtime~main.
|
|
8
|
-
<script src="/cli/assets/js/main.
|
|
6
|
+
<title data-rh="true">Usage Guide | Cli</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/cli/usage-guide"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Usage Guide | Cli"><meta data-rh="true" name="description" content="This guide provides detailed documentation for all available commands in @elliemae/pui-cli."><meta data-rh="true" property="og:description" content="This guide provides detailed documentation for all available commands in @elliemae/pui-cli."><link data-rh="true" rel="icon" href="/cli/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/cli/usage-guide"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/usage-guide" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/usage-guide" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Usage Guide","item":"https://pui.ice.com/cli/usage-guide"}]}</script><link rel="stylesheet" href="/cli/assets/css/styles.3cba4e67.css">
|
|
7
|
+
<script src="/cli/assets/js/runtime~main.9ecf1839.js" defer="defer"></script>
|
|
8
|
+
<script src="/cli/assets/js/main.3ae939d4.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body>
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
12
12
|
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
13
13
|
</defs></svg>
|
|
14
|
-
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="
|
|
14
|
+
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_uUOh" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/cli/"><div class="navbar__logo"><img src="/cli/img/logo.svg" alt="Cli" class="themedComponent_DNHH themedComponent--light_puUK"><img src="/cli/img/logo.svg" alt="Cli" class="themedComponent_DNHH themedComponent--dark_ytUh"></div><b class="navbar__title text--truncate">Cli</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/cli/">Getting Started</a><a class="navbar__item navbar__link" href="/cli/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-cli.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_gBgG"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_bwF7 colorModeToggle_QGVI"><button class="clean-btn toggleButton_Cu0l toggleButtonDisabled_OZ9s" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_njg9 lightToggleIcon_jmWU"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_njg9 darkToggleIcon_cwWx"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_njg9 systemToggleIcon_OGHn"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_WcYf"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_yECr"><div class="docsWrapper_uGqN"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_psYS" type="button"></button><div class="docRoot_xjvB"><aside class="theme-doc-sidebar-container docSidebarContainer_CacH"><div class="sidebarViewport_EpUQ"><div class="sidebar_Pceu"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_NnMk"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_Uon2 menu__link menu__link--sublist" href="/cli/api/"><span title="Cli API" class="categoryLinkLabel_eWUU">Cli API</span></a><button aria-label="Expand sidebar category 'Cli API'" aria-expanded="false" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/cli/eslint-rules-migration"><span title="ESLint rules migration guide (legacy → ESLint 10 flat config)" class="linkLabel_GXod">ESLint rules migration guide (legacy → ESLint 10 flat config)</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/cli/"><span title="PUI CLI Documentation" class="linkLabel_GXod">PUI CLI Documentation</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/cli/pui-cli-9-migration"><span title="pui-cli 9 migration guide" class="linkLabel_GXod">pui-cli 9 migration guide</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/cli/ssl-certificate-setup"><span title="Trust SSL Certificate Guide" class="linkLabel_GXod">Trust SSL Certificate Guide</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/cli/stylelint-migration"><span title="Stylelint migration guide (pui-cli 8 → 9 / Stylelint 17)" class="linkLabel_GXod">Stylelint migration guide (pui-cli 8 → 9 / Stylelint 17)</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/cli/usage-guide"><span title="Usage Guide" class="linkLabel_GXod">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_eyKo"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_Dj72"><div class="docItemContainer_Qzlb"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_BbJP" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/cli/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_h1OG"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Usage Guide</span></li></ul></nav><div class="tocCollapsible_SEmd theme-doc-toc-mobile tocMobile_GImu"><button type="button" class="clean-btn tocCollapsibleButton_wJia">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Usage Guide</h1></header>
|
|
15
15
|
<p>This guide provides detailed documentation for all available commands in <code>@elliemae/pui-cli</code>.</p>
|
|
16
|
-
<h2 class="anchor
|
|
16
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="table-of-contents">Table of Contents<a href="#table-of-contents" class="hash-link" aria-label="Direct link to Table of Contents" title="Direct link to Table of Contents" translate="no"></a></h2>
|
|
17
17
|
<ul>
|
|
18
18
|
<li class=""><a href="#build-commands" class="">Build Commands</a></li>
|
|
19
19
|
<li class=""><a href="#development-commands" class="">Development Commands</a></li>
|
|
@@ -23,17 +23,17 @@
|
|
|
23
23
|
<li class=""><a href="#utility-commands" class="">Utility Commands</a></li>
|
|
24
24
|
<li class=""><a href="#framework-chunk-splitting" class="">Framework Chunk Splitting</a></li>
|
|
25
25
|
</ul>
|
|
26
|
-
<h2 class="anchor
|
|
27
|
-
<h3 class="anchor
|
|
26
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="build-commands">Build Commands<a href="#build-commands" class="hash-link" aria-label="Direct link to Build Commands" title="Direct link to Build Commands" translate="no"></a></h2>
|
|
27
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-build"><code>pui-cli build</code><a href="#pui-cli-build" class="hash-link" aria-label="Direct link to pui-cli-build" title="Direct link to pui-cli-build" translate="no"></a></h3>
|
|
28
28
|
<p>Builds your application for production.</p>
|
|
29
29
|
<p><strong>Usage:</strong></p>
|
|
30
|
-
<div class="language-bash
|
|
30
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli build [options]</span><br></div></code></pre></div></div>
|
|
31
31
|
<p><strong>Options:</strong></p>
|
|
32
32
|
<ul>
|
|
33
33
|
<li class=""><code>-p, --prod</code> - Production build with optimizations</li>
|
|
34
34
|
</ul>
|
|
35
35
|
<p><strong>Examples:</strong></p>
|
|
36
|
-
<div class="language-bash
|
|
36
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Build web application (development)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli build</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build web application (production)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli build -p</span><br></div></code></pre></div></div>
|
|
37
37
|
<p><strong>Output:</strong></p>
|
|
38
38
|
<ul>
|
|
39
39
|
<li class="">Application builds go to <code>build/</code> or <code>dist/</code> directory</li>
|
|
@@ -49,10 +49,10 @@
|
|
|
49
49
|
<li class="">Applies tree shaking for smaller bundles</li>
|
|
50
50
|
</ul>
|
|
51
51
|
<hr>
|
|
52
|
-
<h3 class="anchor
|
|
52
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-buildcdn"><code>pui-cli buildCDN</code><a href="#pui-cli-buildcdn" class="hash-link" aria-label="Direct link to pui-cli-buildcdn" title="Direct link to pui-cli-buildcdn" translate="no"></a></h3>
|
|
53
53
|
<p>Builds the application for CDN deployment.</p>
|
|
54
54
|
<p><strong>Usage:</strong></p>
|
|
55
|
-
<div class="language-bash
|
|
55
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli buildCDN</span><br></div></code></pre></div></div>
|
|
56
56
|
<p><strong>What it does:</strong></p>
|
|
57
57
|
<ul>
|
|
58
58
|
<li class="">Creates CDN-optimized builds</li>
|
|
@@ -60,23 +60,23 @@
|
|
|
60
60
|
<li class="">Optimizes bundle splitting</li>
|
|
61
61
|
</ul>
|
|
62
62
|
<hr>
|
|
63
|
-
<h3 class="anchor
|
|
63
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-pack"><code>pui-cli pack</code><a href="#pui-cli-pack" class="hash-link" aria-label="Direct link to pui-cli-pack" title="Direct link to pui-cli-pack" translate="no"></a></h3>
|
|
64
64
|
<p>Packages your library for distribution with multiple output formats.</p>
|
|
65
65
|
<p><strong>Usage:</strong></p>
|
|
66
|
-
<div class="language-bash
|
|
66
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack [options]</span><br></div></code></pre></div></div>
|
|
67
67
|
<p><strong>Options:</strong></p>
|
|
68
68
|
<ul>
|
|
69
69
|
<li class=""><code>-p, --prod</code> - Production build with minification</li>
|
|
70
70
|
<li class=""><code>-t, --target <target></code> - Build target (default: browser, options: node, browser)</li>
|
|
71
71
|
</ul>
|
|
72
72
|
<p><strong>Examples:</strong></p>
|
|
73
|
-
<div class="language-bash
|
|
73
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Build library (development)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build library (production)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack -p</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build for Node.js target</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack -p -t node</span><br></div></code></pre></div></div>
|
|
74
74
|
<p><strong>Output:</strong></p>
|
|
75
75
|
<ul>
|
|
76
76
|
<li class="">Creates <code>dist/</code> directory with:<!-- -->
|
|
77
77
|
<ul>
|
|
78
|
-
<li class=""><code>dist/esm/</code> - ES Module format</li>
|
|
79
|
-
<li class=""><code>dist/cjs/</code> - CommonJS format</li>
|
|
78
|
+
<li class=""><code>dist/esm/</code> - ES Module format (published entry)</li>
|
|
79
|
+
<li class=""><code>dist/cjs/</code> - CommonJS format (build artifact; not exported in pui-cli 9)</li>
|
|
80
80
|
<li class=""><code>dist/types/</code> - TypeScript declarations</li>
|
|
81
81
|
<li class=""><code>dist/umd/</code> - UMD format (browser)</li>
|
|
82
82
|
</ul>
|
|
@@ -84,7 +84,7 @@
|
|
|
84
84
|
</ul>
|
|
85
85
|
<p><strong>What it does:</strong></p>
|
|
86
86
|
<ul>
|
|
87
|
-
<li class="">Builds library in
|
|
87
|
+
<li class="">Builds library in ESM, CJS, and UMD formats; <strong>package <code>exports</code> are ESM-only</strong> in pui-cli 9</li>
|
|
88
88
|
<li class="">Generates TypeScript declaration files</li>
|
|
89
89
|
<li class="">Minifies code in production mode</li>
|
|
90
90
|
<li class="">Creates source maps</li>
|
|
@@ -92,11 +92,11 @@
|
|
|
92
92
|
<li class="">Optimized for tree-shaking</li>
|
|
93
93
|
</ul>
|
|
94
94
|
<hr>
|
|
95
|
-
<h2 class="anchor
|
|
96
|
-
<h3 class="anchor
|
|
95
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="development-commands">Development Commands<a href="#development-commands" class="hash-link" aria-label="Direct link to Development Commands" title="Direct link to Development Commands" translate="no"></a></h2>
|
|
96
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-start"><code>pui-cli start</code><a href="#pui-cli-start" class="hash-link" aria-label="Direct link to pui-cli-start" title="Direct link to pui-cli-start" translate="no"></a></h3>
|
|
97
97
|
<p>Starts the development server with hot module replacement.</p>
|
|
98
98
|
<p><strong>Usage:</strong></p>
|
|
99
|
-
<div class="language-bash
|
|
99
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli start [options]</span><br></div></code></pre></div></div>
|
|
100
100
|
<p><strong>Options:</strong></p>
|
|
101
101
|
<ul>
|
|
102
102
|
<li class=""><code>-p, --prod</code> - Start in production mode</li>
|
|
@@ -105,7 +105,7 @@
|
|
|
105
105
|
<li class=""><code>--hot</code> - Enable hot module replacement (default: true)</li>
|
|
106
106
|
</ul>
|
|
107
107
|
<p><strong>Examples:</strong></p>
|
|
108
|
-
<div class="language-bash
|
|
108
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Start on default port (development)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli start</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Start in production mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli start -p</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># or</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm start:prod</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Start on custom port</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli start --port 8080</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Start and open browser</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli start --open</span><br></div></code></pre></div></div>
|
|
109
109
|
<p><strong>What it does:</strong></p>
|
|
110
110
|
<ul>
|
|
111
111
|
<li class="">Starts Webpack dev server</li>
|
|
@@ -115,20 +115,20 @@
|
|
|
115
115
|
<li class="">Auto-reloads on file changes</li>
|
|
116
116
|
</ul>
|
|
117
117
|
<p><strong>Environment Variables:</strong></p>
|
|
118
|
-
<div class="language-env
|
|
118
|
+
<div class="language-env codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-env codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">PORT=3000</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">HOST=localhost</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">HTTPS=false</span><br></div></code></pre></div></div>
|
|
119
119
|
<hr>
|
|
120
|
-
<h3 class="anchor
|
|
120
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-storybook"><code>pui-cli storybook</code><a href="#pui-cli-storybook" class="hash-link" aria-label="Direct link to pui-cli-storybook" title="Direct link to pui-cli-storybook" translate="no"></a></h3>
|
|
121
121
|
<p>Runs Storybook for component development and documentation.</p>
|
|
122
122
|
<p><strong>Usage:</strong></p>
|
|
123
|
-
<div class="language-bash
|
|
123
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook [options]</span><br></div></code></pre></div></div>
|
|
124
124
|
<p><strong>Options:</strong></p>
|
|
125
125
|
<ul>
|
|
126
126
|
<li class=""><code>-b, --build</code> - Build static storybook</li>
|
|
127
127
|
<li class=""><code>--docs</code> - Run in documentation mode</li>
|
|
128
|
-
<li class=""><code>--port <number></code> - Specify port (default:
|
|
128
|
+
<li class=""><code>--port <number></code> - Specify port (default: 11000)</li>
|
|
129
129
|
</ul>
|
|
130
130
|
<p><strong>Examples:</strong></p>
|
|
131
|
-
<div class="language-bash
|
|
131
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Start Storybook dev server</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Start with documentation mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook --docs</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build static Storybook</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook -b</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build with documentation mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook -b --docs</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run on custom port</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook --port 9000</span><br></div></code></pre></div></div>
|
|
132
132
|
<p><strong>What it does:</strong></p>
|
|
133
133
|
<ul>
|
|
134
134
|
<li class="">Starts Storybook development server</li>
|
|
@@ -137,11 +137,11 @@
|
|
|
137
137
|
<li class="">Useful for library development</li>
|
|
138
138
|
</ul>
|
|
139
139
|
<hr>
|
|
140
|
-
<h2 class="anchor
|
|
141
|
-
<h3 class="anchor
|
|
140
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="testing-commands">Testing Commands<a href="#testing-commands" class="hash-link" aria-label="Direct link to Testing Commands" title="Direct link to Testing Commands" translate="no"></a></h2>
|
|
141
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-test"><code>pui-cli test</code><a href="#pui-cli-test" class="hash-link" aria-label="Direct link to pui-cli-test" title="Direct link to pui-cli-test" translate="no"></a></h3>
|
|
142
142
|
<p>Runs Jest tests with coverage reporting.</p>
|
|
143
143
|
<p><strong>Usage:</strong></p>
|
|
144
|
-
<div class="language-bash
|
|
144
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli test [options]</span><br></div></code></pre></div></div>
|
|
145
145
|
<p><strong>Options:</strong></p>
|
|
146
146
|
<ul>
|
|
147
147
|
<li class=""><code>-f, --fix</code> - Update snapshots (<code>-u</code>)</li>
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
<li class=""><code>--findRelatedTests</code> - Run tests related to changed files</li>
|
|
155
155
|
</ul>
|
|
156
156
|
<p><strong>Examples:</strong></p>
|
|
157
|
-
<div class="language-bash
|
|
157
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Run all tests with coverage</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli test</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run tests in production mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli test -p</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run in watch mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test:watch</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Update snapshots</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli test -f</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># or</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test:fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Debug tests</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli test --debug</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># or</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test:debug</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run only tests related to changed files (useful for pre-commit)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli test --coverage --passWithNoTests --bail --findRelatedTests</span><br></div></code></pre></div></div>
|
|
158
158
|
<p><strong>What it does:</strong></p>
|
|
159
159
|
<ul>
|
|
160
160
|
<li class="">Executes Jest test runner</li>
|
|
@@ -170,10 +170,10 @@
|
|
|
170
170
|
<li class=""><code>reports/lcov-report/index.html</code> - Detailed line coverage</li>
|
|
171
171
|
</ul>
|
|
172
172
|
<hr>
|
|
173
|
-
<h3 class="anchor
|
|
173
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-vitest"><code>pui-cli vitest</code><a href="#pui-cli-vitest" class="hash-link" aria-label="Direct link to pui-cli-vitest" title="Direct link to pui-cli-vitest" translate="no"></a></h3>
|
|
174
174
|
<p>Runs Vitest for modern, fast testing.</p>
|
|
175
175
|
<p><strong>Usage:</strong></p>
|
|
176
|
-
<div class="language-bash
|
|
176
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest [options]</span><br></div></code></pre></div></div>
|
|
177
177
|
<p><strong>Options:</strong></p>
|
|
178
178
|
<ul>
|
|
179
179
|
<li class=""><code>--watch</code> - Run in watch mode</li>
|
|
@@ -181,7 +181,7 @@
|
|
|
181
181
|
<li class=""><code>--coverage</code> - Generate coverage</li>
|
|
182
182
|
</ul>
|
|
183
183
|
<p><strong>Examples:</strong></p>
|
|
184
|
-
<div class="language-bash
|
|
184
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Run tests</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run with UI</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest --ui</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run in watch mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest --watch</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Generate coverage</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest --coverage</span><br></div></code></pre></div></div>
|
|
185
185
|
<p><strong>What it does:</strong></p>
|
|
186
186
|
<ul>
|
|
187
187
|
<li class="">Provides fast test execution with Vite</li>
|
|
@@ -190,11 +190,11 @@
|
|
|
190
190
|
<li class="">Compatible with Jest syntax</li>
|
|
191
191
|
</ul>
|
|
192
192
|
<hr>
|
|
193
|
-
<h2 class="anchor
|
|
194
|
-
<h3 class="anchor
|
|
193
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="linting-commands">Linting Commands<a href="#linting-commands" class="hash-link" aria-label="Direct link to Linting Commands" title="Direct link to Linting Commands" translate="no"></a></h2>
|
|
194
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-lint"><code>pui-cli lint</code><a href="#pui-cli-lint" class="hash-link" aria-label="Direct link to pui-cli-lint" title="Direct link to pui-cli-lint" translate="no"></a></h3>
|
|
195
195
|
<p>Lints your codebase for code quality and style issues.</p>
|
|
196
196
|
<p><strong>Usage:</strong></p>
|
|
197
|
-
<div class="language-bash
|
|
197
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint [options]</span><br></div></code></pre></div></div>
|
|
198
198
|
<p><strong>Options:</strong></p>
|
|
199
199
|
<ul>
|
|
200
200
|
<li class=""><code>--fix</code> - Automatically fix linting issues</li>
|
|
@@ -204,7 +204,7 @@
|
|
|
204
204
|
<li class=""><code>--debug</code> - Show detailed error messages</li>
|
|
205
205
|
</ul>
|
|
206
206
|
<p><strong>Examples:</strong></p>
|
|
207
|
-
<div class="language-bash
|
|
207
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Lint all files</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Auto-fix issues</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Lint only JavaScript files</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --js</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Lint only CSS files</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --css</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Lint commit messages</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --commit</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Show debug information</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --debug</span><br></div></code></pre></div></div>
|
|
208
208
|
<p><strong>What it does:</strong></p>
|
|
209
209
|
<ul>
|
|
210
210
|
<li class="">Runs ESLint on JavaScript/TypeScript files</li>
|
|
@@ -221,10 +221,10 @@
|
|
|
221
221
|
<li class=""><strong>Commitlint</strong>: Conventional Commits format</li>
|
|
222
222
|
</ul>
|
|
223
223
|
<hr>
|
|
224
|
-
<h3 class="anchor
|
|
224
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-tscheck"><code>pui-cli tscheck</code><a href="#pui-cli-tscheck" class="hash-link" aria-label="Direct link to pui-cli-tscheck" title="Direct link to pui-cli-tscheck" translate="no"></a></h3>
|
|
225
225
|
<p>Type-checks TypeScript files without emitting output.</p>
|
|
226
226
|
<p><strong>Usage:</strong></p>
|
|
227
|
-
<div class="language-bash
|
|
227
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck [options]</span><br></div></code></pre></div></div>
|
|
228
228
|
<p><strong>Options:</strong></p>
|
|
229
229
|
<ul>
|
|
230
230
|
<li class=""><code>--files</code> - Check specific files only</li>
|
|
@@ -232,7 +232,7 @@
|
|
|
232
232
|
<li class=""><code>--debug</code> - Show detailed TypeScript errors</li>
|
|
233
233
|
</ul>
|
|
234
234
|
<p><strong>Examples:</strong></p>
|
|
235
|
-
<div class="language-bash
|
|
235
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Check all types</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Check with file listing</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck --files</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Watch for changes</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck --watch</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Show detailed errors</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck --debug</span><br></div></code></pre></div></div>
|
|
236
236
|
<p><strong>What it does:</strong></p>
|
|
237
237
|
<ul>
|
|
238
238
|
<li class="">Runs TypeScript compiler in check mode</li>
|
|
@@ -241,11 +241,11 @@
|
|
|
241
241
|
<li class="">Useful for CI/CD pipelines</li>
|
|
242
242
|
</ul>
|
|
243
243
|
<hr>
|
|
244
|
-
<h2 class="anchor
|
|
245
|
-
<h3 class="anchor
|
|
244
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="documentation-commands">Documentation Commands<a href="#documentation-commands" class="hash-link" aria-label="Direct link to Documentation Commands" title="Direct link to Documentation Commands" translate="no"></a></h2>
|
|
245
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-gendoc"><code>pui-cli gendoc</code><a href="#pui-cli-gendoc" class="hash-link" aria-label="Direct link to pui-cli-gendoc" title="Direct link to pui-cli-gendoc" translate="no"></a></h3>
|
|
246
246
|
<p>Generates API documentation from your code.</p>
|
|
247
247
|
<p><strong>Usage:</strong></p>
|
|
248
|
-
<div class="language-bash
|
|
248
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli gendoc</span><br></div></code></pre></div></div>
|
|
249
249
|
<p><strong>What it does:</strong></p>
|
|
250
250
|
<ul>
|
|
251
251
|
<li class="">Generates TypeDoc documentation</li>
|
|
@@ -254,20 +254,20 @@
|
|
|
254
254
|
<li class="">Outputs to <code>docs/api/</code> directory</li>
|
|
255
255
|
</ul>
|
|
256
256
|
<p><strong>Example JSDoc comments:</strong></p>
|
|
257
|
-
<div class="language-typescript
|
|
257
|
+
<div class="language-typescript codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-typescript codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic">/**</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * Adds two numbers together</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * </span><span class="token doc-comment comment keyword" style="color:#00009f;font-style:italic">@param</span><span class="token doc-comment comment" style="color:#999988;font-style:italic"> </span><span class="token doc-comment comment parameter" style="color:#999988;font-style:italic">a</span><span class="token doc-comment comment" style="color:#999988;font-style:italic"> - First number</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * </span><span class="token doc-comment comment keyword" style="color:#00009f;font-style:italic">@param</span><span class="token doc-comment comment" style="color:#999988;font-style:italic"> </span><span class="token doc-comment comment parameter" style="color:#999988;font-style:italic">b</span><span class="token doc-comment comment" style="color:#999988;font-style:italic"> - Second number</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * </span><span class="token doc-comment comment keyword" style="color:#00009f;font-style:italic">@returns</span><span class="token doc-comment comment" style="color:#999988;font-style:italic"> The sum of a and b</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * </span><span class="token doc-comment comment keyword" style="color:#00009f;font-style:italic">@example</span><span class="token doc-comment comment" style="color:#999988;font-style:italic"></span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * ```ts</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * add(2, 3) // returns 5</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * ```</span><br></div><div class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> */</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">function</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">add</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">a</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> b</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token keyword" style="color:#00009f">return</span><span class="token plain"> a </span><span class="token operator" style="color:#393A34">+</span><span class="token plain"> b</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
258
258
|
<hr>
|
|
259
|
-
<h2 class="anchor
|
|
260
|
-
<h3 class="anchor
|
|
259
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="utility-commands">Utility Commands<a href="#utility-commands" class="hash-link" aria-label="Direct link to Utility Commands" title="Direct link to Utility Commands" translate="no"></a></h2>
|
|
260
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-version"><code>pui-cli version</code><a href="#pui-cli-version" class="hash-link" aria-label="Direct link to pui-cli-version" title="Direct link to pui-cli-version" translate="no"></a></h3>
|
|
261
261
|
<p>Manages versioning for monorepo workspaces.</p>
|
|
262
262
|
<p><strong>Usage:</strong></p>
|
|
263
|
-
<div class="language-bash
|
|
263
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli version [options]</span><br></div></code></pre></div></div>
|
|
264
264
|
<p><strong>Options:</strong></p>
|
|
265
265
|
<ul>
|
|
266
266
|
<li class=""><code>--set <version></code> - Set specific version for all packages</li>
|
|
267
267
|
<li class=""><code>--workspace</code> - Update workspace package versions</li>
|
|
268
268
|
</ul>
|
|
269
269
|
<p><strong>Examples:</strong></p>
|
|
270
|
-
<div class="language-bash
|
|
270
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Update versions in monorepo</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli version --workspace</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Set specific version</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli version --set 2.0.0</span><br></div></code></pre></div></div>
|
|
271
271
|
<p><strong>What it does:</strong></p>
|
|
272
272
|
<ul>
|
|
273
273
|
<li class="">Updates package.json versions</li>
|
|
@@ -275,10 +275,10 @@
|
|
|
275
275
|
<li class="">Updates dependency versions</li>
|
|
276
276
|
</ul>
|
|
277
277
|
<hr>
|
|
278
|
-
<h3 class="anchor
|
|
278
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-codemod"><code>pui-cli codemod</code><a href="#pui-cli-codemod" class="hash-link" aria-label="Direct link to pui-cli-codemod" title="Direct link to pui-cli-codemod" translate="no"></a></h3>
|
|
279
279
|
<p>Runs code transformations using jscodeshift.</p>
|
|
280
280
|
<p><strong>Usage:</strong></p>
|
|
281
|
-
<div class="language-bash
|
|
281
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli codemod <transform></span><br></div></code></pre></div></div>
|
|
282
282
|
<p><strong>Arguments:</strong></p>
|
|
283
283
|
<ul>
|
|
284
284
|
<li class=""><code><transform></code> - Name of the transform to apply</li>
|
|
@@ -289,10 +289,10 @@
|
|
|
289
289
|
<li class="">Useful for migrations</li>
|
|
290
290
|
<li class="">Batch code refactoring</li>
|
|
291
291
|
</ul>
|
|
292
|
-
<h3 class="anchor
|
|
292
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="pui-cli-skills"><code>pui-cli skills</code><a href="#pui-cli-skills" class="hash-link" aria-label="Direct link to pui-cli-skills" title="Direct link to pui-cli-skills" translate="no"></a></h3>
|
|
293
293
|
<p>Installs bundled agent skills from <code>@elliemae/pui-cli</code> into the current repo.</p>
|
|
294
294
|
<p><strong>Usage:</strong></p>
|
|
295
|
-
<div class="language-bash
|
|
295
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli skills list</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli skills install [name] [--target <target>] [--force]</span><br></div></code></pre></div></div>
|
|
296
296
|
<p><strong>Options:</strong></p>
|
|
297
297
|
<ul>
|
|
298
298
|
<li class=""><code>--target</code> — <code>cursor</code> (default), <code>claude</code>, <code>copilot</code>, or <code>all</code>
|
|
@@ -305,7 +305,7 @@
|
|
|
305
305
|
</li>
|
|
306
306
|
</ul>
|
|
307
307
|
<p><strong>Examples:</strong></p>
|
|
308
|
-
<div class="language-bash
|
|
308
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># List bundled skills shipped with this pui-cli version</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm exec pui-cli skills list</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Install for Cursor, Claude Code, and GitHub Copilot</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm exec pui-cli skills install migrate-to-pui-cli-9 --target all</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Storybook CJS → ESM (Storybook 10 / pui-app-sdk storybook/* dist exports)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm exec pui-cli skills install migrate-storybook-out-of-cjs --target all</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Install for Cursor only (default)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm exec pui-cli skills install migrate-to-pui-cli-9</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Install for Claude Code only</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm exec pui-cli skills install migrate-to-pui-cli-9 --target claude</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Overwrite an existing skill directory</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm exec pui-cli skills install migrate-to-pui-cli-9 --target all --force</span><br></div></code></pre></div></div>
|
|
309
309
|
<p><strong>What it does:</strong></p>
|
|
310
310
|
<ul>
|
|
311
311
|
<li class="">Copies <code>lib/skills/<name>/</code> from the installed package into the target skill directories</li>
|
|
@@ -313,22 +313,22 @@
|
|
|
313
313
|
<li class="">See <a class="" href="/cli/pui-cli-9-migration">pui-cli 9 migration guide</a> for the full upgrade path</li>
|
|
314
314
|
</ul>
|
|
315
315
|
<hr>
|
|
316
|
-
<h2 class="anchor
|
|
317
|
-
<h3 class="anchor
|
|
316
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="advanced-usage">Advanced Usage<a href="#advanced-usage" class="hash-link" aria-label="Direct link to Advanced Usage" title="Direct link to Advanced Usage" translate="no"></a></h2>
|
|
317
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="using-pui-cli-in-npm-scripts">Using pui-cli in npm scripts<a href="#using-pui-cli-in-npm-scripts" class="hash-link" aria-label="Direct link to Using pui-cli in npm scripts" title="Direct link to Using pui-cli in npm scripts" translate="no"></a></h3>
|
|
318
318
|
<p><strong>package.json example:</strong></p>
|
|
319
|
-
<div class="language-json
|
|
320
|
-
<h3 class="anchor
|
|
319
|
+
<div class="language-json codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-json codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"scripts"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"dev"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli start"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"build"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli build"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"build:lib"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli build --service"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"test"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli test --coverage"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"test:watch"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli test --watch"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"test:debug"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli test --debug"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint:fix"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint --fix"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint:js"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint --js --fix"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint:css"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint --css --fix"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"typecheck"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli tscheck"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"storybook"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli storybook"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"storybook:build"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli storybook --build"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"gendoc"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli gendoc"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"pack"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli pack"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"precommit"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"lint-staged"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
320
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="cicd-integration">CI/CD Integration<a href="#cicd-integration" class="hash-link" aria-label="Direct link to CI/CD Integration" title="Direct link to CI/CD Integration" translate="no"></a></h3>
|
|
321
321
|
<p><strong>Jenkins example:</strong></p>
|
|
322
|
-
<div class="language-groovy
|
|
323
|
-
<h3 class="anchor
|
|
322
|
+
<div class="language-groovy codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-groovy codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pipeline {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> agent any</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> stages {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> stage('Install') {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm install'</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> stage('Lint') {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm lint'</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> stage('Type Check') {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm tscheck'</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> stage('Test') {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm test'</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> stage('Build') {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm build'</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">}</span><br></div></code></pre></div></div>
|
|
323
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="using-exported-configurations">Using Exported Configurations<a href="#using-exported-configurations" class="hash-link" aria-label="Direct link to Using Exported Configurations" title="Direct link to Using Exported Configurations" translate="no"></a></h3>
|
|
324
324
|
<p>You can import and extend the CLI's configurations in your own config files:</p>
|
|
325
325
|
<p><strong>ESLint:</strong></p>
|
|
326
|
-
<div class="language-javascript
|
|
326
|
+
<div class="language-javascript codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-javascript codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token keyword module" style="color:#00009f">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:#393A34">{</span><span class="token imports"> eslintFlatConfig </span><span class="token imports punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token keyword module" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli/eslint'</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword module" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword module" style="color:#00009f">default</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token spread operator" style="color:#393A34">...</span><span class="token plain">eslintFlatConfig</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token literal-property property" style="color:#36acaa">rules</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Your custom rules</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string-property property" style="color:#36acaa">'no-console'</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'warn'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
327
327
|
<p><strong>Prettier:</strong></p>
|
|
328
|
-
<div class="language-javascript
|
|
328
|
+
<div class="language-javascript codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-javascript codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token keyword module" style="color:#00009f">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:#393A34">{</span><span class="token imports"> prettierConfig </span><span class="token imports punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token keyword module" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli/prettier'</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword module" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword module" style="color:#00009f">default</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token spread operator" style="color:#393A34">...</span><span class="token plain">prettierConfig</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Your custom overrides</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token literal-property property" style="color:#36acaa">printWidth</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">100</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
329
329
|
<p><strong>Vitest:</strong></p>
|
|
330
|
-
<div class="language-typescript
|
|
331
|
-
<h2 class="anchor
|
|
330
|
+
<div class="language-typescript codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-typescript codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> defineConfig </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'vitest/config'</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">import</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> vitestConfig </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">from</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli/vitest'</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">default</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">defineConfig</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token operator" style="color:#393A34">...</span><span class="token plain">vitestConfig</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> test</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token operator" style="color:#393A34">...</span><span class="token plain">vitestConfig</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">test</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// Your custom test config</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
331
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="configuration-priority">Configuration Priority<a href="#configuration-priority" class="hash-link" aria-label="Direct link to Configuration Priority" title="Direct link to Configuration Priority" translate="no"></a></h2>
|
|
332
332
|
<p>The CLI follows this priority order for configuration:</p>
|
|
333
333
|
<ol>
|
|
334
334
|
<li class="">Project-level configuration files</li>
|
|
@@ -336,53 +336,53 @@
|
|
|
336
336
|
<li class="">Command-line arguments</li>
|
|
337
337
|
<li class="">Environment variables</li>
|
|
338
338
|
</ol>
|
|
339
|
-
<h2 class="anchor
|
|
340
|
-
<h3 class="anchor
|
|
339
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="best-practices">Best Practices<a href="#best-practices" class="hash-link" aria-label="Direct link to Best Practices" title="Direct link to Best Practices" translate="no"></a></h2>
|
|
340
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="development-workflow">Development Workflow<a href="#development-workflow" class="hash-link" aria-label="Direct link to Development Workflow" title="Direct link to Development Workflow" translate="no"></a></h3>
|
|
341
341
|
<ol>
|
|
342
342
|
<li class="">
|
|
343
343
|
<p><strong>Start development server:</strong></p>
|
|
344
|
-
<div class="language-bash
|
|
344
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm start</span><br></div></code></pre></div></div>
|
|
345
345
|
</li>
|
|
346
346
|
<li class="">
|
|
347
347
|
<p><strong>Run tests in watch mode (separate terminal):</strong></p>
|
|
348
|
-
<div class="language-bash
|
|
348
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test --watch</span><br></div></code></pre></div></div>
|
|
349
349
|
</li>
|
|
350
350
|
<li class="">
|
|
351
351
|
<p><strong>Type check (separate terminal):</strong></p>
|
|
352
|
-
<div class="language-bash
|
|
352
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm tscheck --watch</span><br></div></code></pre></div></div>
|
|
353
353
|
</li>
|
|
354
354
|
<li class="">
|
|
355
355
|
<p><strong>Before committing:</strong></p>
|
|
356
|
-
<div class="language-bash
|
|
356
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm lint:fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm typecheck</span><br></div></code></pre></div></div>
|
|
357
357
|
</li>
|
|
358
358
|
</ol>
|
|
359
|
-
<h3 class="anchor
|
|
359
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="library-development-workflow">Library Development Workflow<a href="#library-development-workflow" class="hash-link" aria-label="Direct link to Library Development Workflow" title="Direct link to Library Development Workflow" translate="no"></a></h3>
|
|
360
360
|
<ol>
|
|
361
361
|
<li class="">
|
|
362
362
|
<p><strong>Start Storybook:</strong></p>
|
|
363
|
-
<div class="language-bash
|
|
363
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm storybook</span><br></div></code></pre></div></div>
|
|
364
364
|
</li>
|
|
365
365
|
<li class="">
|
|
366
366
|
<p><strong>Run tests in watch mode:</strong></p>
|
|
367
|
-
<div class="language-bash
|
|
367
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test --watch</span><br></div></code></pre></div></div>
|
|
368
368
|
</li>
|
|
369
369
|
<li class="">
|
|
370
370
|
<p><strong>Build library:</strong></p>
|
|
371
|
-
<div class="language-bash
|
|
371
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm build --service</span><br></div></code></pre></div></div>
|
|
372
372
|
</li>
|
|
373
373
|
<li class="">
|
|
374
374
|
<p><strong>Test package:</strong></p>
|
|
375
|
-
<div class="language-bash
|
|
375
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm pack</span><br></div></code></pre></div></div>
|
|
376
376
|
</li>
|
|
377
377
|
</ol>
|
|
378
|
-
<h3 class="anchor
|
|
378
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="performance-tips">Performance Tips<a href="#performance-tips" class="hash-link" aria-label="Direct link to Performance Tips" title="Direct link to Performance Tips" translate="no"></a></h3>
|
|
379
379
|
<ul>
|
|
380
380
|
<li class="">Use <code>--findRelatedTests</code> to run only relevant tests</li>
|
|
381
381
|
<li class="">Enable <code>--watch</code> mode during development</li>
|
|
382
382
|
<li class="">Use <code>--silent</code> in CI to reduce output</li>
|
|
383
383
|
<li class="">Run <code>lint --js</code> and <code>lint --css</code> separately for faster feedback</li>
|
|
384
384
|
</ul>
|
|
385
|
-
<h3 class="anchor
|
|
385
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="framework-chunk-splitting">Framework Chunk Splitting<a href="#framework-chunk-splitting" class="hash-link" aria-label="Direct link to Framework Chunk Splitting" title="Direct link to Framework Chunk Splitting" translate="no"></a></h3>
|
|
386
386
|
<p><code>pui-cli</code> supports an opt-in <strong>framework chunk</strong> that separates React core libraries into a dedicated bundle. Because the framework changes far less frequently than other vendor dependencies, this improves long-term browser caching and reduces the amount of JavaScript users re-download on routine releases.</p>
|
|
387
387
|
<p><strong>How it works</strong></p>
|
|
388
388
|
<p>When enabled, the production (and dev) Webpack build creates three vendor-level chunks instead of two:</p>
|
|
@@ -390,50 +390,50 @@
|
|
|
390
390
|
<p>Without the flag, the default two-chunk layout is preserved (<code>emui.js</code> + <code>vendors.js</code>).</p>
|
|
391
391
|
<p><strong>Enabling the flag</strong></p>
|
|
392
392
|
<p>Add the following to your application's <code>.env</code> file:</p>
|
|
393
|
-
<div class="language-env
|
|
393
|
+
<div class="language-env codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-env codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">SPLIT_FRAMEWORK_CHUNK=true</span><br></div></code></pre></div></div>
|
|
394
394
|
<p>The flag is read at build time. No changes to <code>pui-cli</code> itself are needed.</p>
|
|
395
395
|
<p><strong>Required application updates</strong></p>
|
|
396
396
|
<p>After enabling the flag you must update three places in your application to include <code>framework.js</code> in the script loading order.</p>
|
|
397
397
|
<p><strong>1. <code>index-app-loader.html</code></strong></p>
|
|
398
398
|
<p>If your application uses <code>pui-app-loader</code>, update the <code>bodyScripts</code> array to include <code>framework.js</code> <strong>before</strong> <code>vendors.js</code>:</p>
|
|
399
|
-
<div class="language-javascript
|
|
399
|
+
<div class="language-javascript codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-javascript codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">emuiAppLoader</span><span class="token punctuation" style="color:#393A34">.</span><span class="token method function property-access" style="color:#d73a49">load</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token literal-property property" style="color:#36acaa">appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'loanapp'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token literal-property property" style="color:#36acaa">headScripts</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token literal-property property" style="color:#36acaa">bodyScripts</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">'runtime~app.js'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'framework.js'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'vendors.js'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'emui.js'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'app.js'</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token literal-property property" style="color:#36acaa">styles</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">'vendors.css'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'emui.css'</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token literal-property property" style="color:#36acaa">isJsModule</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
400
400
|
<p><strong>2. <code>app.config.json</code> — <code>microFrontendApps</code> file lists</strong></p>
|
|
401
401
|
<p>Any microapp built with the framework chunk enabled must list <code>framework.js</code> in its <code>development.files</code> and <code>production.files</code> arrays. The host app's <code>app.config.json</code> must reflect this so that <code>app-bridge</code> loads the scripts in the correct order.</p>
|
|
402
402
|
<p>Development example:</p>
|
|
403
|
-
<div class="language-json
|
|
403
|
+
<div class="language-json codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-json codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"microFrontendApps"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"myapp"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"My App"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"hostUrl"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"./myapp"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"development"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"files"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://cdn.mortgagetech.q1.ice.com/pui-diagnostics@3"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://cdn.mortgagetech.q1.ice.com/pui-logrocket@1"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"js/global.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"framework.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"emui.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"vendors.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"app.js"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
404
404
|
<p>Production example:</p>
|
|
405
|
-
<div class="language-json
|
|
405
|
+
<div class="language-json codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-json codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"microFrontendApps"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"myapp"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"name"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"My App"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"hostUrl"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"./myapp"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"production"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"files"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://cdn.mortgagetech.q1.ice.com/pui-diagnostics@3"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"https://cdn.mortgagetech.q1.ice.com/pui-logrocket@1"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"js/global.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"runtime~app.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"framework.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"emui.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"vendors.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"app.js"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"emui.css"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string" style="color:#e3116c">"vendors.css"</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
406
406
|
<blockquote>
|
|
407
407
|
<p><strong>Load order matters.</strong> <code>framework.js</code> must appear before <code>vendors.js</code> and <code>emui.js</code> because both depend on React.</p>
|
|
408
408
|
</blockquote>
|
|
409
409
|
<p><strong>3. Verify the build output</strong></p>
|
|
410
410
|
<p>After enabling the flag, run a production build and confirm the new chunk appears:</p>
|
|
411
|
-
<div class="language-bash
|
|
411
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm build</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">ls build/latest/js/framework.*.js</span><br></div></code></pre></div></div>
|
|
412
412
|
<p>You should see a hashed file like <code>framework.abc123.js</code> alongside the existing <code>emui</code>, <code>vendors</code>, and <code>app</code> chunks.</p>
|
|
413
413
|
<p><strong>Disabling the flag</strong></p>
|
|
414
414
|
<p>Remove <code>SPLIT_FRAMEWORK_CHUNK=true</code> from <code>.env</code> (or set it to <code>false</code>), then reverse the file-list changes above — remove <code>framework.js</code> from <code>index-app-loader.html</code> and <code>app.config.json</code>. The build will revert to the default two-chunk layout.</p>
|
|
415
|
-
<h2 class="anchor
|
|
416
|
-
<h3 class="anchor
|
|
415
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="troubleshooting">Troubleshooting<a href="#troubleshooting" class="hash-link" aria-label="Direct link to Troubleshooting" title="Direct link to Troubleshooting" translate="no"></a></h2>
|
|
416
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="build-issues">Build Issues<a href="#build-issues" class="hash-link" aria-label="Direct link to Build Issues" title="Direct link to Build Issues" translate="no"></a></h3>
|
|
417
417
|
<p><strong>Error: Module not found</strong></p>
|
|
418
|
-
<div class="language-bash
|
|
419
|
-
<h3 class="anchor
|
|
418
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Clear cache and rebuild</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">rm -rf node_modules dist</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm install</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm build</span><br></div></code></pre></div></div>
|
|
419
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="test-issues">Test Issues<a href="#test-issues" class="hash-link" aria-label="Direct link to Test Issues" title="Direct link to Test Issues" translate="no"></a></h3>
|
|
420
420
|
<p><strong>Error: Tests timing out</strong></p>
|
|
421
|
-
<div class="language-bash
|
|
422
|
-
<h3 class="anchor
|
|
421
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Increase timeout in jest.config.mjs</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli test --debug</span><br></div></code></pre></div></div>
|
|
422
|
+
<h3 class="anchor anchorTargetStickyNavbar_a4V3" id="linting-issues">Linting Issues<a href="#linting-issues" class="hash-link" aria-label="Direct link to Linting Issues" title="Direct link to Linting Issues" translate="no"></a></h3>
|
|
423
423
|
<p><strong>Error: Too many linting errors</strong></p>
|
|
424
|
-
<div class="language-bash
|
|
425
|
-
<h2 class="anchor
|
|
424
|
+
<div class="language-bash codeBlockContainer_xJos theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_HrWh"><pre tabindex="0" class="prism-code language-bash codeBlock_wqKj thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_tOUB"><div class="token-line" style="color:#393A34"><span class="token plain"># Fix automatically</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm lint --fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Fix only JS</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm lint --js --fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Fix only CSS</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm lint --css --fix</span><br></div></code></pre></div></div>
|
|
425
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="additional-resources">Additional Resources<a href="#additional-resources" class="hash-link" aria-label="Direct link to Additional Resources" title="Direct link to Additional Resources" translate="no"></a></h2>
|
|
426
426
|
<ul>
|
|
427
427
|
<li class=""><a class="" href="/cli/#getting-started">Getting Started Guide</a></li>
|
|
428
428
|
<li class=""><a class="" href="/cli/api/">API Documentation</a></li>
|
|
429
429
|
<li class=""><a href="https://git.elliemae.io/platform-ui/pui-cli#migration-guide" target="_blank" rel="noopener noreferrer" class="">Migration Guide</a></li>
|
|
430
430
|
<li class=""><a href="https://git.elliemae.io/platform-ui/pui-cli" target="_blank" rel="noopener noreferrer" class="">GitHub Repository</a></li>
|
|
431
431
|
</ul>
|
|
432
|
-
<h2 class="anchor
|
|
432
|
+
<h2 class="anchor anchorTargetStickyNavbar_a4V3" id="need-help">Need Help?<a href="#need-help" class="hash-link" aria-label="Direct link to Need Help?" title="Direct link to Need Help?" translate="no"></a></h2>
|
|
433
433
|
<p>If you encounter issues or have questions:</p>
|
|
434
434
|
<ul>
|
|
435
435
|
<li class="">Review the documentation</li>
|
|
436
436
|
<li class="">Contact the UI Platform team via ui-platform teams channel</li>
|
|
437
|
-
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col
|
|
437
|
+
</ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_wx0h"><a href="https://git.elliemae.io/platform-ui/pui-cli.git/docs/usage-guide.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_HJtS" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_rV1z"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/cli/stylelint-migration"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Stylelint migration guide (pui-cli 8 → 9 / Stylelint 17)</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_Vnv3 thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#table-of-contents" class="table-of-contents__link toc-highlight">Table of Contents</a></li><li><a href="#build-commands" class="table-of-contents__link toc-highlight">Build Commands</a><ul><li><a href="#pui-cli-build" class="table-of-contents__link toc-highlight"><code>pui-cli build</code></a></li><li><a href="#pui-cli-buildcdn" class="table-of-contents__link toc-highlight"><code>pui-cli buildCDN</code></a></li><li><a href="#pui-cli-pack" class="table-of-contents__link toc-highlight"><code>pui-cli pack</code></a></li></ul></li><li><a href="#development-commands" class="table-of-contents__link toc-highlight">Development Commands</a><ul><li><a href="#pui-cli-start" class="table-of-contents__link toc-highlight"><code>pui-cli start</code></a></li><li><a href="#pui-cli-storybook" class="table-of-contents__link toc-highlight"><code>pui-cli storybook</code></a></li></ul></li><li><a href="#testing-commands" class="table-of-contents__link toc-highlight">Testing Commands</a><ul><li><a href="#pui-cli-test" class="table-of-contents__link toc-highlight"><code>pui-cli test</code></a></li><li><a href="#pui-cli-vitest" class="table-of-contents__link toc-highlight"><code>pui-cli vitest</code></a></li></ul></li><li><a href="#linting-commands" class="table-of-contents__link toc-highlight">Linting Commands</a><ul><li><a href="#pui-cli-lint" class="table-of-contents__link toc-highlight"><code>pui-cli lint</code></a></li><li><a href="#pui-cli-tscheck" class="table-of-contents__link toc-highlight"><code>pui-cli tscheck</code></a></li></ul></li><li><a href="#documentation-commands" class="table-of-contents__link toc-highlight">Documentation Commands</a><ul><li><a href="#pui-cli-gendoc" class="table-of-contents__link toc-highlight"><code>pui-cli gendoc</code></a></li></ul></li><li><a href="#utility-commands" class="table-of-contents__link toc-highlight">Utility Commands</a><ul><li><a href="#pui-cli-version" class="table-of-contents__link toc-highlight"><code>pui-cli version</code></a></li><li><a href="#pui-cli-codemod" class="table-of-contents__link toc-highlight"><code>pui-cli codemod</code></a></li><li><a href="#pui-cli-skills" class="table-of-contents__link toc-highlight"><code>pui-cli skills</code></a></li></ul></li><li><a href="#advanced-usage" class="table-of-contents__link toc-highlight">Advanced Usage</a><ul><li><a href="#using-pui-cli-in-npm-scripts" class="table-of-contents__link toc-highlight">Using pui-cli in npm scripts</a></li><li><a href="#cicd-integration" class="table-of-contents__link toc-highlight">CI/CD Integration</a></li><li><a href="#using-exported-configurations" class="table-of-contents__link toc-highlight">Using Exported Configurations</a></li></ul></li><li><a href="#configuration-priority" class="table-of-contents__link toc-highlight">Configuration Priority</a></li><li><a href="#best-practices" class="table-of-contents__link toc-highlight">Best Practices</a><ul><li><a href="#development-workflow" class="table-of-contents__link toc-highlight">Development Workflow</a></li><li><a href="#library-development-workflow" class="table-of-contents__link toc-highlight">Library Development Workflow</a></li><li><a href="#performance-tips" class="table-of-contents__link toc-highlight">Performance Tips</a></li><li><a href="#framework-chunk-splitting" class="table-of-contents__link toc-highlight">Framework Chunk Splitting</a></li></ul></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a><ul><li><a href="#build-issues" class="table-of-contents__link toc-highlight">Build Issues</a></li><li><a href="#test-issues" class="table-of-contents__link toc-highlight">Test Issues</a></li><li><a href="#linting-issues" class="table-of-contents__link toc-highlight">Linting Issues</a></li></ul></li><li><a href="#additional-resources" class="table-of-contents__link toc-highlight">Additional Resources</a></li><li><a href="#need-help" class="table-of-contents__link toc-highlight">Need Help?</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/cli/">Getting Started</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://icemortgagetechnology.slack.com/archives/C01M49EGP6Z" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_gBgG"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://git.elliemae.io/platform-ui/pui-cli.git" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_gBgG"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 ICE.</div></div></div></footer></div>
|
|
438
438
|
</body>
|
|
439
439
|
</html>
|