@elliemae/pui-cli 8.59.2 → 8.59.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliemae/pui-cli",
-  "version": "8.59.2",
+  "version": "8.59.3",
   "description": "ICE MT UI Platform CLI",
   "sideEffects": false,
   "main": "./dist/cjs/index.cjs",
@@ -68,10 +68,10 @@
     "@babel/plugin-transform-react-inline-elements": "~7.27.1",
     "@babel/plugin-transform-react-jsx-source": "~7.27.1",
     "@babel/plugin-transform-runtime": "~7.29.0",
-    "@babel/preset-env": "~7.29.0",
+    "@babel/preset-env": "~7.29.2",
     "@babel/preset-react": "~7.28.5",
     "@babel/preset-typescript": "~7.28.5",
-    "@babel/runtime": "~7.28.6",
+    "@babel/runtime": "~7.29.2",
     "@commitlint/cli": "~17.8.1",
     "@commitlint/config-conventional": "~17.8.1",
     "@elliemae/browserslist-config-elliemae-latest-browsers": "~1.14.4",
@@ -133,7 +133,7 @@
     "babel-plugin-dynamic-import-node": "~2.3.3",
     "babel-plugin-import-remove-resource-query": "~1.0.0",
     "babel-plugin-lodash": "~3.3.4",
-    "babel-plugin-module-resolver": "~5.0.2",
+    "babel-plugin-module-resolver": "~5.0.3",
     "babel-plugin-source-map-support": "~2.2.0",
     "babel-plugin-styled-components": "~2.1.4",
     "babel-plugin-transform-import-meta": "~2.3.3",
@@ -158,8 +158,8 @@
     "dotenv": "~16.6.1",
     "dotenv-webpack": "~8.1.1",
     "duplicate-package-checker-webpack-plugin": "~3.0.0",
-    "enhanced-resolve": "~5.20.0",
-    "esbuild": "~0.27.3",
+    "enhanced-resolve": "~5.20.1",
+    "esbuild": "~0.27.4",
     "esbuild-loader": "~3.2.0",
     "esbuild-plugin-svgr": "~1.1.0",
     "eslint": "~8.57.1",
@@ -213,7 +213,7 @@
     "jsdoc": "~4.0.5",
     "lerna": "~6.6.2",
     "lint-staged": "~13.3.0",
-    "mini-css-extract-plugin": "~2.10.0",
+    "mini-css-extract-plugin": "~2.10.1",
     "minimist": "~1.2.8",
     "moment": "~2.30.1",
     "moment-locales-webpack-plugin": "~1.2.0",
@@ -234,7 +234,7 @@
     "postcss-preset-env": "9.6.0",
     "prettier": "~2.8.8",
     "prisma": "~4.16.2",
-    "pug": "~3.0.3",
+    "pug": "~3.0.4",
     "pug-loader": "~2.4.0",
     "raf": "~3.4.1",
     "react-docgen": "~5.4.3",

package/build/docs/assets/js/16b7bc88.e21c4658.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[6130],{1132(e,i,a){a.r(i),a.d(i,{assets:()=>c,contentTitle:()=>n,default:()=>d,frontMatter:()=>r,metadata:()=>s,toc:()=>p});const s=JSON.parse('{"id":"api/type-aliases/LIB_NAME","title":"LIB\\\\_NAME","description":"","source":"@site/docs/api/type-aliases/LIB_NAME.md","sourceDirName":"api/type-aliases","slug":"/api/type-aliases/LIB_NAME","permalink":"/cli/api/type-aliases/LIB_NAME","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/type-aliases/LIB_NAME.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"loadRoutes()","permalink":"/cli/api/functions/loadRoutes"},"next":{"title":"babelConfig","permalink":"/cli/api/variables/babelConfig"}}');var t=a(6070),l=a(116);const r={},n="LIB_NAME",c={},p=[];function o(e){const i={code:"code",h1:"h1",header:"header",pre:"pre",...(0,l.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(i.header,{children:(0,t.jsx)(i.h1,{id:"lib_name",children:"LIB_NAME"})}),"\n",(0,t.jsx)(i.pre,{children:(0,t.jsx)(i.code,{className:"language-ts",children:'type LIB_NAME = "pui-cli";\n'})})]})}function d(e={}){const{wrapper:i}={...(0,l.R)(),...e.components};return i?(0,t.jsx)(i,{...e,children:(0,t.jsx)(o,{...e})}):o(e)}}}]);

