@elliemae/pui-cli 8.59.1 → 8.59.3
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/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 +28 -28
- package/build/docs/api/variables/commitlintConfig/index.html +8 -8
- package/build/docs/api/variables/eslintBaseConfig/index.html +118 -118
- package/build/docs/api/variables/eslintConfig/index.html +166 -166
- 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 +12 -12
- package/build/docs/api/variables/prettierConfig/index.html +18 -18
- package/build/docs/api/variables/stylelintConfig/index.html +18 -18
- package/build/docs/api/variables/vitestConfig/index.html +5 -5
- package/build/docs/assets/css/{styles.42b0cfc8.css → styles.164dab6e.css} +1 -1
- package/build/docs/assets/js/{04ee7372.6b073b6d.js → 04ee7372.ee65fc00.js} +1 -1
- package/build/docs/assets/js/{1146.7c40c1b2.js → 1146.7ff9d7f5.js} +1 -1
- package/build/docs/assets/js/16b7bc88.80829a1f.js +1 -0
- package/build/docs/assets/js/17896441.5d790e19.js +1 -0
- package/build/docs/assets/js/{1b9df811.b92d0967.js → 1b9df811.33c3d080.js} +1 -1
- package/build/docs/assets/js/{37d86055.e4a25e8e.js → 37d86055.5f233dc9.js} +1 -1
- package/build/docs/assets/js/{4807.fb6cb703.js → 4807.c1b8e16b.js} +2 -2
- package/build/docs/assets/js/{5d5f1db0.d8acea60.js → 5d5f1db0.da94e667.js} +1 -1
- package/build/docs/assets/js/{5e8c322a.24c71bef.js → 5e8c322a.2c70908e.js} +1 -1
- package/build/docs/assets/js/5e95c892.d1c2c7e1.js +1 -0
- package/build/docs/assets/js/5fb3c522.ac972d37.js +1 -0
- package/build/docs/assets/js/{6bd11e52.8deaee4f.js → 6bd11e52.d3c9cc53.js} +1 -1
- package/build/docs/assets/js/{6e96545e.61c14c1e.js → 6e96545e.131cd57a.js} +1 -1
- package/build/docs/assets/js/71f6d02b.5e113622.js +1 -0
- package/build/docs/assets/js/{80e87108.2fcf4956.js → 80e87108.569da4f4.js} +1 -1
- package/build/docs/assets/js/{5239.616f2bb0.js → 9343.779b42d3.js} +1 -1
- package/build/docs/assets/js/{a7bd4aaa.7fcbb4cb.js → a7bd4aaa.42ef5d44.js} +1 -1
- package/build/docs/assets/js/a94703ab.16532bab.js +1 -0
- package/build/docs/assets/js/{b8ac1d98.80801b14.js → b8ac1d98.2d6ab9ef.js} +1 -1
- package/build/docs/assets/js/{bde5209a.bdcbbd93.js → bde5209a.6b1c2e2e.js} +1 -1
- package/build/docs/assets/js/{c377a04b.54a1d1f0.js → c377a04b.fe8a2640.js} +1 -1
- package/build/docs/assets/js/{e5f79924.af0ec4f0.js → e5f79924.5282f01b.js} +1 -1
- package/build/docs/assets/js/{f736c962.1d45902e.js → f736c962.c7b122a4.js} +1 -1
- package/build/docs/assets/js/main.518812f9.js +2 -0
- package/build/docs/assets/js/runtime~main.2e301887.js +1 -0
- package/build/docs/index.html +65 -65
- package/build/docs/ssl-certificate-setup/index.html +23 -23
- package/build/docs/usage-guide/index.html +78 -78
- package/dist/cjs/webpack/webpack.dev.babel.js +1 -0
- package/dist/cjs/webpack/webpack.lib.base.babel.js +2 -0
- package/dist/esm/webpack/webpack.dev.babel.js +1 -0
- package/dist/esm/webpack/webpack.lib.base.babel.js +2 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +11 -11
- package/build/docs/assets/js/16b7bc88.a9f75905.js +0 -1
- package/build/docs/assets/js/17896441.c4b39d86.js +0 -1
- package/build/docs/assets/js/5e95c892.e513d94d.js +0 -1
- package/build/docs/assets/js/5fb3c522.a0880202.js +0 -1
- package/build/docs/assets/js/71f6d02b.15085a4a.js +0 -1
- package/build/docs/assets/js/a94703ab.7bd2c471.js +0 -1
- package/build/docs/assets/js/main.274facb6.js +0 -2
- package/build/docs/assets/js/runtime~main.835b0db4.js +0 -1
- /package/build/docs/assets/js/{4807.fb6cb703.js.LICENSE.txt → 4807.c1b8e16b.js.LICENSE.txt} +0 -0
- /package/build/docs/assets/js/{main.274facb6.js.LICENSE.txt → main.518812f9.js.LICENSE.txt} +0 -0
|
@@ -3,17 +3,17 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
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.164dab6e.css">
|
|
7
|
+
<script src="/cli/assets/js/runtime~main.2e301887.js" defer="defer"></script>
|
|
8
|
+
<script src="/cli/assets/js/main.518812f9.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
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_C2pI" 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_sHXw themedComponent--light_ZGbG"><img src="/cli/img/logo.svg" alt="Cli" class="themedComponent_sHXw themedComponent--dark_jtPq"></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_pIuA"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_KzGH colorModeToggle_mjYJ"><button class="clean-btn toggleButton_uhL4 toggleButtonDisabled_iE0h" 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_BSL9 lightToggleIcon_PAQJ"><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_BSL9 darkToggleIcon_pKQD"><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_BSL9 systemToggleIcon_ZJZr"><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_KCuO"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_9opo"><div class="docsWrapper_Kvfu"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_HyJk" type="button"></button><div class="docRoot_Q1rW"><aside class="theme-doc-sidebar-container docSidebarContainer_HV3s"><div class="sidebarViewport_KXSY"><div class="sidebar_EOS8"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_JtPG"><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_ZCho menu__link menu__link--sublist" href="/cli/api/"><span title="Cli API" class="categoryLinkLabel_v5GJ">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/"><span title="PUI CLI Documentation" class="linkLabel_YnC6">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/ssl-certificate-setup"><span title="Trust SSL Certificate Guide" class="linkLabel_YnC6">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 menu__link--active" aria-current="page" href="/cli/usage-guide"><span title="Usage Guide" class="linkLabel_YnC6">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_YIYC"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_Lgnb"><div class="docItemContainer_xltI"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_xUvo" 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_i4yJ"><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_aJds theme-doc-toc-mobile tocMobile_eC_g"><button type="button" class="clean-btn tocCollapsibleButton_Nt9I">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_k9Uz" 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>
|
|
@@ -22,17 +22,17 @@
|
|
|
22
22
|
<li class=""><a href="#documentation-commands" class="">Documentation Commands</a></li>
|
|
23
23
|
<li class=""><a href="#utility-commands" class="">Utility Commands</a></li>
|
|
24
24
|
</ul>
|
|
25
|
-
<h2 class="anchor
|
|
26
|
-
<h3 class="anchor
|
|
25
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
26
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
27
27
|
<p>Builds your application for production.</p>
|
|
28
28
|
<p><strong>Usage:</strong></p>
|
|
29
|
-
<div class="language-bash
|
|
29
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli build [options]</span><br></span></code></pre></div></div>
|
|
30
30
|
<p><strong>Options:</strong></p>
|
|
31
31
|
<ul>
|
|
32
32
|
<li class=""><code>-p, --prod</code> - Production build with optimizations</li>
|
|
33
33
|
</ul>
|
|
34
34
|
<p><strong>Examples:</strong></p>
|
|
35
|
-
<div class="language-bash
|
|
35
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Build web application (development)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli build</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Build web application (production)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli build -p</span><br></span></code></pre></div></div>
|
|
36
36
|
<p><strong>Output:</strong></p>
|
|
37
37
|
<ul>
|
|
38
38
|
<li class="">Application builds go to <code>build/</code> or <code>dist/</code> directory</li>
|
|
@@ -48,10 +48,10 @@
|
|
|
48
48
|
<li class="">Applies tree shaking for smaller bundles</li>
|
|
49
49
|
</ul>
|
|
50
50
|
<hr>
|
|
51
|
-
<h3 class="anchor
|
|
51
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
52
52
|
<p>Builds the application for CDN deployment.</p>
|
|
53
53
|
<p><strong>Usage:</strong></p>
|
|
54
|
-
<div class="language-bash
|
|
54
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli buildCDN</span><br></span></code></pre></div></div>
|
|
55
55
|
<p><strong>What it does:</strong></p>
|
|
56
56
|
<ul>
|
|
57
57
|
<li class="">Creates CDN-optimized builds</li>
|
|
@@ -59,17 +59,17 @@
|
|
|
59
59
|
<li class="">Optimizes bundle splitting</li>
|
|
60
60
|
</ul>
|
|
61
61
|
<hr>
|
|
62
|
-
<h3 class="anchor
|
|
62
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
63
63
|
<p>Packages your library for distribution with multiple output formats.</p>
|
|
64
64
|
<p><strong>Usage:</strong></p>
|
|
65
|
-
<div class="language-bash
|
|
65
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack [options]</span><br></span></code></pre></div></div>
|
|
66
66
|
<p><strong>Options:</strong></p>
|
|
67
67
|
<ul>
|
|
68
68
|
<li class=""><code>-p, --prod</code> - Production build with minification</li>
|
|
69
69
|
<li class=""><code>-t, --target <target></code> - Build target (default: browser, options: node, browser)</li>
|
|
70
70
|
</ul>
|
|
71
71
|
<p><strong>Examples:</strong></p>
|
|
72
|
-
<div class="language-bash
|
|
72
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Build library (development)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Build library (production)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack -p</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Build for Node.js target</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack -p -t node</span><br></span></code></pre></div></div>
|
|
73
73
|
<p><strong>Output:</strong></p>
|
|
74
74
|
<ul>
|
|
75
75
|
<li class="">Creates <code>dist/</code> directory with:<!-- -->
|
|
@@ -91,11 +91,11 @@
|
|
|
91
91
|
<li class="">Optimized for tree-shaking</li>
|
|
92
92
|
</ul>
|
|
93
93
|
<hr>
|
|
94
|
-
<h2 class="anchor
|
|
95
|
-
<h3 class="anchor
|
|
94
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
95
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
96
96
|
<p>Starts the development server with hot module replacement.</p>
|
|
97
97
|
<p><strong>Usage:</strong></p>
|
|
98
|
-
<div class="language-bash
|
|
98
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli start [options]</span><br></span></code></pre></div></div>
|
|
99
99
|
<p><strong>Options:</strong></p>
|
|
100
100
|
<ul>
|
|
101
101
|
<li class=""><code>-p, --prod</code> - Start in production mode</li>
|
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
<li class=""><code>--hot</code> - Enable hot module replacement (default: true)</li>
|
|
105
105
|
</ul>
|
|
106
106
|
<p><strong>Examples:</strong></p>
|
|
107
|
-
<div class="language-bash
|
|
107
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Start on default port (development)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli start</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Start in production mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli start -p</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># or</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm start:prod</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Start on custom port</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli start --port 8080</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Start and open browser</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli start --open</span><br></span></code></pre></div></div>
|
|
108
108
|
<p><strong>What it does:</strong></p>
|
|
109
109
|
<ul>
|
|
110
110
|
<li class="">Starts Webpack dev server</li>
|
|
@@ -114,12 +114,12 @@
|
|
|
114
114
|
<li class="">Auto-reloads on file changes</li>
|
|
115
115
|
</ul>
|
|
116
116
|
<p><strong>Environment Variables:</strong></p>
|
|
117
|
-
<div class="language-env
|
|
117
|
+
<div class="language-env codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-env codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">PORT=3000</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">HOST=localhost</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">HTTPS=false</span><br></span></code></pre></div></div>
|
|
118
118
|
<hr>
|
|
119
|
-
<h3 class="anchor
|
|
119
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
120
120
|
<p>Runs Storybook for component development and documentation.</p>
|
|
121
121
|
<p><strong>Usage:</strong></p>
|
|
122
|
-
<div class="language-bash
|
|
122
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook [options]</span><br></span></code></pre></div></div>
|
|
123
123
|
<p><strong>Options:</strong></p>
|
|
124
124
|
<ul>
|
|
125
125
|
<li class=""><code>-b, --build</code> - Build static storybook</li>
|
|
@@ -127,7 +127,7 @@
|
|
|
127
127
|
<li class=""><code>--port <number></code> - Specify port (default: 6006)</li>
|
|
128
128
|
</ul>
|
|
129
129
|
<p><strong>Examples:</strong></p>
|
|
130
|
-
<div class="language-bash
|
|
130
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Start Storybook dev server</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Start with documentation mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook --docs</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Build static Storybook</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook -b</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Build with documentation mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook -b --docs</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Run on custom port</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli storybook --port 9000</span><br></span></code></pre></div></div>
|
|
131
131
|
<p><strong>What it does:</strong></p>
|
|
132
132
|
<ul>
|
|
133
133
|
<li class="">Starts Storybook development server</li>
|
|
@@ -136,11 +136,11 @@
|
|
|
136
136
|
<li class="">Useful for library development</li>
|
|
137
137
|
</ul>
|
|
138
138
|
<hr>
|
|
139
|
-
<h2 class="anchor
|
|
140
|
-
<h3 class="anchor
|
|
139
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
140
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
141
141
|
<p>Runs Jest tests with coverage reporting.</p>
|
|
142
142
|
<p><strong>Usage:</strong></p>
|
|
143
|
-
<div class="language-bash
|
|
143
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli test [options]</span><br></span></code></pre></div></div>
|
|
144
144
|
<p><strong>Options:</strong></p>
|
|
145
145
|
<ul>
|
|
146
146
|
<li class=""><code>-f, --fix</code> - Update snapshots (<code>-u</code>)</li>
|
|
@@ -153,7 +153,7 @@
|
|
|
153
153
|
<li class=""><code>--findRelatedTests</code> - Run tests related to changed files</li>
|
|
154
154
|
</ul>
|
|
155
155
|
<p><strong>Examples:</strong></p>
|
|
156
|
-
<div class="language-bash
|
|
156
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Run all tests with coverage</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli test</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Run tests in production mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli test -p</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Run in watch mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm test:watch</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Update snapshots</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli test -f</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># or</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm test:fix</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Debug tests</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli test --debug</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># or</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm test:debug</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Run only tests related to changed files (useful for pre-commit)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli test --coverage --passWithNoTests --bail --findRelatedTests</span><br></span></code></pre></div></div>
|
|
157
157
|
<p><strong>What it does:</strong></p>
|
|
158
158
|
<ul>
|
|
159
159
|
<li class="">Executes Jest test runner</li>
|
|
@@ -169,10 +169,10 @@
|
|
|
169
169
|
<li class=""><code>reports/lcov-report/index.html</code> - Detailed line coverage</li>
|
|
170
170
|
</ul>
|
|
171
171
|
<hr>
|
|
172
|
-
<h3 class="anchor
|
|
172
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
173
173
|
<p>Runs Vitest for modern, fast testing.</p>
|
|
174
174
|
<p><strong>Usage:</strong></p>
|
|
175
|
-
<div class="language-bash
|
|
175
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest [options]</span><br></span></code></pre></div></div>
|
|
176
176
|
<p><strong>Options:</strong></p>
|
|
177
177
|
<ul>
|
|
178
178
|
<li class=""><code>--watch</code> - Run in watch mode</li>
|
|
@@ -180,7 +180,7 @@
|
|
|
180
180
|
<li class=""><code>--coverage</code> - Generate coverage</li>
|
|
181
181
|
</ul>
|
|
182
182
|
<p><strong>Examples:</strong></p>
|
|
183
|
-
<div class="language-bash
|
|
183
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Run tests</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Run with UI</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest --ui</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Run in watch mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest --watch</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Generate coverage</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli vitest --coverage</span><br></span></code></pre></div></div>
|
|
184
184
|
<p><strong>What it does:</strong></p>
|
|
185
185
|
<ul>
|
|
186
186
|
<li class="">Provides fast test execution with Vite</li>
|
|
@@ -189,11 +189,11 @@
|
|
|
189
189
|
<li class="">Compatible with Jest syntax</li>
|
|
190
190
|
</ul>
|
|
191
191
|
<hr>
|
|
192
|
-
<h2 class="anchor
|
|
193
|
-
<h3 class="anchor
|
|
192
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
193
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
194
194
|
<p>Lints your codebase for code quality and style issues.</p>
|
|
195
195
|
<p><strong>Usage:</strong></p>
|
|
196
|
-
<div class="language-bash
|
|
196
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint [options]</span><br></span></code></pre></div></div>
|
|
197
197
|
<p><strong>Options:</strong></p>
|
|
198
198
|
<ul>
|
|
199
199
|
<li class=""><code>--fix</code> - Automatically fix linting issues</li>
|
|
@@ -203,7 +203,7 @@
|
|
|
203
203
|
<li class=""><code>--debug</code> - Show detailed error messages</li>
|
|
204
204
|
</ul>
|
|
205
205
|
<p><strong>Examples:</strong></p>
|
|
206
|
-
<div class="language-bash
|
|
206
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Lint all files</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Auto-fix issues</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --fix</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Lint only JavaScript files</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --js</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Lint only CSS files</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --css</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Lint commit messages</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --commit</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Show debug information</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli lint --debug</span><br></span></code></pre></div></div>
|
|
207
207
|
<p><strong>What it does:</strong></p>
|
|
208
208
|
<ul>
|
|
209
209
|
<li class="">Runs ESLint on JavaScript/TypeScript files</li>
|
|
@@ -220,10 +220,10 @@
|
|
|
220
220
|
<li class=""><strong>Commitlint</strong>: Conventional Commits format</li>
|
|
221
221
|
</ul>
|
|
222
222
|
<hr>
|
|
223
|
-
<h3 class="anchor
|
|
223
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
224
224
|
<p>Type-checks TypeScript files without emitting output.</p>
|
|
225
225
|
<p><strong>Usage:</strong></p>
|
|
226
|
-
<div class="language-bash
|
|
226
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck [options]</span><br></span></code></pre></div></div>
|
|
227
227
|
<p><strong>Options:</strong></p>
|
|
228
228
|
<ul>
|
|
229
229
|
<li class=""><code>--files</code> - Check specific files only</li>
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
<li class=""><code>--debug</code> - Show detailed TypeScript errors</li>
|
|
232
232
|
</ul>
|
|
233
233
|
<p><strong>Examples:</strong></p>
|
|
234
|
-
<div class="language-bash
|
|
234
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Check all types</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Check with file listing</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck --files</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Watch for changes</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck --watch</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Show detailed errors</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli tscheck --debug</span><br></span></code></pre></div></div>
|
|
235
235
|
<p><strong>What it does:</strong></p>
|
|
236
236
|
<ul>
|
|
237
237
|
<li class="">Runs TypeScript compiler in check mode</li>
|
|
@@ -240,11 +240,11 @@
|
|
|
240
240
|
<li class="">Useful for CI/CD pipelines</li>
|
|
241
241
|
</ul>
|
|
242
242
|
<hr>
|
|
243
|
-
<h2 class="anchor
|
|
244
|
-
<h3 class="anchor
|
|
243
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
244
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
245
245
|
<p>Generates API documentation from your code.</p>
|
|
246
246
|
<p><strong>Usage:</strong></p>
|
|
247
|
-
<div class="language-bash
|
|
247
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli gendoc</span><br></span></code></pre></div></div>
|
|
248
248
|
<p><strong>What it does:</strong></p>
|
|
249
249
|
<ul>
|
|
250
250
|
<li class="">Generates TypeDoc documentation</li>
|
|
@@ -253,20 +253,20 @@
|
|
|
253
253
|
<li class="">Outputs to <code>docs/api/</code> directory</li>
|
|
254
254
|
</ul>
|
|
255
255
|
<p><strong>Example JSDoc comments:</strong></p>
|
|
256
|
-
<div class="language-typescript
|
|
256
|
+
<div class="language-typescript codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-typescript codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic">/**</span><br></span><span class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * Adds two numbers together</span><br></span><span 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></span><span 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></span><span 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></span><span 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></span><span class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * ```ts</span><br></span><span 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></span><span class="token-line" style="color:#393A34"><span class="token doc-comment comment" style="color:#999988;font-style:italic"> * ```</span><br></span><span 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></span><span 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></span><span 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></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre></div></div>
|
|
257
257
|
<hr>
|
|
258
|
-
<h2 class="anchor
|
|
259
|
-
<h3 class="anchor
|
|
258
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
259
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
260
260
|
<p>Manages versioning for monorepo workspaces.</p>
|
|
261
261
|
<p><strong>Usage:</strong></p>
|
|
262
|
-
<div class="language-bash
|
|
262
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli version [options]</span><br></span></code></pre></div></div>
|
|
263
263
|
<p><strong>Options:</strong></p>
|
|
264
264
|
<ul>
|
|
265
265
|
<li class=""><code>--set <version></code> - Set specific version for all packages</li>
|
|
266
266
|
<li class=""><code>--workspace</code> - Update workspace package versions</li>
|
|
267
267
|
</ul>
|
|
268
268
|
<p><strong>Examples:</strong></p>
|
|
269
|
-
<div class="language-bash
|
|
269
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Update versions in monorepo</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli version --workspace</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Set specific version</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli version --set 2.0.0</span><br></span></code></pre></div></div>
|
|
270
270
|
<p><strong>What it does:</strong></p>
|
|
271
271
|
<ul>
|
|
272
272
|
<li class="">Updates package.json versions</li>
|
|
@@ -274,10 +274,10 @@
|
|
|
274
274
|
<li class="">Updates dependency versions</li>
|
|
275
275
|
</ul>
|
|
276
276
|
<hr>
|
|
277
|
-
<h3 class="anchor
|
|
277
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
278
278
|
<p>Runs code transformations using jscodeshift.</p>
|
|
279
279
|
<p><strong>Usage:</strong></p>
|
|
280
|
-
<div class="language-bash
|
|
280
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli codemod <transform></span><br></span></code></pre></div></div>
|
|
281
281
|
<p><strong>Arguments:</strong></p>
|
|
282
282
|
<ul>
|
|
283
283
|
<li class=""><code><transform></code> - Name of the transform to apply</li>
|
|
@@ -289,22 +289,22 @@
|
|
|
289
289
|
<li class="">Batch code refactoring</li>
|
|
290
290
|
</ul>
|
|
291
291
|
<hr>
|
|
292
|
-
<h2 class="anchor
|
|
293
|
-
<h3 class="anchor
|
|
292
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
293
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
294
294
|
<p><strong>package.json example:</strong></p>
|
|
295
|
-
<div class="language-json
|
|
296
|
-
<h3 class="anchor
|
|
295
|
+
<div class="language-json codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-json codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre></div></div>
|
|
296
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
297
297
|
<p><strong>Jenkins example:</strong></p>
|
|
298
|
-
<div class="language-groovy
|
|
299
|
-
<h3 class="anchor
|
|
298
|
+
<div class="language-groovy codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-groovy codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pipeline {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> agent any</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> stages {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> stage('Install') {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm install'</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> stage('Lint') {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm lint'</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> stage('Type Check') {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm tscheck'</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> stage('Test') {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm test'</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> stage('Build') {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> steps {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> sh 'pnpm build'</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span></code></pre></div></div>
|
|
299
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
300
300
|
<p>You can import and extend the CLI's configurations in your own config files:</p>
|
|
301
301
|
<p><strong>ESLint:</strong></p>
|
|
302
|
-
<div class="language-javascript
|
|
302
|
+
<div class="language-javascript codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-javascript codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span 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"> eslintConfig </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'</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span 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></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token spread operator" style="color:#393A34">...</span><span class="token plain">eslintConfig</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span></code></pre></div></div>
|
|
303
303
|
<p><strong>Prettier:</strong></p>
|
|
304
|
-
<div class="language-javascript
|
|
304
|
+
<div class="language-javascript codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-javascript codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span 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'</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span></code></pre></div></div>
|
|
305
305
|
<p><strong>Vitest:</strong></p>
|
|
306
|
-
<div class="language-typescript
|
|
307
|
-
<h2 class="anchor
|
|
306
|
+
<div class="language-typescript codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-typescript codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span 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></span><span 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></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span><span 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></span></code></pre></div></div>
|
|
307
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
308
308
|
<p>The CLI follows this priority order for configuration:</p>
|
|
309
309
|
<ol>
|
|
310
310
|
<li class="">Project-level configuration files</li>
|
|
@@ -312,74 +312,74 @@
|
|
|
312
312
|
<li class="">Command-line arguments</li>
|
|
313
313
|
<li class="">Environment variables</li>
|
|
314
314
|
</ol>
|
|
315
|
-
<h2 class="anchor
|
|
316
|
-
<h3 class="anchor
|
|
315
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
316
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
317
317
|
<ol>
|
|
318
318
|
<li class="">
|
|
319
319
|
<p><strong>Start development server:</strong></p>
|
|
320
|
-
<div class="language-bash
|
|
320
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm start</span><br></span></code></pre></div></div>
|
|
321
321
|
</li>
|
|
322
322
|
<li class="">
|
|
323
323
|
<p><strong>Run tests in watch mode (separate terminal):</strong></p>
|
|
324
|
-
<div class="language-bash
|
|
324
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm test --watch</span><br></span></code></pre></div></div>
|
|
325
325
|
</li>
|
|
326
326
|
<li class="">
|
|
327
327
|
<p><strong>Type check (separate terminal):</strong></p>
|
|
328
|
-
<div class="language-bash
|
|
328
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm tscheck --watch</span><br></span></code></pre></div></div>
|
|
329
329
|
</li>
|
|
330
330
|
<li class="">
|
|
331
331
|
<p><strong>Before committing:</strong></p>
|
|
332
|
-
<div class="language-bash
|
|
332
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm lint:fix</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm test</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm typecheck</span><br></span></code></pre></div></div>
|
|
333
333
|
</li>
|
|
334
334
|
</ol>
|
|
335
|
-
<h3 class="anchor
|
|
335
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
336
336
|
<ol>
|
|
337
337
|
<li class="">
|
|
338
338
|
<p><strong>Start Storybook:</strong></p>
|
|
339
|
-
<div class="language-bash
|
|
339
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm storybook</span><br></span></code></pre></div></div>
|
|
340
340
|
</li>
|
|
341
341
|
<li class="">
|
|
342
342
|
<p><strong>Run tests in watch mode:</strong></p>
|
|
343
|
-
<div class="language-bash
|
|
343
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm test --watch</span><br></span></code></pre></div></div>
|
|
344
344
|
</li>
|
|
345
345
|
<li class="">
|
|
346
346
|
<p><strong>Build library:</strong></p>
|
|
347
|
-
<div class="language-bash
|
|
347
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm build --service</span><br></span></code></pre></div></div>
|
|
348
348
|
</li>
|
|
349
349
|
<li class="">
|
|
350
350
|
<p><strong>Test package:</strong></p>
|
|
351
|
-
<div class="language-bash
|
|
351
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain">pnpm pack</span><br></span></code></pre></div></div>
|
|
352
352
|
</li>
|
|
353
353
|
</ol>
|
|
354
|
-
<h3 class="anchor
|
|
354
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
355
355
|
<ul>
|
|
356
356
|
<li class="">Use <code>--findRelatedTests</code> to run only relevant tests</li>
|
|
357
357
|
<li class="">Enable <code>--watch</code> mode during development</li>
|
|
358
358
|
<li class="">Use <code>--silent</code> in CI to reduce output</li>
|
|
359
359
|
<li class="">Run <code>lint --js</code> and <code>lint --css</code> separately for faster feedback</li>
|
|
360
360
|
</ul>
|
|
361
|
-
<h2 class="anchor
|
|
362
|
-
<h3 class="anchor
|
|
361
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="troubleshooting">Troubleshooting<a href="#troubleshooting" class="hash-link" aria-label="Direct link to Troubleshooting" title="Direct link to Troubleshooting" translate="no"></a></h2>
|
|
362
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
363
363
|
<p><strong>Error: Module not found</strong></p>
|
|
364
|
-
<div class="language-bash
|
|
365
|
-
<h3 class="anchor
|
|
364
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Clear cache and rebuild</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">rm -rf node_modules dist</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm install</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm build</span><br></span></code></pre></div></div>
|
|
365
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
366
366
|
<p><strong>Error: Tests timing out</strong></p>
|
|
367
|
-
<div class="language-bash
|
|
368
|
-
<h3 class="anchor
|
|
367
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Increase timeout in jest.config</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli test --debug</span><br></span></code></pre></div></div>
|
|
368
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
369
369
|
<p><strong>Error: Too many linting errors</strong></p>
|
|
370
|
-
<div class="language-bash
|
|
371
|
-
<h2 class="anchor
|
|
370
|
+
<div class="language-bash codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-bash codeBlock_GUup thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_cigs"><span class="token-line" style="color:#393A34"><span class="token plain"># Fix automatically</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm lint --fix</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Fix only JS</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm lint --js --fix</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Fix only CSS</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm lint --css --fix</span><br></span></code></pre></div></div>
|
|
371
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
372
372
|
<ul>
|
|
373
373
|
<li class=""><a class="" href="/cli/#getting-started">Getting Started Guide</a></li>
|
|
374
374
|
<li class=""><a class="" href="/cli/api/">API Documentation</a></li>
|
|
375
375
|
<li class=""><a href="https://git.elliemae.io/platform-ui/pui-cli#migration-guide" target="_blank" rel="noopener noreferrer" class="">Migration Guide</a></li>
|
|
376
376
|
<li class=""><a href="https://git.elliemae.io/platform-ui/pui-cli" target="_blank" rel="noopener noreferrer" class="">GitHub Repository</a></li>
|
|
377
377
|
</ul>
|
|
378
|
-
<h2 class="anchor
|
|
378
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" 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>
|
|
379
379
|
<p>If you encounter issues or have questions:</p>
|
|
380
380
|
<ul>
|
|
381
381
|
<li class="">Review the documentation</li>
|
|
382
382
|
<li class="">Contact the UI Platform team via ui-platform teams channel</li>
|
|
383
|
-
</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
|
|
383
|
+
</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_jN0k"><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_cW88" 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_IMxw"></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/ssl-certificate-setup"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Trust SSL Certificate Guide</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_XAxT 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></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></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_pIuA"><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_pIuA"><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>
|
|
384
384
|
</body>
|
|
385
385
|
</html>
|