@elliemae/pui-cli 8.59.2 → 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.a97acd8f.css → styles.164dab6e.css} +1 -1
- package/build/docs/assets/js/{04ee7372.195080c5.js → 04ee7372.ee65fc00.js} +1 -1
- package/build/docs/assets/js/16b7bc88.80829a1f.js +1 -0
- package/build/docs/assets/js/{17896441.327c8b6b.js → 17896441.5d790e19.js} +1 -1
- package/build/docs/assets/js/{1b9df811.09bd4b34.js → 1b9df811.33c3d080.js} +1 -1
- package/build/docs/assets/js/{3157.e1409cfe.js → 3157.a913c653.js} +1 -1
- package/build/docs/assets/js/{3508.788ec534.js → 3508.6ae0a4d5.js} +1 -1
- package/build/docs/assets/js/{37d86055.aa36bd26.js → 37d86055.5f233dc9.js} +1 -1
- package/build/docs/assets/js/{4807.27bddbfc.js → 4807.c1b8e16b.js} +2 -2
- package/build/docs/assets/js/{5961.dc9286a9.js → 5961.aa8f23b7.js} +1 -1
- package/build/docs/assets/js/{5d5f1db0.1c121321.js → 5d5f1db0.da94e667.js} +1 -1
- package/build/docs/assets/js/5e8c322a.2c70908e.js +1 -0
- package/build/docs/assets/js/5e95c892.d1c2c7e1.js +1 -0
- package/build/docs/assets/js/{5fb3c522.e1d35ca0.js → 5fb3c522.ac972d37.js} +1 -1
- package/build/docs/assets/js/{6bd11e52.31e6a6b1.js → 6bd11e52.d3c9cc53.js} +1 -1
- package/build/docs/assets/js/{6e96545e.f2411cd9.js → 6e96545e.131cd57a.js} +1 -1
- package/build/docs/assets/js/{71f6d02b.e951fdd6.js → 71f6d02b.5e113622.js} +1 -1
- package/build/docs/assets/js/{80e87108.04245cff.js → 80e87108.569da4f4.js} +1 -1
- package/build/docs/assets/js/{9209.d0c90fb2.js → 9343.779b42d3.js} +1 -1
- package/build/docs/assets/js/{a7bd4aaa.d41055eb.js → a7bd4aaa.42ef5d44.js} +1 -1
- package/build/docs/assets/js/a94703ab.16532bab.js +1 -0
- package/build/docs/assets/js/b8ac1d98.2d6ab9ef.js +1 -0
- package/build/docs/assets/js/{bde5209a.deeee3ad.js → bde5209a.6b1c2e2e.js} +1 -1
- package/build/docs/assets/js/c377a04b.fe8a2640.js +1 -0
- package/build/docs/assets/js/{common.704dcc54.js → common.6095a78e.js} +1 -1
- package/build/docs/assets/js/{e5f79924.244ae791.js → e5f79924.5282f01b.js} +1 -1
- package/build/docs/assets/js/{f736c962.42eb6d61.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.lib.base.babel.js +2 -0
- package/dist/esm/webpack/webpack.lib.base.babel.js +2 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +8 -8
- package/build/docs/assets/js/16b7bc88.e21c4658.js +0 -1
- package/build/docs/assets/js/5e8c322a.5e039cd2.js +0 -1
- package/build/docs/assets/js/5e95c892.213dbdd2.js +0 -1
- package/build/docs/assets/js/a94703ab.e1cb3d49.js +0 -1
- package/build/docs/assets/js/b8ac1d98.fd584c0a.js +0 -1
- package/build/docs/assets/js/c377a04b.c3b99999.js +0 -1
- package/build/docs/assets/js/main.00549e5e.js +0 -2
- package/build/docs/assets/js/runtime~main.5dc9a933.js +0 -1
- /package/build/docs/assets/js/{4807.27bddbfc.js.LICENSE.txt → 4807.c1b8e16b.js.LICENSE.txt} +0 -0
- /package/build/docs/assets/js/{main.00549e5e.js.LICENSE.txt → main.518812f9.js.LICENSE.txt} +0 -0
package/build/docs/index.html
CHANGED
|
@@ -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">PUI CLI Documentation | 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/"><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="PUI CLI Documentation | Cli"><meta data-rh="true" name="description" content="Welcome to the ICE MT UI Platform CLI documentation. This CLI tool provides a comprehensive set of commands for building, testing, and maintaining UI applications and libraries."><meta data-rh="true" property="og:description" content="Welcome to the ICE MT UI Platform CLI documentation. This CLI tool provides a comprehensive set of commands for building, testing, and maintaining UI applications and libraries."><link data-rh="true" rel="icon" href="/cli/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/cli/"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/cli/</span> </p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()})</script><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"PUI CLI Documentation","item":"https://pui.ice.com/cli/"}]}</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">PUI CLI Documentation | 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/"><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="PUI CLI Documentation | Cli"><meta data-rh="true" name="description" content="Welcome to the ICE MT UI Platform CLI documentation. This CLI tool provides a comprehensive set of commands for building, testing, and maintaining UI applications and libraries."><meta data-rh="true" property="og:description" content="Welcome to the ICE MT UI Platform CLI documentation. This CLI tool provides a comprehensive set of commands for building, testing, and maintaining UI applications and libraries."><link data-rh="true" rel="icon" href="/cli/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/cli/"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/cli/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/cli/</span> </p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",function(){void 0===window.docusaurus&&insertBanner()})</script><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"PUI CLI Documentation","item":"https://pui.ice.com/cli/"}]}</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 menu__link--active" aria-current="page" 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" 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">PUI CLI Documentation</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>PUI CLI Documentation</h1></header>
|
|
15
15
|
<p>Welcome to the ICE MT UI Platform CLI documentation. This CLI tool provides a comprehensive set of commands for building, testing, and maintaining UI applications and libraries.</p>
|
|
16
|
-
<h2 class="anchor
|
|
16
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="quick-links">Quick Links<a href="#quick-links" class="hash-link" aria-label="Direct link to Quick Links" title="Direct link to Quick Links" translate="no"></a></h2>
|
|
17
17
|
<ul>
|
|
18
18
|
<li class=""><a href="https://git.elliemae.io/platform-ui/pui-cli" target="_blank" rel="noopener noreferrer" class="">GitHub Repository</a></li>
|
|
19
19
|
<li class=""><a href="https://jenkinsbuild.elliemae.cloud/job/UIPlatform/job/pui-cli/job/master" target="_blank" rel="noopener noreferrer" class="">Build Job</a></li>
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
<li class=""><strong><a class="" href="/cli/api/">API Documentation</a></strong> - Generated API docs from source code</li>
|
|
23
23
|
<li class=""><strong><a class="" href="/cli/ssl-certificate-setup">SSL Certificate Setup</a></strong> - HTTPS certificate configuration</li>
|
|
24
24
|
</ul>
|
|
25
|
-
<h2 class="anchor
|
|
25
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="features">Features<a href="#features" class="hash-link" aria-label="Direct link to Features" title="Direct link to Features" translate="no"></a></h2>
|
|
26
26
|
<ul>
|
|
27
27
|
<li class="">🚀 <strong>Modern Build Tools</strong> - Webpack and Vite integration</li>
|
|
28
28
|
<li class="">🧪 <strong>Testing</strong> - Jest and Vitest support with coverage</li>
|
|
@@ -33,94 +33,94 @@
|
|
|
33
33
|
<li class="">📦 <strong>Library Support</strong> - Build both applications and libraries</li>
|
|
34
34
|
<li class="">🎯 <strong>Monorepo Support</strong> - Workspace version management</li>
|
|
35
35
|
</ul>
|
|
36
|
-
<h2 class="anchor
|
|
36
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="getting-started">Getting Started<a href="#getting-started" class="hash-link" aria-label="Direct link to Getting Started" title="Direct link to Getting Started" translate="no"></a></h2>
|
|
37
37
|
<p>This guide will help you get started with <code>@elliemae/pui-cli</code>, a command-line interface tool for building and managing UI applications and libraries.</p>
|
|
38
|
-
<h3 class="anchor
|
|
38
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="prerequisites">Prerequisites<a href="#prerequisites" class="hash-link" aria-label="Direct link to Prerequisites" title="Direct link to Prerequisites" translate="no"></a></h3>
|
|
39
39
|
<p>Before you begin, ensure you have the following installed:</p>
|
|
40
40
|
<ul>
|
|
41
41
|
<li class=""><strong>Node.js</strong>: Version 20</li>
|
|
42
42
|
<li class=""><strong>pnpm</strong>: Version 8 (recommended package manager)</li>
|
|
43
43
|
</ul>
|
|
44
|
-
<h3 class="anchor
|
|
45
|
-
<h4 class="anchor
|
|
44
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="installation">Installation<a href="#installation" class="hash-link" aria-label="Direct link to Installation" title="Direct link to Installation" translate="no"></a></h3>
|
|
45
|
+
<h4 class="anchor anchorTargetStickyNavbar_k9Uz" id="for-new-projects">For New Projects<a href="#for-new-projects" class="hash-link" aria-label="Direct link to For New Projects" title="Direct link to For New Projects" translate="no"></a></h4>
|
|
46
46
|
<p>Install the CLI as a development dependency in your project:</p>
|
|
47
|
-
<div class="language-bash
|
|
48
|
-
<h3 class="anchor
|
|
49
|
-
<h4 class="anchor
|
|
47
|
+
<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 add -D @elliemae/pui-cli</span><br></span></code></pre></div></div>
|
|
48
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="quick-start">Quick Start<a href="#quick-start" class="hash-link" aria-label="Direct link to Quick Start" title="Direct link to Quick Start" translate="no"></a></h3>
|
|
49
|
+
<h4 class="anchor anchorTargetStickyNavbar_k9Uz" id="setting-up-a-new-application">Setting Up a New Application<a href="#setting-up-a-new-application" class="hash-link" aria-label="Direct link to Setting Up a New Application" title="Direct link to Setting Up a New Application" translate="no"></a></h4>
|
|
50
50
|
<ol>
|
|
51
51
|
<li class=""><strong>Create a package.json</strong> if you don't have one:</li>
|
|
52
52
|
</ol>
|
|
53
|
-
<div class="language-bash
|
|
53
|
+
<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 init</span><br></span></code></pre></div></div>
|
|
54
54
|
<ol start="2">
|
|
55
55
|
<li class=""><strong>Install pui-cli</strong>:</li>
|
|
56
56
|
</ol>
|
|
57
|
-
<div class="language-bash
|
|
57
|
+
<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 add -D @elliemae/pui-cli</span><br></span></code></pre></div></div>
|
|
58
58
|
<ol start="3">
|
|
59
59
|
<li class=""><strong>Add scripts to your package.json</strong>:</li>
|
|
60
60
|
</ol>
|
|
61
61
|
<p>For applications:</p>
|
|
62
|
-
<div class="language-json
|
|
62
|
+
<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">"start"</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">"start:prod"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli start -p"</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">"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"</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">"vitest"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"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"> </span><span class="token property" style="color:#36acaa">"test:fix"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli test -f"</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:staged"</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 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">"tscheck"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli tscheck --files"</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:docs"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli storybook --docs"</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 -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 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 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>
|
|
63
63
|
<p>For libraries:</p>
|
|
64
|
-
<div class="language-json
|
|
64
|
+
<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">"build"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli pack -p"</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:dev"</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">"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"</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:fix"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli test -f"</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">"tscheck"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli tscheck --files"</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>
|
|
65
65
|
<ol start="4">
|
|
66
66
|
<li class=""><strong>Create a TypeScript configuration</strong> (<code>tsconfig.json</code>):</li>
|
|
67
67
|
</ol>
|
|
68
68
|
<p>For applications:</p>
|
|
69
|
-
<div class="language-json
|
|
69
|
+
<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">"extends"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"@elliemae/pui-cli/app.tsconfig.json"</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">"compilerOptions"</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">"outDir"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"dist/types"</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">"baseUrl"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"."</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">"paths"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token punctuation" style="color:#393A34">}</span><span class="token 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 property" style="color:#36acaa">"include"</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 string" style="color:#e3116c">"app/**/*"</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 string" style="color:#e3116c">"wdio.config.mjs"</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 string" style="color:#e3116c">"vitest.config.ts"</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 string" style="color:#e3116c">"docusaurus.config.ts"</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 property" style="color:#36acaa">"exclude"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">"node_modules"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"**/*.spec.ts"</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>
|
|
70
70
|
<p>For libraries:</p>
|
|
71
|
-
<div class="language-json
|
|
71
|
+
<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">"extends"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"@elliemae/pui-cli/library.tsconfig.json"</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">"compilerOptions"</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">"outDir"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"dist/types"</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">"declarationDir"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"dist/types"</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">"baseUrl"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"."</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 property" style="color:#36acaa">"include"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">"lib/**/*"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"./docusaurus.config.ts"</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 property" style="color:#36acaa">"exclude"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">"node_modules"</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>
|
|
72
72
|
<ol start="5">
|
|
73
73
|
<li class=""><strong>Create your source structure</strong>:</li>
|
|
74
74
|
</ol>
|
|
75
75
|
<p>For applications:</p>
|
|
76
|
-
<div class="language-text
|
|
76
|
+
<div class="language-text codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-text 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">your-project/</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── app/</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.tsx # Entry point</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── route/ # Routes</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── view/ # Components</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── data/ # Redux slices</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── api/ # RTK Query APIs</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── sideeffect/ # Redux Sagas</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── utils/ # Utilities</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ └── app.config.json # App configuration</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── public/ # Static assets</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></span></code></pre></div></div>
|
|
77
77
|
<p>For libraries:</p>
|
|
78
|
-
<div class="language-text
|
|
79
|
-
<h2 class="anchor
|
|
80
|
-
<h3 class="anchor
|
|
81
|
-
<div class="language-text
|
|
82
|
-
<h3 class="anchor
|
|
83
|
-
<div class="language-text
|
|
84
|
-
<h2 class="anchor
|
|
85
|
-
<h3 class="anchor
|
|
78
|
+
<div class="language-text codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-text 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">your-project/</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── lib/</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.ts # Entry point</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── components/ # Components</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── utils/ # Utilities</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ └── __tests__/ # Tests</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── stories/ # Storybook stories (optional)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></span></code></pre></div></div>
|
|
79
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="project-structure">Project Structure<a href="#project-structure" class="hash-link" aria-label="Direct link to Project Structure" title="Direct link to Project Structure" translate="no"></a></h2>
|
|
80
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="application-structure">Application Structure<a href="#application-structure" class="hash-link" aria-label="Direct link to Application Structure" title="Direct link to Application Structure" translate="no"></a></h3>
|
|
81
|
+
<div class="language-text codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-text 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">your-app/</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── app/ # Application source code</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.tsx # Entry point</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── route/ # Route definitions</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── view/ # UI components</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── data/ # Redux slices (state)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── api/ # RTK Query API definitions</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── sideeffect/ # Redux Sagas</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── utils/ # Utility functions</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── tests/ # Test files</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ └── app.config.json # App configuration</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── public/ # Static assets</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── e2e/ # E2E tests (optional)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── docs/ # Docusaurus docs (optional)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></span></code></pre></div></div>
|
|
82
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="library-structure">Library Structure<a href="#library-structure" class="hash-link" aria-label="Direct link to Library Structure" title="Direct link to Library Structure" translate="no"></a></h3>
|
|
83
|
+
<div class="language-text codeBlockContainer_Iv93 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_qrEl"><pre tabindex="0" class="prism-code language-text 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">your-library/</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── lib/ # Library source code</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.ts # Entry point</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ ├── components/ # Components</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">│ └── __tests__/ # Test files</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── stories/ # Storybook stories</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></span></code></pre></div></div>
|
|
84
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="configuration-files">Configuration Files<a href="#configuration-files" class="hash-link" aria-label="Direct link to Configuration Files" title="Direct link to Configuration Files" translate="no"></a></h2>
|
|
85
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="prettier-configuration">Prettier Configuration<a href="#prettier-configuration" class="hash-link" aria-label="Direct link to Prettier Configuration" title="Direct link to Prettier Configuration" translate="no"></a></h3>
|
|
86
86
|
<p>Create <code>prettier.config.cjs</code>:</p>
|
|
87
|
-
<div class="language-javascript
|
|
88
|
-
<h3 class="anchor
|
|
87
|
+
<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" style="color:#00009f">const</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> prettierConfig </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">require</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli'</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">module</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> prettierConfig</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
88
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="stylelint-configuration">Stylelint Configuration<a href="#stylelint-configuration" class="hash-link" aria-label="Direct link to Stylelint Configuration" title="Direct link to Stylelint Configuration" translate="no"></a></h3>
|
|
89
89
|
<p>Create <code>stylelint.config.cjs</code>:</p>
|
|
90
|
-
<div class="language-javascript
|
|
91
|
-
<h3 class="anchor
|
|
90
|
+
<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" style="color:#00009f">const</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> stylelintConfig </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">require</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli'</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">module</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> stylelintConfig</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
91
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="commitlint-configuration">Commitlint Configuration<a href="#commitlint-configuration" class="hash-link" aria-label="Direct link to Commitlint Configuration" title="Direct link to Commitlint Configuration" translate="no"></a></h3>
|
|
92
92
|
<p>Create <code>commitlint.config.cjs</code>:</p>
|
|
93
|
-
<div class="language-javascript
|
|
94
|
-
<h3 class="anchor
|
|
93
|
+
<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" style="color:#00009f">const</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> commitlintConfig </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">require</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli'</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">module</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> commitlintConfig</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
94
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="lint-staged-configuration">Lint-staged Configuration<a href="#lint-staged-configuration" class="hash-link" aria-label="Direct link to Lint-staged Configuration" title="Direct link to Lint-staged Configuration" translate="no"></a></h3>
|
|
95
95
|
<p>Create <code>lint-staged.config.mjs</code>:</p>
|
|
96
|
-
<div class="language-javascript
|
|
97
|
-
<h3 class="anchor
|
|
96
|
+
<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"> lintStagedConfig </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"></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"> lintStagedConfig</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
97
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="babel-configuration-optional">Babel Configuration (Optional)<a href="#babel-configuration-optional" class="hash-link" aria-label="Direct link to Babel Configuration (Optional)" title="Direct link to Babel Configuration (Optional)" translate="no"></a></h3>
|
|
98
98
|
<p>Create <code>babel.config.cjs</code> for custom Babel configuration:</p>
|
|
99
|
-
<div class="language-javascript
|
|
100
|
-
<h2 class="anchor
|
|
99
|
+
<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" style="color:#00009f">const</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> babelConfig </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">require</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli'</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">module</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> babelConfig</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
100
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="git-hooks-setup">Git Hooks Setup<a href="#git-hooks-setup" class="hash-link" aria-label="Direct link to Git Hooks Setup" title="Direct link to Git Hooks Setup" translate="no"></a></h2>
|
|
101
101
|
<p>To enable pre-commit hooks with Husky:</p>
|
|
102
102
|
<ol>
|
|
103
103
|
<li class=""><strong>Install Husky</strong>:</li>
|
|
104
104
|
</ol>
|
|
105
|
-
<div class="language-bash
|
|
105
|
+
<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 add -D husky</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">npx husky init</span><br></span></code></pre></div></div>
|
|
106
106
|
<ol start="2">
|
|
107
107
|
<li class=""><strong>Create <code>.husky/pre-commit</code></strong>:</li>
|
|
108
108
|
</ol>
|
|
109
|
-
<div class="language-bash
|
|
109
|
+
<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">#!/bin/sh</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">. "$(dirname "$0")/_/husky.sh"</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">npx lint-staged</span><br></span></code></pre></div></div>
|
|
110
110
|
<ol start="3">
|
|
111
111
|
<li class=""><strong>Make it executable</strong>:</li>
|
|
112
112
|
</ol>
|
|
113
|
-
<div class="language-bash
|
|
114
|
-
<h2 class="anchor
|
|
115
|
-
<h3 class="anchor
|
|
113
|
+
<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">chmod +x .husky/pre-commit</span><br></span></code></pre></div></div>
|
|
114
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="additional-configuration-files">Additional Configuration Files<a href="#additional-configuration-files" class="hash-link" aria-label="Direct link to Additional Configuration Files" title="Direct link to Additional Configuration Files" translate="no"></a></h2>
|
|
115
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="jest-configuration">Jest Configuration<a href="#jest-configuration" class="hash-link" aria-label="Direct link to Jest Configuration" title="Direct link to Jest Configuration" translate="no"></a></h3>
|
|
116
116
|
<p>For custom Jest configuration, create <code>jest.config.cjs</code>:</p>
|
|
117
|
-
<div class="language-javascript
|
|
118
|
-
<h2 class="anchor
|
|
117
|
+
<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" style="color:#00009f">const</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> jestConfig </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">require</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'@elliemae/pui-cli'</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">module</span><span class="token punctuation" style="color:#393A34">.</span><span class="token property-access">exports</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> jestConfig</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
118
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="environment-variables">Environment Variables<a href="#environment-variables" class="hash-link" aria-label="Direct link to Environment Variables" title="Direct link to Environment Variables" translate="no"></a></h2>
|
|
119
119
|
<p>Create a <code>.env</code> file in your project root for environment-specific configuration:</p>
|
|
120
|
-
<div class="language-env
|
|
121
|
-
<h2 class="anchor
|
|
122
|
-
<h3 class="anchor
|
|
123
|
-
<div class="language-bash
|
|
120
|
+
<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">NODE_ENV=development</span><br></span></code></pre></div></div>
|
|
121
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="running-your-first-build">Running Your First Build<a href="#running-your-first-build" class="hash-link" aria-label="Direct link to Running Your First Build" title="Direct link to Running Your First Build" translate="no"></a></h2>
|
|
122
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="start-development-server">Start Development Server<a href="#start-development-server" class="hash-link" aria-label="Direct link to Start Development Server" title="Direct link to Start Development Server" translate="no"></a></h3>
|
|
123
|
+
<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 development server</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm 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 with production mode</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"># or</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli start -p</span><br></span></code></pre></div></div>
|
|
124
124
|
<p>This will:</p>
|
|
125
125
|
<ul>
|
|
126
126
|
<li class="">Start webpack dev server</li>
|
|
@@ -128,8 +128,8 @@
|
|
|
128
128
|
<li class="">Serve your application (default: <a href="http://localhost:3000" target="_blank" rel="noopener noreferrer" class="">http://localhost:3000</a>)</li>
|
|
129
129
|
<li class="">Watch for file changes</li>
|
|
130
130
|
</ul>
|
|
131
|
-
<h3 class="anchor
|
|
132
|
-
<div class="language-bash
|
|
131
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="build-for-production">Build for Production<a href="#build-for-production" class="hash-link" aria-label="Direct link to Build for Production" title="Direct link to Build for Production" translate="no"></a></h3>
|
|
132
|
+
<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 application</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm 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 library</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 library for development (no minification)</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack</span><br></span></code></pre></div></div>
|
|
133
133
|
<p>This will:</p>
|
|
134
134
|
<ul>
|
|
135
135
|
<li class="">Create an optimized production build</li>
|
|
@@ -138,26 +138,26 @@
|
|
|
138
138
|
<li class="">Minify and bundle your code</li>
|
|
139
139
|
<li class="">For libraries: Generate ESM, CJS, and type declarations</li>
|
|
140
140
|
</ul>
|
|
141
|
-
<h3 class="anchor
|
|
142
|
-
<div class="language-bash
|
|
143
|
-
<h3 class="anchor
|
|
144
|
-
<div class="language-bash
|
|
145
|
-
<h3 class="anchor
|
|
146
|
-
<div class="language-bash
|
|
147
|
-
<h2 class="anchor
|
|
141
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="run-tests">Run Tests<a href="#run-tests" class="hash-link" aria-label="Direct link to Run Tests" title="Direct link to Run Tests" translate="no"></a></h3>
|
|
142
|
+
<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 Jest tests</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" style="display:inline-block"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"># Run tests with auto-fix</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">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"># Watch mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm test:watch</span><br></span></code></pre></div></div>
|
|
143
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="linting-and-type-checking">Linting and Type Checking<a href="#linting-and-type-checking" class="hash-link" aria-label="Direct link to Linting and Type Checking" title="Direct link to Linting and Type Checking" translate="no"></a></h3>
|
|
144
|
+
<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 code</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm 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 lint issues</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"># Type check</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm 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"># Lint staged files only</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm lint:staged</span><br></span></code></pre></div></div>
|
|
145
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="storybook">Storybook<a href="#storybook" class="hash-link" aria-label="Direct link to Storybook" title="Direct link to Storybook" translate="no"></a></h3>
|
|
146
|
+
<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 Storybook dev server</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm 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"># Run with docs mode</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm 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">pnpm storybook:build</span><br></span></code></pre></div></div>
|
|
147
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="next-steps">Next Steps<a href="#next-steps" class="hash-link" aria-label="Direct link to Next Steps" title="Direct link to Next Steps" translate="no"></a></h2>
|
|
148
148
|
<ul>
|
|
149
149
|
<li class="">Read the <a class="" href="/cli/usage-guide">Usage Guide</a> for detailed command documentation</li>
|
|
150
150
|
<li class="">Check out the <a class="" href="/cli/api/">API Documentation</a> for library exports</li>
|
|
151
151
|
<li class="">Review the <a href="https://git.elliemae.io/platform-ui/pui-cli#migration-guide" target="_blank" rel="noopener noreferrer" class="">Migration Guide</a> if upgrading from an older version</li>
|
|
152
152
|
</ul>
|
|
153
|
-
<h2 class="anchor
|
|
154
|
-
<h3 class="anchor
|
|
153
|
+
<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>
|
|
154
|
+
<h3 class="anchor anchorTargetStickyNavbar_k9Uz" id="common-issues">Common Issues<a href="#common-issues" class="hash-link" aria-label="Direct link to Common Issues" title="Direct link to Common Issues" translate="no"></a></h3>
|
|
155
155
|
<p><strong>Port already in use:</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"># Change the port in your .env file</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">PORT=3001</span><br></span></code></pre></div></div>
|
|
157
157
|
<p><strong>Module not found errors:</strong></p>
|
|
158
|
-
<div class="language-bash
|
|
158
|
+
<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 node_modules and reinstall</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">rm -rf node_modules</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm install</span><br></span></code></pre></div></div>
|
|
159
159
|
<p><strong>Build fails with TypeScript errors:</strong></p>
|
|
160
|
-
<div class="language-bash
|
|
160
|
+
<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 type checking separately to see detailed errors</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">pnpm tscheck</span><br></span></code></pre></div></div>
|
|
161
161
|
<p><strong>HTTPS certificate warnings:</strong></p>
|
|
162
162
|
<p>If you see "Not Secure" or certificate warnings when using HTTPS in development:</p>
|
|
163
163
|
<ul>
|
|
@@ -165,11 +165,11 @@
|
|
|
165
165
|
<li class="">You need to trust the self-signed CA certificate on your system</li>
|
|
166
166
|
<li class="">Platform-specific instructions available for macOS, Windows, and Firefox</li>
|
|
167
167
|
</ul>
|
|
168
|
-
<h2 class="anchor
|
|
168
|
+
<h2 class="anchor anchorTargetStickyNavbar_k9Uz" id="getting-help">Getting Help<a href="#getting-help" class="hash-link" aria-label="Direct link to Getting Help" title="Direct link to Getting Help" translate="no"></a></h2>
|
|
169
169
|
<p>If you encounter issues:</p>
|
|
170
170
|
<ol>
|
|
171
171
|
<li class="">Review the documentation in the <code>docs/</code> folder</li>
|
|
172
172
|
<li class="">Reach out to the ui-platform teams channel</li>
|
|
173
|
-
</ol></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col
|
|
173
|
+
</ol></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/index.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/api/variables/vitestConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">vitestConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/cli/ssl-certificate-setup"><div class="pagination-nav__sublabel">Next</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="#quick-links" class="table-of-contents__link toc-highlight">Quick Links</a></li><li><a href="#features" class="table-of-contents__link toc-highlight">Features</a></li><li><a href="#getting-started" class="table-of-contents__link toc-highlight">Getting Started</a><ul><li><a href="#prerequisites" class="table-of-contents__link toc-highlight">Prerequisites</a></li><li><a href="#installation" class="table-of-contents__link toc-highlight">Installation</a></li><li><a href="#quick-start" class="table-of-contents__link toc-highlight">Quick Start</a></li></ul></li><li><a href="#project-structure" class="table-of-contents__link toc-highlight">Project Structure</a><ul><li><a href="#application-structure" class="table-of-contents__link toc-highlight">Application Structure</a></li><li><a href="#library-structure" class="table-of-contents__link toc-highlight">Library Structure</a></li></ul></li><li><a href="#configuration-files" class="table-of-contents__link toc-highlight">Configuration Files</a><ul><li><a href="#prettier-configuration" class="table-of-contents__link toc-highlight">Prettier Configuration</a></li><li><a href="#stylelint-configuration" class="table-of-contents__link toc-highlight">Stylelint Configuration</a></li><li><a href="#commitlint-configuration" class="table-of-contents__link toc-highlight">Commitlint Configuration</a></li><li><a href="#lint-staged-configuration" class="table-of-contents__link toc-highlight">Lint-staged Configuration</a></li><li><a href="#babel-configuration-optional" class="table-of-contents__link toc-highlight">Babel Configuration (Optional)</a></li></ul></li><li><a href="#git-hooks-setup" class="table-of-contents__link toc-highlight">Git Hooks Setup</a></li><li><a href="#additional-configuration-files" class="table-of-contents__link toc-highlight">Additional Configuration Files</a><ul><li><a href="#jest-configuration" class="table-of-contents__link toc-highlight">Jest Configuration</a></li></ul></li><li><a href="#environment-variables" class="table-of-contents__link toc-highlight">Environment Variables</a></li><li><a href="#running-your-first-build" class="table-of-contents__link toc-highlight">Running Your First Build</a><ul><li><a href="#start-development-server" class="table-of-contents__link toc-highlight">Start Development Server</a></li><li><a href="#build-for-production" class="table-of-contents__link toc-highlight">Build for Production</a></li><li><a href="#run-tests" class="table-of-contents__link toc-highlight">Run Tests</a></li><li><a href="#linting-and-type-checking" class="table-of-contents__link toc-highlight">Linting and Type Checking</a></li><li><a href="#storybook" class="table-of-contents__link toc-highlight">Storybook</a></li></ul></li><li><a href="#next-steps" class="table-of-contents__link toc-highlight">Next Steps</a></li><li><a href="#troubleshooting" class="table-of-contents__link toc-highlight">Troubleshooting</a><ul><li><a href="#common-issues" class="table-of-contents__link toc-highlight">Common Issues</a></li></ul></li><li><a href="#getting-help" class="table-of-contents__link toc-highlight">Getting 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>
|
|
174
174
|
</body>
|
|
175
175
|
</html>
|