package/build/docs/assets/js/5e8c322a.5e039cd2.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[594],{706(i,e,s){s.r(e),s.d(e,{assets:()=>a,contentTitle:()=>d,default:()=>j,frontMatter:()=>t,metadata:()=>l,toc:()=>c});const l=JSON.parse('{"id":"api/index","title":"Cli API","description":"Functions","source":"@site/docs/api/index.md","sourceDirName":"api","slug":"/api/","permalink":"/cli/api/","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/index.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","next":{"title":"loadRoutes()","permalink":"/cli/api/functions/loadRoutes"}}');var n=s(6070),r=s(116);const t={},d="Cli API",a={},c=[{value:"Functions",id:"functions",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"Variables",id:"variables",level:2}];function h(i){const e={a:"a",h1:"h1",h2:"h2",header:"header",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.R)(),...i.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(e.header,{children:(0,n.jsx)(e.h1,{id:"cli-api",children:"Cli API"})}),"\n",(0,n.jsx)(e.h2,{id:"functions",children:"Functions"}),"\n",(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{children:"Function"}),(0,n.jsx)(e.th,{children:"Description"})]})}),(0,n.jsx)(e.tbody,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/functions/loadRoutes",children:"loadRoutes"})}),(0,n.jsx)(e.td,{children:"-"})]})})]}),"\n",(0,n.jsx)(e.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{children:"Type Alias"}),(0,n.jsx)(e.th,{children:"Description"})]})}),(0,n.jsx)(e.tbody,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/type-aliases/LIB_NAME",children:"LIB_NAME"})}),(0,n.jsx)(e.td,{children:"-"})]})})]}),"\n",(0,n.jsx)(e.h2,{id:"variables",children:"Variables"}),"\n",(0,n.jsxs)(e.table,{children:[(0,n.jsx)(e.thead,{children:(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.th,{children:"Variable"}),(0,n.jsx)(e.th,{children:"Description"})]})}),(0,n.jsxs)(e.tbody,{children:[(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/babelConfig",children:"babelConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/commitlintConfig",children:"commitlintConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/eslintBaseConfig",children:"eslintBaseConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/eslintConfig",children:"eslintConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/jestConfig",children:"jestConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/jestNodeConfig",children:"jestNodeConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/lintStagedConfig",children:"lintStagedConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/prettierConfig",children:"prettierConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/stylelintConfig",children:"stylelintConfig"})}),(0,n.jsx)(e.td,{children:"-"})]}),(0,n.jsxs)(e.tr,{children:[(0,n.jsx)(e.td,{children:(0,n.jsx)(e.a,{href:"/cli/api/variables/vitestConfig",children:"vitestConfig"})}),(0,n.jsx)(e.td,{children:"-"})]})]})]})]})}function j(i={}){const{wrapper:e}={...(0,r.R)(),...i.components};return e?(0,n.jsx)(e,{...i,children:(0,n.jsx)(h,{...i})}):h(i)}}}]);

package/build/docs/assets/js/5e95c892.213dbdd2.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[9647],{4725(e,l,a){a.r(l),a.d(l,{default:()=>n});a(758);var i=a(3526),s=a(5808),r=a(3859),u=a(1977),c=a(6400),h=a(6070);function n(e){return(0,h.jsx)(r.e3,{className:(0,i.A)(s.G.wrapper.docsPages),children:(0,h.jsx)(c.A,{children:(0,u.v)(e.route.routes)})})}}}]);

package/build/docs/assets/js/a94703ab.e1cb3d49.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[9048],{7517(e,t,n){n.r(t),n.d(t,{default:()=>Se});var a=n(758),i=n(3526),s=n(3859),o=n(5808),l=n(1639),r=n(290),c=n(4137),d=n(6015),u=n(7193);const m="backToTopButton_ix_O",b="backToTopButtonShow_rCzR";var h=n(6070);function p(){const{shown:e,scrollToTop:t}=function({threshold:e}){const[t,n]=(0,a.useState)(!1),i=(0,a.useRef)(!1),{startScroll:s,cancelScroll:o}=(0,d.gk)();return(0,d.Mq)(({scrollY:t},a)=>{const s=a?.scrollY;s&&(i.current?i.current=!1:t>=s?(o(),n(!1)):t<e?n(!1):t+window.innerHeight<document.documentElement.scrollHeight&&n(!0))}),(0,u.$)(e=>{e.location.hash&&(i.current=!0,n(!1))}),{shown:t,scrollToTop:()=>s(0)}}({threshold:300});return(0,h.jsx)("button",{"aria-label":(0,c.T)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,i.A)("clean-btn",o.G.common.backToTopButton,m,e&&b),type:"button",onClick:t})}var x=n(9880),f=n(5557),j=n(9094),_=n(9799),g=n(4149);function v(e){return(0,h.jsx)("svg",{width:"20",height:"20","aria-hidden":"true",...e,children:(0,h.jsxs)("g",{fill:"#7a7a7a",children:[(0,h.jsx)("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),(0,h.jsx)("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})]})})}const C="collapseSidebarButton_Hqcf",A="collapseSidebarButtonIcon_l8qE";function k({onClick:e}){return(0,h.jsx)("button",{type:"button",title:(0,c.T)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,i.A)("button button--secondary button--outline",C),onClick:e,children:(0,h.jsx)(v,{className:A})})}var S=n(4816),N=n(5621);const T=Symbol("EmptyContext"),I=a.createContext(T);function y({children:e}){const[t,n]=(0,a.useState)(null),i=(0,a.useMemo)(()=>({expandedItem:t,setExpandedItem:n}),[t]);return(0,h.jsx)(I.Provider,{value:i,children:e})}var L=n(8403),w=n(9106),E=n(4416),B=n(5625),M=n(1016),H=n(8557);const P="menuExternalLink_gM4P",G="linkLabel_V85i";function R({label:e}){return(0,h.jsx)("span",{title:e,className:G,children:e})}function W({item:e,onItemClick:t,activePath:n,level:a,index:s,...r}){const{href:c,label:d,className:u,autoAddBaseUrl:m}=e,b=(0,l.w8)(e,n),p=(0,M.A)(c);return(0,h.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(a),"menu__list-item",u),children:(0,h.jsxs)(E.A,{className:(0,i.A)("menu__link",!p&&P,{"menu__link--active":b}),autoAddBaseUrl:m,"aria-current":b?"page":void 0,to:c,...p&&{onClick:t?()=>t(e):void 0},...r,children:[(0,h.jsx)(R,{label:d}),!p&&(0,h.jsx)(H.A,{})]})},d)}const D="categoryLink_SsXY",V="categoryLinkLabel_nLXV";function F({collapsed:e,categoryLabel:t,onClick:n}){return(0,h.jsx)("button",{"aria-label":e?(0,c.T)({id:"theme.DocSidebarItem.expandCategoryAriaLabel",message:"Expand sidebar category '{label}'",description:"The ARIA label to expand the sidebar category"},{label:t}):(0,c.T)({id:"theme.DocSidebarItem.collapseCategoryAriaLabel",message:"Collapse sidebar category '{label}'",description:"The ARIA label to collapse the sidebar category"},{label:t}),"aria-expanded":!e,type:"button",className:"clean-btn menu__caret",onClick:n})}function Y({label:e}){return(0,h.jsx)("span",{title:e,className:V,children:e})}function O(e){return 0===(0,l.Y)(e.item.items,e.activePath).length?(0,h.jsx)(z,{...e}):(0,h.jsx)(U,{...e})}function z({item:e,...t}){if("string"!=typeof e.href)return null;const{type:n,collapsed:a,collapsible:i,items:s,linkUnlisted:o,...l}=e,r={type:"link",...l};return(0,h.jsx)(W,{item:r,...t})}function U({item:e,onItemClick:t,activePath:n,level:s,index:r,...c}){const{items:d,label:u,collapsible:m,className:b,href:p}=e,{docs:{sidebar:{autoCollapseCategories:x}}}=(0,_.p)(),f=function(e){const t=(0,B.A)();return(0,a.useMemo)(()=>e.href&&!e.linkUnlisted?e.href:!t&&e.collapsible?(0,l.Nr)(e):void 0,[e,t])}(e),j=(0,l.w8)(e,n),g=(0,w.ys)(p,n),{collapsed:v,setCollapsed:C}=(0,L.u)({initialState:()=>!!m&&(!j&&e.collapsed)}),{expandedItem:A,setExpandedItem:k}=function(){const e=(0,a.useContext)(I);if(e===T)throw new N.dV("DocSidebarItemsExpandedStateProvider");return e}(),S=(e=!v)=>{k(e?null:r),C(e)};!function({isActive:e,collapsed:t,updateCollapsed:n,activePath:i}){const s=(0,N.ZC)(e),o=(0,N.ZC)(i);(0,a.useEffect)(()=>{(e&&!s||e&&s&&i!==o)&&t&&n(!1)},[e,s,t,n,i,o])}({isActive:j,collapsed:v,updateCollapsed:S,activePath:n}),(0,a.useEffect)(()=>{m&&null!=A&&A!==r&&x&&C(!0)},[m,A,r,C,x]);return(0,h.jsxs)("li",{className:(0,i.A)(o.G.docs.docSidebarItemCategory,o.G.docs.docSidebarItemCategoryLevel(s),"menu__list-item",{"menu__list-item--collapsed":v},b),children:[(0,h.jsxs)("div",{className:(0,i.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":g}),children:[(0,h.jsx)(E.A,{className:(0,i.A)(D,"menu__link",{"menu__link--sublist":m,"menu__link--sublist-caret":!p&&m,"menu__link--active":j}),onClick:n=>{t?.(e),m&&(p?g?(n.preventDefault(),S()):S(!1):(n.preventDefault(),S()))},"aria-current":g?"page":void 0,role:m&&!p?"button":void 0,"aria-expanded":m&&!p?!v:void 0,href:m?f??"#":f,...c,children:(0,h.jsx)(Y,{label:u})}),p&&m&&(0,h.jsx)(F,{collapsed:v,categoryLabel:u,onClick:e=>{e.preventDefault(),S()}})]}),(0,h.jsx)(L.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:v,children:(0,h.jsx)(Q,{items:d,tabIndex:v?-1:0,onItemClick:t,activePath:n,level:s+1})})]})}const q="menuHtmlItem_eQOO";function X({item:e,level:t,index:n}){const{value:a,defaultStyle:s,className:l}=e;return(0,h.jsx)("li",{className:(0,i.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(t),s&&[q,"menu__list-item"],l),dangerouslySetInnerHTML:{__html:a}},n)}function Z({item:e,...t}){switch(e.type){case"category":return(0,h.jsx)(O,{item:e,...t});case"html":return(0,h.jsx)(X,{item:e,...t});default:return(0,h.jsx)(W,{item:e,...t})}}function K({items:e,...t}){const n=(0,l.Y)(e,t.activePath);return(0,h.jsx)(y,{children:n.map((e,n)=>(0,h.jsx)(Z,{item:e,index:n,...t},n))})}const Q=(0,a.memo)(K),$="menu_wWfF",J="menuWithAnnouncementBar_Tbku";function ee({path:e,sidebar:t,className:n}){const s=function(){const{isActive:e}=(0,S.M)(),[t,n]=(0,a.useState)(e);return(0,d.Mq)(({scrollY:t})=>{e&&n(0===t)},[e]),e&&t}();return(0,h.jsx)("nav",{"aria-label":(0,c.T)({id:"theme.docs.sidebar.navAriaLabel",message:"Docs sidebar",description:"The ARIA label for the sidebar navigation"}),className:(0,i.A)("menu thin-scrollbar",$,s&&J,n),children:(0,h.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,h.jsx)(Q,{items:t,activePath:e,level:1})})})}const te="sidebar_hKKp",ne="sidebarWithHideableNavbar_BehI",ae="sidebarHidden_rlx9",ie="sidebarLogo_EyyD";function se({path:e,sidebar:t,onCollapse:n,isHidden:a}){const{navbar:{hideOnScroll:s},docs:{sidebar:{hideable:o}}}=(0,_.p)();return(0,h.jsxs)("div",{className:(0,i.A)(te,s&&ne,a&&ae),children:[s&&(0,h.jsx)(g.A,{tabIndex:-1,className:ie}),(0,h.jsx)(ee,{path:e,sidebar:t}),o&&(0,h.jsx)(k,{onClick:n})]})}const oe=a.memo(se);var le=n(413),re=n(3652);const ce=({sidebar:e,path:t})=>{const n=(0,re.M)();return(0,h.jsx)("ul",{className:(0,i.A)(o.G.docs.docSidebarMenu,"menu__list"),children:(0,h.jsx)(Q,{items:e,activePath:t,onItemClick:e=>{"category"===e.type&&e.href&&n.toggle(),"link"===e.type&&n.toggle()},level:1})})};function de(e){return(0,h.jsx)(le.GX,{component:ce,props:e})}const ue=a.memo(de);function me(e){const t=(0,j.l)(),n="desktop"===t||"ssr"===t,a="mobile"===t;return(0,h.jsxs)(h.Fragment,{children:[n&&(0,h.jsx)(oe,{...e}),a&&(0,h.jsx)(ue,{...e})]})}const be="expandButton_uIWB",he="expandButtonIcon_Obai";function pe({toggleSidebar:e}){return(0,h.jsx)("div",{className:be,title:(0,c.T)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,c.T)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:e,onClick:e,children:(0,h.jsx)(v,{className:he})})}const xe={docSidebarContainer:"docSidebarContainer_XarW",docSidebarContainerHidden:"docSidebarContainerHidden_ys4Y",sidebarViewport:"sidebarViewport_ZS69"};function fe({children:e}){const t=(0,r.t)();return(0,h.jsx)(a.Fragment,{children:e},t?.name??"noSidebar")}function je({sidebar:e,hiddenSidebarContainer:t,setHiddenSidebarContainer:n}){const{pathname:s}=(0,f.zy)(),[l,r]=(0,a.useState)(!1),c=(0,a.useCallback)(()=>{l&&r(!1),!l&&(0,x.O)()&&r(!0),n(e=>!e)},[n,l]);return(0,h.jsx)("aside",{className:(0,i.A)(o.G.docs.docSidebarContainer,xe.docSidebarContainer,t&&xe.docSidebarContainerHidden),onTransitionEnd:e=>{e.currentTarget.classList.contains(xe.docSidebarContainer)&&t&&r(!0)},children:(0,h.jsx)(fe,{children:(0,h.jsxs)("div",{className:(0,i.A)(xe.sidebarViewport,l&&xe.sidebarViewportHidden),children:[(0,h.jsx)(me,{sidebar:e,path:s,onCollapse:c,isHidden:l}),l&&(0,h.jsx)(pe,{toggleSidebar:c})]})})})}const _e={docMainContainer:"docMainContainer_fp8e",docMainContainerEnhanced:"docMainContainerEnhanced_coBE",docItemWrapperEnhanced:"docItemWrapperEnhanced_wm_S"};function ge({hiddenSidebarContainer:e,children:t}){const n=(0,r.t)();return(0,h.jsx)("main",{className:(0,i.A)(_e.docMainContainer,(e||!n)&&_e.docMainContainerEnhanced),children:(0,h.jsx)("div",{className:(0,i.A)("container padding-top--md padding-bottom--lg",_e.docItemWrapper,e&&_e.docItemWrapperEnhanced),children:t})})}const ve="docRoot_R30Z",Ce="docsWrapper_Im2T";function Ae({children:e}){const t=(0,r.t)(),[n,i]=(0,a.useState)(!1);return(0,h.jsxs)("div",{className:Ce,children:[(0,h.jsx)(p,{}),(0,h.jsxs)("div",{className:ve,children:[t&&(0,h.jsx)(je,{sidebar:t.items,hiddenSidebarContainer:n,setHiddenSidebarContainer:i}),(0,h.jsx)(ge,{hiddenSidebarContainer:n,children:e})]})]})}var ke=n(695);function Se(e){const t=(0,l.B5)(e);if(!t)return(0,h.jsx)(ke.A,{});const{docElement:n,sidebarName:a,sidebarItems:c}=t;return(0,h.jsx)(s.e3,{className:(0,i.A)(o.G.page.docsDocPage),children:(0,h.jsx)(r.V,{name:a,items:c,children:(0,h.jsx)(Ae,{children:n})})})}},695(e,t,n){n.d(t,{A:()=>l});n(758);var a=n(3526),i=n(4137),s=n(3283),o=n(6070);function l({className:e}){return(0,o.jsx)("main",{className:(0,a.A)("container margin-vert--xl",e),children:(0,o.jsx)("div",{className:"row",children:(0,o.jsxs)("div",{className:"col col--6 col--offset-3",children:[(0,o.jsx)(s.A,{as:"h1",className:"hero__title",children:(0,o.jsx)(i.A,{id:"theme.NotFound.title",description:"The title of the 404 page",children:"Page Not Found"})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page",children:"We could not find what you were looking for."})}),(0,o.jsx)("p",{children:(0,o.jsx)(i.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page",children:"Please contact the owner of the site that linked you to the original URL and let them know their link is broken."})})]})})})}}}]);

package/build/docs/assets/js/b8ac1d98.fd584c0a.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[7613],{875(e,n,s){s.r(n),s.d(n,{assets:()=>o,contentTitle:()=>t,default:()=>d,frontMatter:()=>i,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"api/variables/eslintConfig","title":"eslintConfig","description":"Type Declaration","source":"@site/docs/api/variables/eslintConfig.md","sourceDirName":"api/variables","slug":"/api/variables/eslintConfig","permalink":"/cli/api/variables/eslintConfig","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/api/variables/eslintConfig.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"eslintBaseConfig","permalink":"/cli/api/variables/eslintBaseConfig"},"next":{"title":"jestConfig","permalink":"/cli/api/variables/jestConfig"}}');var l=s(6070),a=s(116);const i={},t="eslintConfig",o={},c=[{value:"Type Declaration",id:"type-declaration",level:2},{value:"env",id:"env",level:3},{value:"env.browser",id:"envbrowser",level:4},{value:"env.es2021",id:"enves2021",level:4},{value:"env.jest",id:"envjest",level:4},{value:"env.node",id:"envnode",level:4},{value:"extends",id:"extends",level:3},{value:"ignorePatterns",id:"ignorepatterns",level:3},{value:"overrides",id:"overrides",level:3},{value:"parser",id:"parser",level:3},{value:"parserOptions",id:"parseroptions",level:3},{value:"parserOptions.babelOptions",id:"parseroptionsbabeloptions",level:4},{value:"parserOptions.babelOptions.plugins",id:"parseroptionsbabeloptionsplugins",level:4},{value:"parserOptions.ecmaFeatures",id:"parseroptionsecmafeatures",level:4},{value:"parserOptions.ecmaFeatures.jsx",id:"parseroptionsecmafeaturesjsx",level:4},{value:"parserOptions.sourceType",id:"parseroptionssourcetype",level:4},{value:"plugins",id:"plugins",level:3},{value:"rules",id:"rules",level:3},{value:"rules.arrow-body-style",id:"rulesarrow-body-style",level:4},{value:"rules.class-methods-use-this",id:"rulesclass-methods-use-this",level:4},{value:"rules.complexity",id:"rulescomplexity",level:4},{value:"rules.eslint-comments/disable-enable-pair",id:"ruleseslint-commentsdisable-enable-pair",level:4},{value:"rules.import/extensions",id:"rulesimportextensions",level:4},{value:"rules.import/imports-first",id:"rulesimportimports-first",level:4},{value:"rules.import/newline-after-import",id:"rulesimportnewline-after-import",level:4},{value:"rules.import/no-dynamic-require",id:"rulesimportno-dynamic-require",level:4},{value:"rules.import/no-extraneous-dependencies",id:"rulesimportno-extraneous-dependencies",level:4},{value:"rules.import/no-named-as-default",id:"rulesimportno-named-as-default",level:4},{value:"rules.import/no-unresolved",id:"rulesimportno-unresolved",level:4},{value:"rules.import/no-webpack-loader-syntax",id:"rulesimportno-webpack-loader-syntax",level:4},{value:"rules.import/prefer-default-export",id:"rulesimportprefer-default-export",level:4},{value:"rules.indent",id:"rulesindent",level:4},{value:"rules.jsdoc/require-jsdoc",id:"rulesjsdocrequire-jsdoc",level:4},{value:"rules.jsx-a11y/aria-props",id:"rulesjsx-a11yaria-props",level:4},{value:"rules.jsx-a11y/heading-has-content",id:"rulesjsx-a11yheading-has-content",level:4},{value:"rules.jsx-a11y/label-has-associated-control",id:"rulesjsx-a11ylabel-has-associated-control",level:4},{value:"rules.jsx-a11y/label-has-for",id:"rulesjsx-a11ylabel-has-for",level:4},{value:"rules.jsx-a11y/mouse-events-have-key-events",id:"rulesjsx-a11ymouse-events-have-key-events",level:4},{value:"rules.jsx-a11y/role-has-required-aria-props",id:"rulesjsx-a11yrole-has-required-aria-props",level:4},{value:"rules.jsx-a11y/role-supports-aria-props",id:"rulesjsx-a11yrole-supports-aria-props",level:4},{value:"rules.max-depth",id:"rulesmax-depth",level:4},{value:"rules.max-len",id:"rulesmax-len",level:4},{value:"rules.max-lines",id:"rulesmax-lines",level:4},{value:"rules.max-lines-per-function",id:"rulesmax-lines-per-function",level:4},{value:"rules.max-nested-callbacks",id:"rulesmax-nested-callbacks",level:4},{value:"rules.max-params",id:"rulesmax-params",level:4},{value:"rules.max-statements",id:"rulesmax-statements",level:4},{value:"rules.newline-per-chained-call",id:"rulesnewline-per-chained-call",level:4},{value:"rules.no-confusing-arrow",id:"rulesno-confusing-arrow",level:4},{value:"rules.no-console",id:"rulesno-console",level:4},{value:"rules.no-param-reassign",id:"rulesno-param-reassign",level:4},{value:"rules.no-unused-vars",id:"rulesno-unused-vars",level:4},{value:"rules.no-use-before-define",id:"rulesno-use-before-define",level:4},{value:"rules.prefer-template",id:"rulesprefer-template",level:4},{value:"rules.prettier/prettier",id:"rulesprettierprettier",level:4},{value:"rules.react-hooks/rules-of-hooks",id:"rulesreact-hooksrules-of-hooks",level:4},{value:"rules.react/destructuring-assignment",id:"rulesreactdestructuring-assignment",level:4},{value:"rules.react/forbid-prop-types",id:"rulesreactforbid-prop-types",level:4},{value:"rules.react/function-component-definition",id:"rulesreactfunction-component-definition",level:4},{value:"rules.react/jsx-closing-tag-location",id:"rulesreactjsx-closing-tag-location",level:4},{value:"rules.react/jsx-filename-extension",id:"rulesreactjsx-filename-extension",level:4},{value:"rules.react/jsx-first-prop-new-line",id:"rulesreactjsx-first-prop-new-line",level:4},{value:"rules.react/jsx-no-target-blank",id:"rulesreactjsx-no-target-blank",level:4},{value:"rules.react/jsx-props-no-spreading",id:"rulesreactjsx-props-no-spreading",level:4},{value:"rules.react/jsx-uses-vars",id:"rulesreactjsx-uses-vars",level:4},{value:"rules.react/react-in-jsx-scope",id:"rulesreactreact-in-jsx-scope",level:4},{value:"rules.react/require-default-props",id:"rulesreactrequire-default-props",level:4},{value:"rules.react/require-extension",id:"rulesreactrequire-extension",level:4},{value:"rules.react/self-closing-comp",id:"rulesreactself-closing-comp",level:4},{value:"rules.react/sort-comp",id:"rulesreactsort-comp",level:4},{value:"rules.redux-saga/no-yield-in-race",id:"rulesredux-sagano-yield-in-race",level:4},{value:"rules.redux-saga/yield-effects",id:"rulesredux-sagayield-effects",level:4},{value:"rules.require-yield",id:"rulesrequire-yield",level:4},{value:"settings",id:"settings",level:3},{value:"settings.import/resolver",id:"settingsimportresolver",level:4},{value:"settings.import/resolver.node",id:"settingsimportresolvernode",level:4},{value:"settings.import/resolver.node.extensions",id:"settingsimportresolvernodeextensions",level:4},{value:"settings.jest",id:"settingsjest",level:4},{value:"settings.jest.version",id:"settingsjestversion",level:4},{value:"settings.react",id:"settingsreact",level:4},{value:"settings.react.version",id:"settingsreactversion",level:4}];function u(e){const n={code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",pre:"pre",...(0,a.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"eslintconfig",children:"eslintConfig"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"eslintConfig: {\n  env: {\n     browser: boolean;\n     es2021: boolean;\n     jest: boolean;\n     node: boolean;\n  };\n  extends: string[];\n  ignorePatterns: string[];\n  overrides: {\n     files: string[];\n     rules: {\n        jest/valid-expect: string;\n     };\n  }[];\n  parser: string;\n  parserOptions: {\n     babelOptions: {\n        plugins: string[];\n     };\n     ecmaFeatures: {\n        jsx: boolean;\n     };\n     sourceType: string;\n  };\n  plugins: string[];\n  rules: {\n     arrow-body-style: (string | number)[];\n     class-methods-use-this: number;\n     complexity: (\n        | string\n        | {\n        max: number;\n     })[];\n     eslint-comments/disable-enable-pair: number;\n     import/extensions: (\n        | string\n        | number\n        | {\n        js: string;\n        json: string;\n     })[];\n     import/imports-first: number;\n     import/newline-after-import: number;\n     import/no-dynamic-require: number;\n     import/no-extraneous-dependencies: number;\n     import/no-named-as-default: number;\n     import/no-unresolved: (\n        | number\n        | {\n        caseSensitive: boolean;\n        caseSensitiveStrict: boolean;\n     })[];\n     import/no-webpack-loader-syntax: number;\n     import/prefer-default-export: number;\n     indent: (\n        | number\n        | {\n        SwitchCase: number;\n     })[];\n     jsdoc/require-jsdoc: number;\n     jsx-a11y/aria-props: number;\n     jsx-a11y/heading-has-content: number;\n     jsx-a11y/label-has-associated-control: (\n        | number\n        | {\n        controlComponents: string[];\n     })[];\n     jsx-a11y/label-has-for: number;\n     jsx-a11y/mouse-events-have-key-events: number;\n     jsx-a11y/role-has-required-aria-props: number;\n     jsx-a11y/role-supports-aria-props: number;\n     max-depth: (\n        | string\n        | {\n        max: number;\n     })[];\n     max-len: number;\n     max-lines: (\n        | string\n        | {\n        max: number;\n        skipComments: boolean;\n     })[];\n     max-lines-per-function: number;\n     max-nested-callbacks: (\n        | string\n        | {\n        max: number;\n     })[];\n     max-params: (\n        | string\n        | {\n        max: number;\n     })[];\n     max-statements: (\n        | string\n        | {\n        max: number;\n     })[];\n     newline-per-chained-call: number;\n     no-confusing-arrow: number;\n     no-console: number;\n     no-param-reassign: (\n        | string\n        | {\n        props: boolean;\n     })[];\n     no-unused-vars: number;\n     no-use-before-define: number;\n     prefer-template: number;\n     prettier/prettier: (string | __module)[];\n     react-hooks/rules-of-hooks: string;\n     react/destructuring-assignment: number;\n     react/forbid-prop-types: number;\n     react/function-component-definition: (\n        | number\n        | {\n        namedComponents: string;\n     })[];\n     react/jsx-closing-tag-location: number;\n     react/jsx-filename-extension: (\n        | number\n        | {\n        extensions: string[];\n     })[];\n     react/jsx-first-prop-new-line: (string | number)[];\n     react/jsx-no-target-blank: number;\n     react/jsx-props-no-spreading: number;\n     react/jsx-uses-vars: number;\n     react/react-in-jsx-scope: number;\n     react/require-default-props: number;\n     react/require-extension: number;\n     react/self-closing-comp: number;\n     react/sort-comp: number;\n     redux-saga/no-yield-in-race: number;\n     redux-saga/yield-effects: number;\n     require-yield: number;\n  };\n  settings: {\n     import/resolver: {\n        node: {\n           extensions: string[];\n        };\n     };\n     jest: {\n        version: number;\n     };\n     react: {\n        version: string;\n     };\n  };\n};\n"})}),"\n",(0,l.jsx)(n.h2,{id:"type-declaration",children:"Type Declaration"}),"\n",(0,l.jsx)(n.h3,{id:"env",children:"env"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"env: {\n  browser: boolean;\n  es2021: boolean;\n  jest: boolean;\n  node: boolean;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envbrowser",children:"env.browser"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"browser: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"enves2021",children:"env.es2021"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"es2021: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envjest",children:"env.jest"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jest: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"envnode",children:"env.node"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"node: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"extends",children:"extends"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"extends: string[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"ignorepatterns",children:"ignorePatterns"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ignorePatterns: string[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"overrides",children:"overrides"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"overrides: {\n  files: string[];\n  rules: {\n     jest/valid-expect: string;\n  };\n}[];\n"})}),"\n",(0,l.jsx)(n.h3,{id:"parser",children:"parser"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'parser: string = "@babel/eslint-parser";\n'})}),"\n",(0,l.jsx)(n.h3,{id:"parseroptions",children:"parserOptions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"parserOptions: {\n  babelOptions: {\n     plugins: string[];\n  };\n  ecmaFeatures: {\n     jsx: boolean;\n  };\n  sourceType: string;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsbabeloptions",children:"parserOptions.babelOptions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"babelOptions: {\n  plugins: string[];\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsbabeloptionsplugins",children:"parserOptions.babelOptions.plugins"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"plugins: string[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsecmafeatures",children:"parserOptions.ecmaFeatures"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"ecmaFeatures: {\n  jsx: boolean;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionsecmafeaturesjsx",children:"parserOptions.ecmaFeatures.jsx"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx: boolean = true;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"parseroptionssourcetype",children:"parserOptions.sourceType"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'sourceType: string = "module";\n'})}),"\n",(0,l.jsx)(n.h3,{id:"plugins",children:"plugins"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"plugins: string[] = basePlugins;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"rules",children:"rules"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"rules: {\n  arrow-body-style: (string | number)[];\n  class-methods-use-this: number;\n  complexity: (\n     | string\n     | {\n     max: number;\n  })[];\n  eslint-comments/disable-enable-pair: number;\n  import/extensions: (\n     | string\n     | number\n     | {\n     js: string;\n     json: string;\n  })[];\n  import/imports-first: number;\n  import/newline-after-import: number;\n  import/no-dynamic-require: number;\n  import/no-extraneous-dependencies: number;\n  import/no-named-as-default: number;\n  import/no-unresolved: (\n     | number\n     | {\n     caseSensitive: boolean;\n     caseSensitiveStrict: boolean;\n  })[];\n  import/no-webpack-loader-syntax: number;\n  import/prefer-default-export: number;\n  indent: (\n     | number\n     | {\n     SwitchCase: number;\n  })[];\n  jsdoc/require-jsdoc: number;\n  jsx-a11y/aria-props: number;\n  jsx-a11y/heading-has-content: number;\n  jsx-a11y/label-has-associated-control: (\n     | number\n     | {\n     controlComponents: string[];\n  })[];\n  jsx-a11y/label-has-for: number;\n  jsx-a11y/mouse-events-have-key-events: number;\n  jsx-a11y/role-has-required-aria-props: number;\n  jsx-a11y/role-supports-aria-props: number;\n  max-depth: (\n     | string\n     | {\n     max: number;\n  })[];\n  max-len: number;\n  max-lines: (\n     | string\n     | {\n     max: number;\n     skipComments: boolean;\n  })[];\n  max-lines-per-function: number;\n  max-nested-callbacks: (\n     | string\n     | {\n     max: number;\n  })[];\n  max-params: (\n     | string\n     | {\n     max: number;\n  })[];\n  max-statements: (\n     | string\n     | {\n     max: number;\n  })[];\n  newline-per-chained-call: number;\n  no-confusing-arrow: number;\n  no-console: number;\n  no-param-reassign: (\n     | string\n     | {\n     props: boolean;\n  })[];\n  no-unused-vars: number;\n  no-use-before-define: number;\n  prefer-template: number;\n  prettier/prettier: (string | __module)[];\n  react-hooks/rules-of-hooks: string;\n  react/destructuring-assignment: number;\n  react/forbid-prop-types: number;\n  react/function-component-definition: (\n     | number\n     | {\n     namedComponents: string;\n  })[];\n  react/jsx-closing-tag-location: number;\n  react/jsx-filename-extension: (\n     | number\n     | {\n     extensions: string[];\n  })[];\n  react/jsx-first-prop-new-line: (string | number)[];\n  react/jsx-no-target-blank: number;\n  react/jsx-props-no-spreading: number;\n  react/jsx-uses-vars: number;\n  react/react-in-jsx-scope: number;\n  react/require-default-props: number;\n  react/require-extension: number;\n  react/self-closing-comp: number;\n  react/sort-comp: number;\n  redux-saga/no-yield-in-race: number;\n  redux-saga/yield-effects: number;\n  require-yield: number;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesarrow-body-style",children:"rules.arrow-body-style"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"arrow-body-style: (string | number)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesclass-methods-use-this",children:"rules.class-methods-use-this"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"class-methods-use-this: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulescomplexity",children:"rules.complexity"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"complexity: (\n  | string\n  | {\n  max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"ruleseslint-commentsdisable-enable-pair",children:"rules.eslint-comments/disable-enable-pair"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"eslint-comments/disable-enable-pair: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportextensions",children:"rules.import/extensions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/extensions: (\n  | string\n  | number\n  | {\n  js: string;\n  json: string;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportimports-first",children:"rules.import/imports-first"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/imports-first: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportnewline-after-import",children:"rules.import/newline-after-import"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/newline-after-import: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-dynamic-require",children:"rules.import/no-dynamic-require"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-dynamic-require: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-extraneous-dependencies",children:"rules.import/no-extraneous-dependencies"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-extraneous-dependencies: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-named-as-default",children:"rules.import/no-named-as-default"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-named-as-default: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-unresolved",children:"rules.import/no-unresolved"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-unresolved: (\n  | number\n  | {\n  caseSensitive: boolean;\n  caseSensitiveStrict: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportno-webpack-loader-syntax",children:"rules.import/no-webpack-loader-syntax"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/no-webpack-loader-syntax: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesimportprefer-default-export",children:"rules.import/prefer-default-export"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/prefer-default-export: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesindent",children:"rules.indent"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"indent: (\n  | number\n  | {\n  SwitchCase: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsdocrequire-jsdoc",children:"rules.jsdoc/require-jsdoc"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsdoc/require-jsdoc: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yaria-props",children:"rules.jsx-a11y/aria-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/aria-props: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yheading-has-content",children:"rules.jsx-a11y/heading-has-content"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/heading-has-content: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11ylabel-has-associated-control",children:"rules.jsx-a11y/label-has-associated-control"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/label-has-associated-control: (\n  | number\n  | {\n  controlComponents: string[];\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11ylabel-has-for",children:"rules.jsx-a11y/label-has-for"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/label-has-for: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11ymouse-events-have-key-events",children:"rules.jsx-a11y/mouse-events-have-key-events"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/mouse-events-have-key-events: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yrole-has-required-aria-props",children:"rules.jsx-a11y/role-has-required-aria-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/role-has-required-aria-props: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesjsx-a11yrole-supports-aria-props",children:"rules.jsx-a11y/role-supports-aria-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jsx-a11y/role-supports-aria-props: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-depth",children:"rules.max-depth"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-depth: (\n  | string\n  | {\n  max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-len",children:"rules.max-len"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-len: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-lines",children:"rules.max-lines"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-lines: (\n  | string\n  | {\n  max: number;\n  skipComments: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-lines-per-function",children:"rules.max-lines-per-function"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-lines-per-function: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-nested-callbacks",children:"rules.max-nested-callbacks"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-nested-callbacks: (\n  | string\n  | {\n  max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-params",children:"rules.max-params"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-params: (\n  | string\n  | {\n  max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesmax-statements",children:"rules.max-statements"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"max-statements: (\n  | string\n  | {\n  max: number;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesnewline-per-chained-call",children:"rules.newline-per-chained-call"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"newline-per-chained-call: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-confusing-arrow",children:"rules.no-confusing-arrow"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-confusing-arrow: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-console",children:"rules.no-console"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-console: number = 1;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-param-reassign",children:"rules.no-param-reassign"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-param-reassign: (\n  | string\n  | {\n  props: boolean;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-unused-vars",children:"rules.no-unused-vars"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-unused-vars: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesno-use-before-define",children:"rules.no-use-before-define"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"no-use-before-define: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesprefer-template",children:"rules.prefer-template"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"prefer-template: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesprettierprettier",children:"rules.prettier/prettier"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"prettier/prettier: (string | __module)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreact-hooksrules-of-hooks",children:"rules.react-hooks/rules-of-hooks"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'react-hooks/rules-of-hooks: string = "error";\n'})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactdestructuring-assignment",children:"rules.react/destructuring-assignment"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/destructuring-assignment: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactforbid-prop-types",children:"rules.react/forbid-prop-types"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/forbid-prop-types: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactfunction-component-definition",children:"rules.react/function-component-definition"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/function-component-definition: (\n  | number\n  | {\n  namedComponents: string;\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-closing-tag-location",children:"rules.react/jsx-closing-tag-location"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-closing-tag-location: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-filename-extension",children:"rules.react/jsx-filename-extension"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-filename-extension: (\n  | number\n  | {\n  extensions: string[];\n})[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-first-prop-new-line",children:"rules.react/jsx-first-prop-new-line"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-first-prop-new-line: (string | number)[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-no-target-blank",children:"rules.react/jsx-no-target-blank"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-no-target-blank: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-props-no-spreading",children:"rules.react/jsx-props-no-spreading"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-props-no-spreading: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactjsx-uses-vars",children:"rules.react/jsx-uses-vars"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/jsx-uses-vars: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactreact-in-jsx-scope",children:"rules.react/react-in-jsx-scope"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/react-in-jsx-scope: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactrequire-default-props",children:"rules.react/require-default-props"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/require-default-props: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactrequire-extension",children:"rules.react/require-extension"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/require-extension: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactself-closing-comp",children:"rules.react/self-closing-comp"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/self-closing-comp: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesreactsort-comp",children:"rules.react/sort-comp"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react/sort-comp: number = 0;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesredux-sagano-yield-in-race",children:"rules.redux-saga/no-yield-in-race"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"redux-saga/no-yield-in-race: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesredux-sagayield-effects",children:"rules.redux-saga/yield-effects"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"redux-saga/yield-effects: number = 2;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"rulesrequire-yield",children:"rules.require-yield"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"require-yield: number = 0;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"settings",children:"settings"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"settings: {\n  import/resolver: {\n     node: {\n        extensions: string[];\n     };\n  };\n  jest: {\n     version: number;\n  };\n  react: {\n     version: string;\n  };\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolver",children:"settings.import/resolver"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"import/resolver: {\n  node: {\n     extensions: string[];\n  };\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolvernode",children:"settings.import/resolver.node"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"node: {\n  extensions: string[];\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsimportresolvernodeextensions",children:"settings.import/resolver.node.extensions"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"extensions: string[];\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsjest",children:"settings.jest"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"jest: {\n  version: number;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsjestversion",children:"settings.jest.version"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"version: number = 28;\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsreact",children:"settings.react"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"react: {\n  version: string;\n};\n"})}),"\n",(0,l.jsx)(n.h4,{id:"settingsreactversion",children:"settings.react.version"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:'version: string = "detect";\n'})})]})}function d(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(u,{...e})}):u(e)}}}]);

package/build/docs/assets/js/c377a04b.c3b99999.js

@@ -1 +0,0 @@
-"use strict";(globalThis.webpackChunk_elliemae_pui_cli=globalThis.webpackChunk_elliemae_pui_cli||[]).push([[3361],{4926(e,n,i){i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>o,default:()=>u,frontMatter:()=>r,metadata:()=>s,toc:()=>a});const s=JSON.parse('{"id":"index","title":"PUI CLI Documentation","description":"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.","source":"@site/docs/index.md","sourceDirName":".","slug":"/","permalink":"/cli/","draft":false,"unlisted":false,"editUrl":"https://git.elliemae.io/platform-ui/pui-cli.git/docs/index.md","tags":[],"version":"current","frontMatter":{},"sidebar":"docsSidebar","previous":{"title":"vitestConfig","permalink":"/cli/api/variables/vitestConfig"},"next":{"title":"Trust SSL Certificate Guide","permalink":"/cli/ssl-certificate-setup"}}');var l=i(6070),t=i(116);const r={},o="PUI CLI Documentation",c={},a=[{value:"Quick Links",id:"quick-links",level:2},{value:"Features",id:"features",level:2},{value:"Getting Started",id:"getting-started",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Installation",id:"installation",level:3},{value:"For New Projects",id:"for-new-projects",level:4},{value:"Quick Start",id:"quick-start",level:3},{value:"Setting Up a New Application",id:"setting-up-a-new-application",level:4},{value:"Project Structure",id:"project-structure",level:2},{value:"Application Structure",id:"application-structure",level:3},{value:"Library Structure",id:"library-structure",level:3},{value:"Configuration Files",id:"configuration-files",level:2},{value:"Prettier Configuration",id:"prettier-configuration",level:3},{value:"Stylelint Configuration",id:"stylelint-configuration",level:3},{value:"Commitlint Configuration",id:"commitlint-configuration",level:3},{value:"Lint-staged Configuration",id:"lint-staged-configuration",level:3},{value:"Babel Configuration (Optional)",id:"babel-configuration-optional",level:3},{value:"Git Hooks Setup",id:"git-hooks-setup",level:2},{value:"Additional Configuration Files",id:"additional-configuration-files",level:2},{value:"Jest Configuration",id:"jest-configuration",level:3},{value:"Environment Variables",id:"environment-variables",level:2},{value:"Running Your First Build",id:"running-your-first-build",level:2},{value:"Start Development Server",id:"start-development-server",level:3},{value:"Build for Production",id:"build-for-production",level:3},{value:"Run Tests",id:"run-tests",level:3},{value:"Linting and Type Checking",id:"linting-and-type-checking",level:3},{value:"Storybook",id:"storybook",level:3},{value:"Next Steps",id:"next-steps",level:2},{value:"Troubleshooting",id:"troubleshooting",level:2},{value:"Common Issues",id:"common-issues",level:3},{value:"Getting Help",id:"getting-help",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,t.R)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.header,{children:(0,l.jsx)(n.h1,{id:"pui-cli-documentation",children:"PUI CLI Documentation"})}),"\n",(0,l.jsx)(n.p,{children:"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."}),"\n",(0,l.jsx)(n.h2,{id:"quick-links",children:"Quick Links"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"https://git.elliemae.io/platform-ui/pui-cli",children:"GitHub Repository"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"https://jenkinsbuild.elliemae.cloud/job/UIPlatform/job/pui-cli/job/master",children:"Build Job"})}),"\n",(0,l.jsx)(n.li,{children:(0,l.jsx)(n.a,{href:"https://sonarqube.jenkins.elliemae.cloud/overview?id=elliemae.pui.cli-master",children:"SonarQube Report"})}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.a,{href:"/cli/usage-guide",children:"Usage Guide"})})," - Detailed command reference and examples"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.a,{href:"./api/",children:"API Documentation"})})," - Generated API docs from source code"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.a,{href:"/cli/ssl-certificate-setup",children:"SSL Certificate Setup"})})," - HTTPS certificate configuration"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"features",children:"Features"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["\ud83d\ude80 ",(0,l.jsx)(n.strong,{children:"Modern Build Tools"})," - Webpack and Vite integration"]}),"\n",(0,l.jsxs)(n.li,{children:["\ud83e\uddea ",(0,l.jsx)(n.strong,{children:"Testing"})," - Jest and Vitest support with coverage"]}),"\n",(0,l.jsxs)(n.li,{children:["\ud83c\udfa8 ",(0,l.jsx)(n.strong,{children:"Linting"})," - ESLint, Prettier, and Stylelint configurations"]}),"\n",(0,l.jsxs)(n.li,{children:["\ud83d\udcdd ",(0,l.jsx)(n.strong,{children:"TypeScript"})," - Full TypeScript support"]}),"\n",(0,l.jsxs)(n.li,{children:["\ud83d\udcda ",(0,l.jsx)(n.strong,{children:"Storybook"})," - Component development and documentation"]}),"\n",(0,l.jsxs)(n.li,{children:["\ud83d\udd27 ",(0,l.jsx)(n.strong,{children:"Development Server"})," - Hot module replacement"]}),"\n",(0,l.jsxs)(n.li,{children:["\ud83d\udce6 ",(0,l.jsx)(n.strong,{children:"Library Support"})," - Build both applications and libraries"]}),"\n",(0,l.jsxs)(n.li,{children:["\ud83c\udfaf ",(0,l.jsx)(n.strong,{children:"Monorepo Support"})," - Workspace version management"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"getting-started",children:"Getting Started"}),"\n",(0,l.jsxs)(n.p,{children:["This guide will help you get started with ",(0,l.jsx)(n.code,{children:"@elliemae/pui-cli"}),", a command-line interface tool for building and managing UI applications and libraries."]}),"\n",(0,l.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,l.jsx)(n.p,{children:"Before you begin, ensure you have the following installed:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Node.js"}),": Version 20"]}),"\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"pnpm"}),": Version 8 (recommended package manager)"]}),"\n"]}),"\n",(0,l.jsx)(n.h3,{id:"installation",children:"Installation"}),"\n",(0,l.jsx)(n.h4,{id:"for-new-projects",children:"For New Projects"}),"\n",(0,l.jsx)(n.p,{children:"Install the CLI as a development dependency in your project:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"pnpm add -D @elliemae/pui-cli\n"})}),"\n",(0,l.jsx)(n.h3,{id:"quick-start",children:"Quick Start"}),"\n",(0,l.jsx)(n.h4,{id:"setting-up-a-new-application",children:"Setting Up a New Application"}),"\n",(0,l.jsxs)(n.ol,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Create a package.json"})," if you don't have one:"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"pnpm init\n"})}),"\n",(0,l.jsxs)(n.ol,{start:"2",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Install pui-cli"}),":"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"pnpm add -D @elliemae/pui-cli\n"})}),"\n",(0,l.jsxs)(n.ol,{start:"3",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Add scripts to your package.json"}),":"]}),"\n"]}),"\n",(0,l.jsx)(n.p,{children:"For applications:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-json",children:'{\n  "scripts": {\n    "start": "pui-cli start",\n    "start:prod": "pui-cli start -p",\n    "build": "pui-cli build",\n    "test": "pui-cli test",\n    "vitest": "pui-cli vitest",\n    "test:fix": "pui-cli test -f",\n    "test:debug": "pui-cli test --debug",\n    "lint": "pui-cli lint",\n    "lint:fix": "pui-cli lint --fix",\n    "lint:staged": "lint-staged",\n    "tscheck": "pui-cli tscheck --files",\n    "storybook": "pui-cli storybook",\n    "storybook:docs": "pui-cli storybook --docs",\n    "storybook:build": "pui-cli storybook -b",\n    "gendoc": "pui-cli gendoc"\n  }\n}\n'})}),"\n",(0,l.jsx)(n.p,{children:"For libraries:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-json",children:'{\n  "scripts": {\n    "build": "pui-cli pack -p",\n    "build:dev": "pui-cli pack",\n    "test": "pui-cli test",\n    "test:fix": "pui-cli test -f",\n    "lint": "pui-cli lint",\n    "lint:fix": "pui-cli lint --fix",\n    "tscheck": "pui-cli tscheck --files"\n  }\n}\n'})}),"\n",(0,l.jsxs)(n.ol,{start:"4",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Create a TypeScript configuration"})," (",(0,l.jsx)(n.code,{children:"tsconfig.json"}),"):"]}),"\n"]}),"\n",(0,l.jsx)(n.p,{children:"For applications:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-json",children:'{\n  "extends": "@elliemae/pui-cli/app.tsconfig.json",\n  "compilerOptions": {\n    "outDir": "dist/types",\n    "baseUrl": ".",\n    "paths": {}\n  },\n  "include": [\n    "app/**/*",\n    "wdio.config.mjs",\n    "vitest.config.ts",\n    "docusaurus.config.ts"\n  ],\n  "exclude": ["node_modules", "**/*.spec.ts"]\n}\n'})}),"\n",(0,l.jsx)(n.p,{children:"For libraries:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-json",children:'{\n  "extends": "@elliemae/pui-cli/library.tsconfig.json",\n  "compilerOptions": {\n    "outDir": "dist/types",\n    "declarationDir": "dist/types",\n    "baseUrl": "."\n  },\n  "include": ["lib/**/*", "./docusaurus.config.ts"],\n  "exclude": ["node_modules"]\n}\n'})}),"\n",(0,l.jsxs)(n.ol,{start:"5",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Create your source structure"}),":"]}),"\n"]}),"\n",(0,l.jsx)(n.p,{children:"For applications:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:"your-project/\n\u251c\u2500\u2500 app/\n\u2502   \u251c\u2500\u2500 index.tsx          # Entry point\n\u2502   \u251c\u2500\u2500 route/             # Routes\n\u2502   \u251c\u2500\u2500 view/              # Components\n\u2502   \u251c\u2500\u2500 data/              # Redux slices\n\u2502   \u251c\u2500\u2500 api/               # RTK Query APIs\n\u2502   \u251c\u2500\u2500 sideeffect/        # Redux Sagas\n\u2502   \u251c\u2500\u2500 utils/             # Utilities\n\u2502   \u2514\u2500\u2500 app.config.json    # App configuration\n\u251c\u2500\u2500 public/                # Static assets\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,l.jsx)(n.p,{children:"For libraries:"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:"your-project/\n\u251c\u2500\u2500 lib/\n\u2502   \u251c\u2500\u2500 index.ts          # Entry point\n\u2502   \u251c\u2500\u2500 components/       # Components\n\u2502   \u251c\u2500\u2500 utils/            # Utilities\n\u2502   \u2514\u2500\u2500 __tests__/        # Tests\n\u251c\u2500\u2500 stories/              # Storybook stories (optional)\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,l.jsx)(n.h2,{id:"project-structure",children:"Project Structure"}),"\n",(0,l.jsx)(n.h3,{id:"application-structure",children:"Application Structure"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:"your-app/\n\u251c\u2500\u2500 app/                   # Application source code\n\u2502   \u251c\u2500\u2500 index.tsx         # Entry point\n\u2502   \u251c\u2500\u2500 route/            # Route definitions\n\u2502   \u251c\u2500\u2500 view/             # UI components\n\u2502   \u251c\u2500\u2500 data/             # Redux slices (state)\n\u2502   \u251c\u2500\u2500 api/              # RTK Query API definitions\n\u2502   \u251c\u2500\u2500 sideeffect/       # Redux Sagas\n\u2502   \u251c\u2500\u2500 utils/            # Utility functions\n\u2502   \u251c\u2500\u2500 tests/            # Test files\n\u2502   \u2514\u2500\u2500 app.config.json   # App configuration\n\u251c\u2500\u2500 public/               # Static assets\n\u251c\u2500\u2500 e2e/                  # E2E tests (optional)\n\u251c\u2500\u2500 docs/                 # Docusaurus docs (optional)\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,l.jsx)(n.h3,{id:"library-structure",children:"Library Structure"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{children:"your-library/\n\u251c\u2500\u2500 lib/                   # Library source code\n\u2502   \u251c\u2500\u2500 index.ts          # Entry point\n\u2502   \u251c\u2500\u2500 components/       # Components\n\u2502   \u2514\u2500\u2500 __tests__/        # Test files\n\u251c\u2500\u2500 stories/              # Storybook stories\n\u251c\u2500\u2500 package.json\n\u2514\u2500\u2500 tsconfig.json\n"})}),"\n",(0,l.jsx)(n.h2,{id:"configuration-files",children:"Configuration Files"}),"\n",(0,l.jsx)(n.h3,{id:"prettier-configuration",children:"Prettier Configuration"}),"\n",(0,l.jsxs)(n.p,{children:["Create ",(0,l.jsx)(n.code,{children:"prettier.config.cjs"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-javascript",children:"const { prettierConfig } = require('@elliemae/pui-cli');\nmodule.exports = prettierConfig;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"stylelint-configuration",children:"Stylelint Configuration"}),"\n",(0,l.jsxs)(n.p,{children:["Create ",(0,l.jsx)(n.code,{children:"stylelint.config.cjs"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-javascript",children:"const { stylelintConfig } = require('@elliemae/pui-cli');\nmodule.exports = stylelintConfig;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"commitlint-configuration",children:"Commitlint Configuration"}),"\n",(0,l.jsxs)(n.p,{children:["Create ",(0,l.jsx)(n.code,{children:"commitlint.config.cjs"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-javascript",children:"const { commitlintConfig } = require('@elliemae/pui-cli');\nmodule.exports = commitlintConfig;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"lint-staged-configuration",children:"Lint-staged Configuration"}),"\n",(0,l.jsxs)(n.p,{children:["Create ",(0,l.jsx)(n.code,{children:"lint-staged.config.mjs"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-javascript",children:"import { lintStagedConfig } from '@elliemae/pui-cli';\nexport default lintStagedConfig;\n"})}),"\n",(0,l.jsx)(n.h3,{id:"babel-configuration-optional",children:"Babel Configuration (Optional)"}),"\n",(0,l.jsxs)(n.p,{children:["Create ",(0,l.jsx)(n.code,{children:"babel.config.cjs"})," for custom Babel configuration:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-javascript",children:"const { babelConfig } = require('@elliemae/pui-cli');\nmodule.exports = babelConfig;\n"})}),"\n",(0,l.jsx)(n.h2,{id:"git-hooks-setup",children:"Git Hooks Setup"}),"\n",(0,l.jsx)(n.p,{children:"To enable pre-commit hooks with Husky:"}),"\n",(0,l.jsxs)(n.ol,{children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Install Husky"}),":"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"pnpm add -D husky\nnpx husky init\n"})}),"\n",(0,l.jsxs)(n.ol,{start:"2",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsxs)(n.strong,{children:["Create ",(0,l.jsx)(n.code,{children:".husky/pre-commit"})]}),":"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:'#!/bin/sh\n. "$(dirname "$0")/_/husky.sh"\n\nnpx lint-staged\n'})}),"\n",(0,l.jsxs)(n.ol,{start:"3",children:["\n",(0,l.jsxs)(n.li,{children:[(0,l.jsx)(n.strong,{children:"Make it executable"}),":"]}),"\n"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"chmod +x .husky/pre-commit\n"})}),"\n",(0,l.jsx)(n.h2,{id:"additional-configuration-files",children:"Additional Configuration Files"}),"\n",(0,l.jsx)(n.h3,{id:"jest-configuration",children:"Jest Configuration"}),"\n",(0,l.jsxs)(n.p,{children:["For custom Jest configuration, create ",(0,l.jsx)(n.code,{children:"jest.config.cjs"}),":"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-javascript",children:"const { jestConfig } = require('@elliemae/pui-cli');\nmodule.exports = jestConfig;\n"})}),"\n",(0,l.jsx)(n.h2,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,l.jsxs)(n.p,{children:["Create a ",(0,l.jsx)(n.code,{children:".env"})," file in your project root for environment-specific configuration:"]}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-env",children:"PORT=3000\nNODE_ENV=development\n"})}),"\n",(0,l.jsx)(n.h2,{id:"running-your-first-build",children:"Running Your First Build"}),"\n",(0,l.jsx)(n.h3,{id:"start-development-server",children:"Start Development Server"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Start development server\npnpm start\n\n# Start with production mode\npnpm start:prod\n# or\npui-cli start -p\n"})}),"\n",(0,l.jsx)(n.p,{children:"This will:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Start webpack dev server"}),"\n",(0,l.jsx)(n.li,{children:"Enable hot module replacement"}),"\n",(0,l.jsxs)(n.li,{children:["Serve your application (default: ",(0,l.jsx)(n.a,{href:"http://localhost:3000",children:"http://localhost:3000"}),")"]}),"\n",(0,l.jsx)(n.li,{children:"Watch for file changes"}),"\n"]}),"\n",(0,l.jsx)(n.h3,{id:"build-for-production",children:"Build for Production"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Build application\npnpm build\n\n# Build library\npui-cli pack -p\n\n# Build library for development (no minification)\npui-cli pack\n"})}),"\n",(0,l.jsx)(n.p,{children:"This will:"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsx)(n.li,{children:"Create an optimized production build"}),"\n",(0,l.jsxs)(n.li,{children:["Output files to the ",(0,l.jsx)(n.code,{children:"dist/"})," or ",(0,l.jsx)(n.code,{children:"build/"})," directory"]}),"\n",(0,l.jsx)(n.li,{children:"Generate source maps"}),"\n",(0,l.jsx)(n.li,{children:"Minify and bundle your code"}),"\n",(0,l.jsx)(n.li,{children:"For libraries: Generate ESM, CJS, and type declarations"}),"\n"]}),"\n",(0,l.jsx)(n.h3,{id:"run-tests",children:"Run Tests"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Run Jest tests\npnpm test\n\n# Run tests with auto-fix\npnpm test:fix\n\n# Debug tests\npnpm test:debug\n\n# Watch mode\npnpm test:watch\n"})}),"\n",(0,l.jsx)(n.h3,{id:"linting-and-type-checking",children:"Linting and Type Checking"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Lint code\npnpm lint\n\n# Auto-fix lint issues\npnpm lint:fix\n\n# Type check\npnpm tscheck\n\n# Lint staged files only\npnpm lint:staged\n"})}),"\n",(0,l.jsx)(n.h3,{id:"storybook",children:"Storybook"}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Run Storybook dev server\npnpm storybook\n\n# Run with docs mode\npnpm storybook:docs\n\n# Build static Storybook\npnpm storybook:build\n"})}),"\n",(0,l.jsx)(n.h2,{id:"next-steps",children:"Next Steps"}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["Read the ",(0,l.jsx)(n.a,{href:"/cli/usage-guide",children:"Usage Guide"})," for detailed command documentation"]}),"\n",(0,l.jsxs)(n.li,{children:["Check out the ",(0,l.jsx)(n.a,{href:"./api/",children:"API Documentation"})," for library exports"]}),"\n",(0,l.jsxs)(n.li,{children:["Review the ",(0,l.jsx)(n.a,{href:"https://git.elliemae.io/platform-ui/pui-cli#migration-guide",children:"Migration Guide"})," if upgrading from an older version"]}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"troubleshooting",children:"Troubleshooting"}),"\n",(0,l.jsx)(n.h3,{id:"common-issues",children:"Common Issues"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:"Port already in use:"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Change the port in your .env file\nPORT=3001\n"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:"Module not found errors:"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Clear node_modules and reinstall\nrm -rf node_modules\npnpm install\n"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:"Build fails with TypeScript errors:"})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-bash",children:"# Run type checking separately to see detailed errors\npnpm tscheck\n"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:"HTTPS certificate warnings:"})}),"\n",(0,l.jsx)(n.p,{children:'If you see "Not Secure" or certificate warnings when using HTTPS in development:'}),"\n",(0,l.jsxs)(n.ul,{children:["\n",(0,l.jsxs)(n.li,{children:["See the ",(0,l.jsx)(n.a,{href:"/cli/ssl-certificate-setup",children:"SSL Certificate Setup Guide"})," for detailed instructions"]}),"\n",(0,l.jsx)(n.li,{children:"You need to trust the self-signed CA certificate on your system"}),"\n",(0,l.jsx)(n.li,{children:"Platform-specific instructions available for macOS, Windows, and Firefox"}),"\n"]}),"\n",(0,l.jsx)(n.h2,{id:"getting-help",children:"Getting Help"}),"\n",(0,l.jsx)(n.p,{children:"If you encounter issues:"}),"\n",(0,l.jsxs)(n.ol,{children:["\n",(0,l.jsxs)(n.li,{children:["Review the documentation in the ",(0,l.jsx)(n.code,{children:"docs/"})," folder"]}),"\n",(0,l.jsx)(n.li,{children:"Reach out to the ui-platform teams channel"}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(d,{...e})}):d(e)}}}]);