@elliemae/pui-cli 8.62.2 → 8.62.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 +16 -0
- package/build/docs/api/functions/loadRoutes/index.html +22 -0
- package/build/docs/api/index.html +22 -0
- package/build/docs/api/type-aliases/LIB_NAME/index.html +17 -0
- package/build/docs/api/variables/babelConfig/index.html +40 -0
- package/build/docs/api/variables/commitlintConfig/index.html +20 -0
- package/build/docs/api/variables/eslintBaseConfig/index.html +130 -0
- package/build/docs/api/variables/eslintConfig/index.html +178 -0
- package/build/docs/api/variables/jestConfig/index.html +98 -0
- package/build/docs/api/variables/jestNodeConfig/index.html +98 -0
- package/build/docs/api/variables/lintStagedConfig/index.html +24 -0
- package/build/docs/api/variables/prettierConfig/index.html +30 -0
- package/build/docs/api/variables/stylelintConfig/index.html +30 -0
- package/build/docs/api/variables/vitestConfig/index.html +17 -0
- package/build/docs/assets/css/styles.c76f0d12.css +1 -0
- package/build/docs/assets/js/04ee7372.b1dcd3d9.js +1 -0
- package/build/docs/assets/js/0551d4dd.58dce19e.js +1 -0
- package/build/docs/assets/js/1128.9ff5d096.js +1 -0
- package/build/docs/assets/js/1206.d4327b16.js +1 -0
- package/build/docs/assets/js/1262.d1c4c9bd.js +1 -0
- package/build/docs/assets/js/1316.2f619863.js +2 -0
- package/build/docs/assets/js/1316.2f619863.js.LICENSE.txt +1 -0
- package/build/docs/assets/js/1588.8a61195f.js +1 -0
- package/build/docs/assets/js/16b7bc88.384bbfa6.js +1 -0
- package/build/docs/assets/js/1783.8b385fce.js +1 -0
- package/build/docs/assets/js/17896441.aa99c4b5.js +1 -0
- package/build/docs/assets/js/1944.083a40da.js +1 -0
- package/build/docs/assets/js/1b9df811.7c12d74c.js +1 -0
- package/build/docs/assets/js/2535.486788ef.js +1 -0
- package/build/docs/assets/js/2762.1f225b61.js +1 -0
- package/build/docs/assets/js/280.e6b3c363.js +1 -0
- package/build/docs/assets/js/2919.a0e90f28.js +1 -0
- package/build/docs/assets/js/2948.802fa79d.js +1 -0
- package/build/docs/assets/js/32.3e01a330.js +1 -0
- package/build/docs/assets/js/3241.57801946.js +1 -0
- package/build/docs/assets/js/338.eac1f210.js +1 -0
- package/build/docs/assets/js/3455.b04bcf73.js +1 -0
- package/build/docs/assets/js/365.7dfc1c9b.js +1 -0
- package/build/docs/assets/js/3715.6de9c72e.js +1 -0
- package/build/docs/assets/js/37d86055.a3793e79.js +1 -0
- package/build/docs/assets/js/3807.315d3647.js +1 -0
- package/build/docs/assets/js/3956.6817c831.js +1 -0
- package/build/docs/assets/js/4179.8f624946.js +1 -0
- package/build/docs/assets/js/4250.1db07eb8.js +1 -0
- package/build/docs/assets/js/4273.55f1d480.js +2 -0
- package/build/docs/assets/js/4273.55f1d480.js.LICENSE.txt +9 -0
- package/build/docs/assets/js/4430.ceb8b97f.js +1 -0
- package/build/docs/assets/js/4986.88c0e4c4.js +1 -0
- package/build/docs/assets/js/5146.9c2d5a70.js +1 -0
- package/build/docs/assets/js/5256.9c97e6c5.js +1 -0
- package/build/docs/assets/js/5291.b3189179.js +1 -0
- package/build/docs/assets/js/5384.c08a8b31.js +1 -0
- package/build/docs/assets/js/5d5f1db0.478d1366.js +1 -0
- package/build/docs/assets/js/5e8c322a.efde0b1b.js +1 -0
- package/build/docs/assets/js/5e95c892.d57b4057.js +1 -0
- package/build/docs/assets/js/5fb3c522.a5641583.js +1 -0
- package/build/docs/assets/js/61.73463c9d.js +1 -0
- package/build/docs/assets/js/6176.08e5ab11.js +1 -0
- package/build/docs/assets/js/6668.9ed55615.js +1 -0
- package/build/docs/assets/js/6870.af8f1a4f.js +1 -0
- package/build/docs/assets/js/6bd11e52.8445697f.js +1 -0
- package/build/docs/assets/js/6e96545e.237cb417.js +1 -0
- package/build/docs/assets/js/7048.333735e8.js +1 -0
- package/build/docs/assets/js/71f6d02b.46228c35.js +1 -0
- package/build/docs/assets/js/7311.638d1073.js +1 -0
- package/build/docs/assets/js/7617.0bb56b23.js +1 -0
- package/build/docs/assets/js/7803.74307e92.js +1 -0
- package/build/docs/assets/js/7897.2559cb99.js +1 -0
- package/build/docs/assets/js/7919.7f173626.js +1 -0
- package/build/docs/assets/js/80e87108.6b0a340e.js +1 -0
- package/build/docs/assets/js/821.8d4e2a80.js +1 -0
- package/build/docs/assets/js/8213.30ff6f0f.js +1 -0
- package/build/docs/assets/js/9016.ea955f0a.js +1 -0
- package/build/docs/assets/js/9018.0e3aeec5.js +1 -0
- package/build/docs/assets/js/9199.39e38dc8.js +1 -0
- package/build/docs/assets/js/9349.68c3fedb.js +1 -0
- package/build/docs/assets/js/9566.974ba8ff.js +1 -0
- package/build/docs/assets/js/9799.856d5e67.js +1 -0
- package/build/docs/assets/js/9822.c1ad99cd.js +1 -0
- package/build/docs/assets/js/9945.d801623d.js +1 -0
- package/build/docs/assets/js/a7bd4aaa.bbcaa6ab.js +1 -0
- package/build/docs/assets/js/a94703ab.e6576f9b.js +1 -0
- package/build/docs/assets/js/aba21aa0.3bbcf0cc.js +1 -0
- package/build/docs/assets/js/b8ac1d98.20b7f87c.js +1 -0
- package/build/docs/assets/js/bde5209a.7f232bf8.js +1 -0
- package/build/docs/assets/js/c377a04b.0965a6f2.js +1 -0
- package/build/docs/assets/js/common.f9eba4a3.js +1 -0
- package/build/docs/assets/js/e5f79924.1b7c8fd6.js +1 -0
- package/build/docs/assets/js/f736c962.9ac135e1.js +1 -0
- package/build/docs/assets/js/main.548fd04b.js +2 -0
- package/build/docs/assets/js/main.548fd04b.js.LICENSE.txt +51 -0
- package/build/docs/assets/js/runtime~main.3504f0b1.js +1 -0
- package/build/docs/img/favicon.ico +0 -0
- package/build/docs/img/logo.jpeg +0 -0
- package/build/docs/img/logo.svg +22 -0
- package/build/docs/img/readme.md +1 -0
- package/build/docs/index.html +175 -0
- package/build/docs/readme.md +1 -0
- package/build/docs/sitemap.xml +1 -0
- package/build/docs/ssl-certificate-setup/index.html +284 -0
- package/build/docs/usage-guide/index.html +416 -0
- package/dist/cjs/build/vite.config.js +16 -0
- package/dist/esm/build/vite.config.js +16 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +35 -34
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
/* NProgress, (c) 2013, 2014 Rico Sta. Cruz - http://ricostacruz.com/nprogress
|
|
2
|
+
* @license MIT */
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* @license React
|
|
6
|
+
* react-dom.production.min.js
|
|
7
|
+
*
|
|
8
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
9
|
+
*
|
|
10
|
+
* This source code is licensed under the MIT license found in the
|
|
11
|
+
* LICENSE file in the root directory of this source tree.
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* @license React
|
|
16
|
+
* react-jsx-runtime.production.min.js
|
|
17
|
+
*
|
|
18
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
19
|
+
*
|
|
20
|
+
* This source code is licensed under the MIT license found in the
|
|
21
|
+
* LICENSE file in the root directory of this source tree.
|
|
22
|
+
*/
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* @license React
|
|
26
|
+
* react.production.min.js
|
|
27
|
+
*
|
|
28
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
29
|
+
*
|
|
30
|
+
* This source code is licensed under the MIT license found in the
|
|
31
|
+
* LICENSE file in the root directory of this source tree.
|
|
32
|
+
*/
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* @license React
|
|
36
|
+
* scheduler.production.min.js
|
|
37
|
+
*
|
|
38
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
39
|
+
*
|
|
40
|
+
* This source code is licensed under the MIT license found in the
|
|
41
|
+
* LICENSE file in the root directory of this source tree.
|
|
42
|
+
*/
|
|
43
|
+
|
|
44
|
+
/** @license React v16.13.1
|
|
45
|
+
* react-is.production.min.js
|
|
46
|
+
*
|
|
47
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
48
|
+
*
|
|
49
|
+
* This source code is licensed under the MIT license found in the
|
|
50
|
+
* LICENSE file in the root directory of this source tree.
|
|
51
|
+
*/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
(()=>{"use strict";var e,a,r,t,d,c={},o={};function f(e){var a=o[e];if(void 0!==a)return a.exports;var r=o[e]={id:e,loaded:!1,exports:{}};return c[e].call(r.exports,r,r.exports,f),r.loaded=!0,r.exports}f.m=c,f.c=o,e=[],f.O=(a,r,t,d)=>{if(!r){var c=1/0;for(i=0;i<e.length;i++){for(var[r,t,d]=e[i],o=!0,b=0;b<r.length;b++)(!1&d||c>=d)&&Object.keys(f.O).every(e=>f.O[e](r[b]))?r.splice(b--,1):(o=!1,d<c&&(c=d));if(o){e.splice(i--,1);var n=t();void 0!==n&&(a=n)}}return a}d=d||0;for(var i=e.length;i>0&&e[i-1][2]>d;i--)e[i]=e[i-1];e[i]=[r,t,d]},f.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return f.d(a,{a:a}),a},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,f.t=function(e,t){if(1&t&&(e=this(e)),8&t)return e;if("object"==typeof e&&e){if(4&t&&e.__esModule)return e;if(16&t&&"function"==typeof e.then)return e}var d=Object.create(null);f.r(d);var c={};a=a||[null,r({}),r([]),r(r)];for(var o=2&t&&e;("object"==typeof o||"function"==typeof o)&&!~a.indexOf(o);o=r(o))Object.getOwnPropertyNames(o).forEach(a=>c[a]=()=>e[a]);return c.default=()=>e,f.d(d,c),d},f.d=(e,a)=>{for(var r in a)f.o(a,r)&&!f.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:a[r]})},f.f={},f.e=e=>Promise.all(Object.keys(f.f).reduce((a,r)=>(f.f[r](e,a),a),[])),f.u=e=>"assets/js/"+({594:"5e8c322a",1091:"5fb3c522",1712:"0551d4dd",1724:"e5f79924",2076:"common",2113:"6bd11e52",2577:"f736c962",2960:"5d5f1db0",3361:"c377a04b",3891:"71f6d02b",4676:"80e87108",5742:"aba21aa0",5908:"04ee7372",6130:"16b7bc88",6688:"6e96545e",7098:"a7bd4aaa",7581:"37d86055",7613:"b8ac1d98",8155:"bde5209a",8401:"17896441",9048:"a94703ab",9577:"1b9df811",9647:"5e95c892"}[e]||e)+"."+{32:"3e01a330",61:"73463c9d",280:"e6b3c363",338:"eac1f210",365:"7dfc1c9b",594:"efde0b1b",821:"8d4e2a80",1091:"a5641583",1128:"9ff5d096",1206:"d4327b16",1262:"d1c4c9bd",1316:"2f619863",1588:"8a61195f",1712:"58dce19e",1724:"1b7c8fd6",1783:"8b385fce",1944:"083a40da",2076:"f9eba4a3",2113:"8445697f",2535:"486788ef",2577:"9ac135e1",2762:"1f225b61",2919:"a0e90f28",2948:"802fa79d",2960:"478d1366",3241:"57801946",3361:"0965a6f2",3455:"b04bcf73",3715:"6de9c72e",3807:"315d3647",3891:"46228c35",3956:"6817c831",4179:"8f624946",4250:"1db07eb8",4273:"55f1d480",4430:"ceb8b97f",4676:"6b0a340e",4986:"88c0e4c4",5146:"9c2d5a70",5256:"9c97e6c5",5291:"b3189179",5384:"c08a8b31",5742:"3bbcf0cc",5908:"b1dcd3d9",6130:"384bbfa6",6176:"08e5ab11",6668:"9ed55615",6688:"237cb417",6870:"af8f1a4f",7048:"333735e8",7098:"bbcaa6ab",7311:"638d1073",7581:"a3793e79",7613:"20b7f87c",7617:"0bb56b23",7803:"74307e92",7897:"2559cb99",7919:"7f173626",8155:"7f232bf8",8213:"30ff6f0f",8401:"aa99c4b5",9016:"ea955f0a",9018:"0e3aeec5",9048:"e6576f9b",9199:"39e38dc8",9349:"68c3fedb",9566:"974ba8ff",9577:"7c12d74c",9647:"d57b4057",9799:"856d5e67",9822:"c1ad99cd",9945:"d801623d"}[e]+".js",f.miniCssF=e=>{},f.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),t={},d="@elliemae/pui-cli:",f.l=(e,a,r,c)=>{if(t[e])t[e].push(a);else{var o,b;if(void 0!==r)for(var n=document.getElementsByTagName("script"),i=0;i<n.length;i++){var l=n[i];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==d+r){o=l;break}}o||(b=!0,(o=document.createElement("script")).charset="utf-8",f.nc&&o.setAttribute("nonce",f.nc),o.setAttribute("data-webpack",d+r),o.src=e),t[e]=[a];var u=(a,r)=>{o.onerror=o.onload=null,clearTimeout(s);var d=t[e];if(delete t[e],o.parentNode&&o.parentNode.removeChild(o),d&&d.forEach(e=>e(r)),a)return a(r)},s=setTimeout(u.bind(null,void 0,{type:"timeout",target:o}),12e4);o.onerror=u.bind(null,o.onerror),o.onload=u.bind(null,o.onload),b&&document.head.appendChild(o)}},f.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},f.dn=e=>{(Object.getOwnPropertyDescriptor(e,"name")||{}).writable||Object.defineProperty(e,"name",{value:"default",configurable:!0})},f.p="/cli/",f.gca=function(e){return e={17896441:"8401","5e8c322a":"594","5fb3c522":"1091","0551d4dd":"1712",e5f79924:"1724",common:"2076","6bd11e52":"2113",f736c962:"2577","5d5f1db0":"2960",c377a04b:"3361","71f6d02b":"3891","80e87108":"4676",aba21aa0:"5742","04ee7372":"5908","16b7bc88":"6130","6e96545e":"6688",a7bd4aaa:"7098","37d86055":"7581",b8ac1d98:"7613",bde5209a:"8155",a94703ab:"9048","1b9df811":"9577","5e95c892":"9647"}[e]||e,f.p+f.u(e)},(()=>{var e={5354:0,1869:0};f.f.j=(a,r)=>{var t=f.o(e,a)?e[a]:void 0;if(0!==t)if(t)r.push(t[2]);else if(/^(1869|5354)$/.test(a))e[a]=0;else{var d=new Promise((r,d)=>t=e[a]=[r,d]);r.push(t[2]=d);var c=f.p+f.u(a),o=new Error;f.l(c,r=>{if(f.o(e,a)&&(0!==(t=e[a])&&(e[a]=void 0),t)){var d=r&&("load"===r.type?"missing":r.type),c=r&&r.target&&r.target.src;o.message="Loading chunk "+a+" failed.\n("+d+": "+c+")",o.name="ChunkLoadError",o.type=d,o.request=c,t[1](o)}},"chunk-"+a,a)}},f.O.j=a=>0===e[a];var a=(a,r)=>{var t,d,[c,o,b]=r,n=0;if(c.some(a=>0!==e[a])){for(t in o)f.o(o,t)&&(f.m[t]=o[t]);if(b)var i=b(f)}for(a&&a(r);n<c.length;n++)d=c[n],f.o(e,d)&&e[d]&&e[d][0](),e[d]=0;return f.O(i)},r=globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[];r.forEach(a.bind(null,0)),r.push=a.bind(null,r.push.bind(r))})()})();
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="utf-8"?>
|
|
2
|
+
<!-- Generator: Adobe Illustrator 25.4.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
|
3
|
+
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
|
4
|
+
viewBox="0 0 377.5 380.3" style="enable-background:new 0 0 377.5 380.3;" xml:space="preserve">
|
|
5
|
+
<style type="text/css">
|
|
6
|
+
.st0{fill:#8DBFE1;}
|
|
7
|
+
</style>
|
|
8
|
+
<g>
|
|
9
|
+
<g>
|
|
10
|
+
<polygon class="st0" points="0,0 0,377.5 73.5,377.5 73.5,343 34.5,343 34.5,34.5 343,34.5 343,225 377.5,225 377.5,0 "/>
|
|
11
|
+
</g>
|
|
12
|
+
<g>
|
|
13
|
+
<rect x="110" y="263.2" width="23.4" height="114.3"/>
|
|
14
|
+
<path d="M212.1,359c-20.6,0-35.4-15.9-35.4-38.6s13.3-38.9,34.9-38.9c12.6,0,23.2,6.1,30.2,15.9l15.9-15.7
|
|
15
|
+
c-12.4-14.5-28.1-21.3-46.6-21.3c-33.3,0-58.8,26-58.8,59.9s23.4,59.9,59.7,59.9c19.7,0,35.4-8.4,46.6-23.2l-16.6-14
|
|
16
|
+
C234.8,353.1,224.7,359,212.1,359z"/>
|
|
17
|
+
<path d="M292.5,330.4c3.7,17.2,16.9,28.6,34.3,28.6c12.6,0,22.7-5.9,30-15.9l16.6,14c-11.2,14.8-26.9,23.2-46.6,23.2
|
|
18
|
+
c-36.3,0-59.7-26-59.7-59.9s23.2-59.9,56.5-59.9c24.9,0,59,17.4,53.3,70L292.5,330.4z M354.3,311.9c-2.5-23.4-17.7-30.4-28-30.4
|
|
19
|
+
c-17.5,0-30.2,11-34.2,30.4L354.3,311.9z"/>
|
|
20
|
+
</g>
|
|
21
|
+
</g>
|
|
22
|
+
</svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# place your static assets such as images inside this folder
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-index" data-has-hydrated="false">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="generator" content="Docusaurus v3.10.1">
|
|
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.c76f0d12.css">
|
|
7
|
+
<script src="/cli/assets/js/runtime~main.3504f0b1.js" defer="defer"></script>
|
|
8
|
+
<script src="/cli/assets/js/main.548fd04b.js" defer="defer"></script>
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<svg style="display: none;"><defs>
|
|
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
|
+
</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="skipToContent_MqpF" 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_nwyV themedComponent--light_jnHf"><img src="/cli/img/logo.svg" alt="Cli" class="themedComponent_nwyV themedComponent--dark_oKnR"></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_TUXt"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_y7jQ colorModeToggle_NG1U"><button class="clean-btn toggleButton_oUE_ toggleButtonDisabled_XGmE" 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_gr5u lightToggleIcon_N5pE"><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_gr5u darkToggleIcon_BzBF"><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_gr5u systemToggleIcon_toF1"><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_NjDX"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_yqUZ"><div class="docsWrapper_jwKu"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_hlPc" type="button"></button><div class="docRoot_WewP"><aside class="theme-doc-sidebar-container docSidebarContainer_hpyk"><div class="sidebarViewport_R9ny"><div class="sidebar_nXNk"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_mahF"><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_MTe6 menu__link menu__link--sublist" href="/cli/api/"><span title="Cli API" class="categoryLinkLabel_Rhjz">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_RvXx">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_RvXx">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_RvXx">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_j_t8"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_OasB"><div class="docItemContainer_sYiN"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_X7dd" 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_Xk7f"><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_r3JA theme-doc-toc-mobile tocMobile_Je3n"><button type="button" class="clean-btn tocCollapsibleButton_K3Cz">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>PUI CLI Documentation</h1></header>
|
|
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 anchorTargetStickyNavbar_aXs5" 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
|
+
<ul>
|
|
18
|
+
<li class=""><a href="https://git.elliemae.io/platform-ui/pui-cli" target="_blank" rel="noopener noreferrer" class="">GitHub Repository</a></li>
|
|
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>
|
|
20
|
+
<li class=""><a href="https://sonarqube.jenkins.elliemae.cloud/overview?id=elliemae.pui.cli-master" target="_blank" rel="noopener noreferrer" class="">SonarQube Report</a></li>
|
|
21
|
+
<li class=""><strong><a class="" href="/cli/usage-guide">Usage Guide</a></strong> - Detailed command reference and examples</li>
|
|
22
|
+
<li class=""><strong><a class="" href="/cli/api/">API Documentation</a></strong> - Generated API docs from source code</li>
|
|
23
|
+
<li class=""><strong><a class="" href="/cli/ssl-certificate-setup">SSL Certificate Setup</a></strong> - HTTPS certificate configuration</li>
|
|
24
|
+
</ul>
|
|
25
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<ul>
|
|
27
|
+
<li class="">🚀 <strong>Modern Build Tools</strong> - Webpack and Vite integration</li>
|
|
28
|
+
<li class="">🧪 <strong>Testing</strong> - Jest and Vitest support with coverage</li>
|
|
29
|
+
<li class="">🎨 <strong>Linting</strong> - ESLint, Prettier, and Stylelint configurations</li>
|
|
30
|
+
<li class="">📝 <strong>TypeScript</strong> - Full TypeScript support</li>
|
|
31
|
+
<li class="">📚 <strong>Storybook</strong> - Component development and documentation</li>
|
|
32
|
+
<li class="">🔧 <strong>Development Server</strong> - Hot module replacement</li>
|
|
33
|
+
<li class="">📦 <strong>Library Support</strong> - Build both applications and libraries</li>
|
|
34
|
+
<li class="">🎯 <strong>Monorepo Support</strong> - Workspace version management</li>
|
|
35
|
+
</ul>
|
|
36
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<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 anchorTargetStickyNavbar_aXs5" 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
|
+
<p>Before you begin, ensure you have the following installed:</p>
|
|
40
|
+
<ul>
|
|
41
|
+
<li class=""><strong>Node.js</strong>: Version 20</li>
|
|
42
|
+
<li class=""><strong>pnpm</strong>: Version 8 (recommended package manager)</li>
|
|
43
|
+
</ul>
|
|
44
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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_aXs5" 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
|
+
<p>Install the CLI as a development dependency in your project:</p>
|
|
47
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm add -D @elliemae/pui-cli</span><br></div></code></pre></div></div>
|
|
48
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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_aXs5" 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
|
+
<ol>
|
|
51
|
+
<li class=""><strong>Create a package.json</strong> if you don't have one:</li>
|
|
52
|
+
</ol>
|
|
53
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm init</span><br></div></code></pre></div></div>
|
|
54
|
+
<ol start="2">
|
|
55
|
+
<li class=""><strong>Install pui-cli</strong>:</li>
|
|
56
|
+
</ol>
|
|
57
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm add -D @elliemae/pui-cli</span><br></div></code></pre></div></div>
|
|
58
|
+
<ol start="3">
|
|
59
|
+
<li class=""><strong>Add scripts to your package.json</strong>:</li>
|
|
60
|
+
</ol>
|
|
61
|
+
<p>For applications:</p>
|
|
62
|
+
<div class="language-json codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-json codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"scripts"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"build"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli build"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"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></div><div 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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"test:debug"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli test --debug"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint:fix"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint --fix"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint: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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"storybook"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli storybook"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"storybook: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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"storybook:build"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli storybook -b"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
63
|
+
<p>For libraries:</p>
|
|
64
|
+
<div class="language-json codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-json codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"scripts"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"test"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli test"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"test: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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"lint:fix"</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"pui-cli lint --fix"</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
65
|
+
<ol start="4">
|
|
66
|
+
<li class=""><strong>Create a TypeScript configuration</strong> (<code>tsconfig.json</code>):</li>
|
|
67
|
+
</ol>
|
|
68
|
+
<p>For applications:</p>
|
|
69
|
+
<div class="language-json codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-json codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"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></div><div 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></div><div 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></div><div 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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token 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></div><div 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></div><div 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></div><div 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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token 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></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
70
|
+
<p>For libraries:</p>
|
|
71
|
+
<div class="language-json codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-json codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token property" style="color:#36acaa">"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></div><div 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></div><div 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></div><div 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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token 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></div><div 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></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></div></code></pre></div></div>
|
|
72
|
+
<ol start="5">
|
|
73
|
+
<li class=""><strong>Create your source structure</strong>:</li>
|
|
74
|
+
</ol>
|
|
75
|
+
<p>For applications:</p>
|
|
76
|
+
<div class="language-text codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-text codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">your-project/</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── app/</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.tsx # Entry point</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── route/ # Routes</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── view/ # Components</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── data/ # Redux slices</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── api/ # RTK Query APIs</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── sideeffect/ # Redux Sagas</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── utils/ # Utilities</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ └── app.config.json # App configuration</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── public/ # Static assets</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></div></code></pre></div></div>
|
|
77
|
+
<p>For libraries:</p>
|
|
78
|
+
<div class="language-text codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-text codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">your-project/</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── lib/</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.ts # Entry point</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── components/ # Components</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── utils/ # Utilities</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ └── __tests__/ # Tests</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── stories/ # Storybook stories (optional)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></div></code></pre></div></div>
|
|
79
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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_aXs5" 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_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-text codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">your-app/</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── app/ # Application source code</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.tsx # Entry point</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── route/ # Route definitions</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── view/ # UI components</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── data/ # Redux slices (state)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── api/ # RTK Query API definitions</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── sideeffect/ # Redux Sagas</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── utils/ # Utility functions</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── tests/ # Test files</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ └── app.config.json # App configuration</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── public/ # Static assets</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── e2e/ # E2E tests (optional)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── docs/ # Docusaurus docs (optional)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></div></code></pre></div></div>
|
|
82
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-text codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">your-library/</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── lib/ # Library source code</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── index.ts # Entry point</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ ├── components/ # Components</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">│ └── __tests__/ # Test files</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── stories/ # Storybook stories</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">├── package.json</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">└── tsconfig.json</span><br></div></code></pre></div></div>
|
|
84
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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_aXs5" 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
|
+
<p>Create <code>prettier.config.cjs</code>:</p>
|
|
87
|
+
<div class="language-javascript codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-javascript codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div 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></div><div 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></div></code></pre></div></div>
|
|
88
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<p>Create <code>stylelint.config.cjs</code>:</p>
|
|
90
|
+
<div class="language-javascript codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-javascript codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div 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></div><div 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></div></code></pre></div></div>
|
|
91
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<p>Create <code>commitlint.config.cjs</code>:</p>
|
|
93
|
+
<div class="language-javascript codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-javascript codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div 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></div><div 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></div></code></pre></div></div>
|
|
94
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<p>Create <code>lint-staged.config.mjs</code>:</p>
|
|
96
|
+
<div class="language-javascript codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-javascript codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token keyword module" style="color:#00009f">import</span><span class="token plain"> </span><span class="token imports punctuation" style="color:#393A34">{</span><span class="token imports"> 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></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword module" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword module" style="color:#00009f">default</span><span class="token plain"> lintStagedConfig</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
97
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<p>Create <code>babel.config.cjs</code> for custom Babel configuration:</p>
|
|
99
|
+
<div class="language-javascript codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-javascript codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div 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></div><div 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></div></code></pre></div></div>
|
|
100
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<p>To enable pre-commit hooks with Husky:</p>
|
|
102
|
+
<ol>
|
|
103
|
+
<li class=""><strong>Install Husky</strong>:</li>
|
|
104
|
+
</ol>
|
|
105
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">pnpm add -D husky</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">npx husky init</span><br></div></code></pre></div></div>
|
|
106
|
+
<ol start="2">
|
|
107
|
+
<li class=""><strong>Create <code>.husky/pre-commit</code></strong>:</li>
|
|
108
|
+
</ol>
|
|
109
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">#!/bin/sh</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">. "$(dirname "$0")/_/husky.sh"</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">npx lint-staged</span><br></div></code></pre></div></div>
|
|
110
|
+
<ol start="3">
|
|
111
|
+
<li class=""><strong>Make it executable</strong>:</li>
|
|
112
|
+
</ol>
|
|
113
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">chmod +x .husky/pre-commit</span><br></div></code></pre></div></div>
|
|
114
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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_aXs5" 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
|
+
<p>For custom Jest configuration, create <code>jest.config.cjs</code>:</p>
|
|
117
|
+
<div class="language-javascript codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-javascript codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div 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></div><div 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></div></code></pre></div></div>
|
|
118
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<p>Create a <code>.env</code> file in your project root for environment-specific configuration:</p>
|
|
120
|
+
<div class="language-env codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-env codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain">PORT=3000</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">NODE_ENV=development</span><br></div></code></pre></div></div>
|
|
121
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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_aXs5" 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_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Start development server</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm start</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Start with production mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm start:prod</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># or</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli start -p</span><br></div></code></pre></div></div>
|
|
124
|
+
<p>This will:</p>
|
|
125
|
+
<ul>
|
|
126
|
+
<li class="">Start webpack dev server</li>
|
|
127
|
+
<li class="">Enable hot module replacement</li>
|
|
128
|
+
<li class="">Serve your application (default: <a href="http://localhost:3000" target="_blank" rel="noopener noreferrer" class="">http://localhost:3000</a>)</li>
|
|
129
|
+
<li class="">Watch for file changes</li>
|
|
130
|
+
</ul>
|
|
131
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Build application</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm build</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build library</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack -p</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build library for development (no minification)</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pui-cli pack</span><br></div></code></pre></div></div>
|
|
133
|
+
<p>This will:</p>
|
|
134
|
+
<ul>
|
|
135
|
+
<li class="">Create an optimized production build</li>
|
|
136
|
+
<li class="">Output files to the <code>dist/</code> or <code>build/</code> directory</li>
|
|
137
|
+
<li class="">Generate source maps</li>
|
|
138
|
+
<li class="">Minify and bundle your code</li>
|
|
139
|
+
<li class="">For libraries: Generate ESM, CJS, and type declarations</li>
|
|
140
|
+
</ul>
|
|
141
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Run Jest tests</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run tests with auto-fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test:fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Debug tests</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test:debug</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Watch mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm test:watch</span><br></div></code></pre></div></div>
|
|
143
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Lint code</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm lint</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Auto-fix lint issues</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm lint:fix</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Type check</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm tscheck</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Lint staged files only</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm lint:staged</span><br></div></code></pre></div></div>
|
|
145
|
+
<h3 class="anchor anchorTargetStickyNavbar_aXs5" 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_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Run Storybook dev server</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm storybook</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Run with docs mode</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm storybook:docs</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"># Build static Storybook</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm storybook:build</span><br></div></code></pre></div></div>
|
|
147
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<ul>
|
|
149
|
+
<li class="">Read the <a class="" href="/cli/usage-guide">Usage Guide</a> for detailed command documentation</li>
|
|
150
|
+
<li class="">Check out the <a class="" href="/cli/api/">API Documentation</a> for library exports</li>
|
|
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
|
+
</ul>
|
|
153
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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_aXs5" 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
|
+
<p><strong>Port already in use:</strong></p>
|
|
156
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Change the port in your .env file</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">PORT=3001</span><br></div></code></pre></div></div>
|
|
157
|
+
<p><strong>Module not found errors:</strong></p>
|
|
158
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Clear node_modules and reinstall</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">rm -rf node_modules</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm install</span><br></div></code></pre></div></div>
|
|
159
|
+
<p><strong>Build fails with TypeScript errors:</strong></p>
|
|
160
|
+
<div class="language-bash codeBlockContainer_xSd0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_cqf4"><pre tabindex="0" class="prism-code language-bash codeBlock_Dg9s thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GBqP"><div class="token-line" style="color:#393A34"><span class="token plain"># Run type checking separately to see detailed errors</span><br></div><div class="token-line" style="color:#393A34"><span class="token plain">pnpm tscheck</span><br></div></code></pre></div></div>
|
|
161
|
+
<p><strong>HTTPS certificate warnings:</strong></p>
|
|
162
|
+
<p>If you see "Not Secure" or certificate warnings when using HTTPS in development:</p>
|
|
163
|
+
<ul>
|
|
164
|
+
<li class="">See the <a class="" href="/cli/ssl-certificate-setup">SSL Certificate Setup Guide</a> for detailed instructions</li>
|
|
165
|
+
<li class="">You need to trust the self-signed CA certificate on your system</li>
|
|
166
|
+
<li class="">Platform-specific instructions available for macOS, Windows, and Firefox</li>
|
|
167
|
+
</ul>
|
|
168
|
+
<h2 class="anchor anchorTargetStickyNavbar_aXs5" 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
|
+
<p>If you encounter issues:</p>
|
|
170
|
+
<ol>
|
|
171
|
+
<li class="">Review the documentation in the <code>docs/</code> folder</li>
|
|
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 noPrint_m2D7"><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_epih" 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_Fpy_"></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_Vgpj 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_TUXt"><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_TUXt"><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
|
+
</body>
|
|
175
|
+
</html>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
# place any static assets inside this folder
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?><urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1"><url><loc>https://pui.ice.com/cli/api/</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/functions/loadRoutes</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/type-aliases/LIB_NAME</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/babelConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/commitlintConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/eslintBaseConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/eslintConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/jestConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/jestNodeConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/lintStagedConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/prettierConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/stylelintConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/api/variables/vitestConfig</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/ssl-certificate-setup</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/usage-guide</loc><changefreq>weekly</changefreq><priority>0.5</priority></url><url><loc>https://pui.ice.com/cli/</loc><changefreq>weekly</changefreq><priority>0.5</priority></url></urlset>
|