npm - @elliemae/pui-cli - Versions diffs - 7.0.0-alpha.3 → 7.0.0-alpha.32 - Mend

@elliemae/pui-cli 7.0.0-alpha.3 → 7.0.0-alpha.32

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.

Files changed (279) hide show

package/dist/cjs/docs/assets/widgets.png ADDED Viewed

Binary file

package/dist/cjs/docs/assets/widgets@2x.png ADDED Viewed

Binary file

package/dist/cjs/docs/index.html ADDED Viewed

@@ -0,0 +1,94 @@
+<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@elliemae/pui-cli</title><meta name="description" content="Documentation for @elliemae/pui-cli"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@elliemae/pui-cli</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>@elliemae/pui-cli </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
+<a href="#command-line-interface-for-ui-applications-amp-libraries" id="command-line-interface-for-ui-applications-amp-libraries" style="color: inherit; text-decoration: none;">
+  <h1>Command Line Interface for UI Applications &amp; Libraries</h1>
+</a>
+<p><a href="https://jenkins.dco.elmae/job/UIPlatform/job/Dev/job/pui-cli/job/master/"><img src="https://jenkins.dco.elmae/job/UIPlatform/job/Dev/job/pui-cli/job/master/badge/icon" alt="Build Status"></a></p>
+<p><a href="https://sonar.ellielabs.com/overview?id=elliemae.pui.cli-master">SonarQube Report</a></p>
+<p><a href="https://git.elliemae.io/pages/platform-ui/pui-cli/index.html">API Documentation</a></p>
+<a href="#features" id="features" style="color: inherit; text-decoration: none;">
+  <h2>Features</h2>
+</a>
+<ul>
+<li>Supports typescript</li>
+<li>Builds react application / library using webpack</li>
+<li>Builds storybook application in libraries</li>
+<li>Provides code quality check configurations such as<ul>
+<li>eslint configurations</li>
+<li>prettier configuration</li>
+<li>commit lint configuration</li>
+<li>style lint configuration</li>
+</ul>
+</li>
+<li>Provides common unit/integration test configuration</li>
+<li>Runs react application using webpack dev server and express</li>
+<li>Runs mocked application apis using express server</li>
+</ul>
+<a href="#migration-guide" id="migration-guide" style="color: inherit; text-decoration: none;">
+  <h2>Migration Guide</h2>
+</a>
+<a href="#v5-to-v6" id="v5-to-v6" style="color: inherit; text-decoration: none;">
+  <h3>v5 to v6</h3>
+</a>
+<p><a href="https://confluence.elliemae.io/display/FEAE/CLI+ChangeLog">ChangeLog</a></p>
+<a href="#v4-to-v5" id="v4-to-v5" style="color: inherit; text-decoration: none;">
+  <h3>v4 to v5</h3>
+</a>
+<p>For most users this upgrade doesn&#39;t break functionality. If it does, please reach out to ui-platform-chat channel for assistance</p>
+<a href="#v3-to-v4" id="v3-to-v4" style="color: inherit; text-decoration: none;">
+  <h3>v3 to v4</h3>
+</a>
+<p>Version 4 has breaking changes that impacts only libraries (e.g: app sdk, app widgets etc) not applications</p>
+<p>Following changes to be done in package.json file of the library after upgrading to v4</p>
+<ul>
+<li><p>in main field, replace ./dist/index.js with ./dist/cjs/index.js</p>
+</li>
+<li><p>in module field, replace ./lib/index.js with ./dist/es/index.js</p>
+</li>
+<li><p>add following exports field to your package.json</p>
+<pre><code class="language-json"><span class="hl-0">  </span><span class="hl-1">&quot;exports&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-2">&quot;.&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">      </span><span class="hl-2">&quot;import&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;./dist/es/index.js&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-2">&quot;require&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;./dist/cjs/index.js&quot;</span><br/><span class="hl-0">    }</span><br/><span class="hl-0">  },</span>
+</code></pre>
+</li>
+</ul>
+<a href="#v2-to-v3" id="v2-to-v3" style="color: inherit; text-decoration: none;">
+  <h3>v2 to v3</h3>
+</a>
+<p>V3 uses new version of husky, after upgrading cli follow the steps below to configure git hooks</p>
+<ul>
+<li><code>npx --no-install husky-init &amp;&amp; npm exec -- github:typicode/husky-4-to-6 --remove-v4-config</code></li>
+<li>remove .husky folder from your git repo root</li>
+<li>copy the entire <a href="https://git.elliemae.io/platform-ui/pui-cli/blob/master/.husky">/.husky</a> folder from this repo and place it in your git repo root</li>
+<li><code>npm run prepare</code></li>
+<li>create &#39;lint-staged.config.js&#39; in your git repo root and copy the contents below</li>
+</ul>
+<pre><code class="language-js"><span class="hl-3">const</span><span class="hl-0"> { </span><span class="hl-4">lintStagedConfig</span><span class="hl-0"> } = </span><span class="hl-5">require</span><span class="hl-0">(</span><span class="hl-1">&#39;@elliemae/pui-cli&#39;</span><span class="hl-0">);</span><br/><span class="hl-6">module</span><span class="hl-0">.</span><span class="hl-6">exports</span><span class="hl-0"> = </span><span class="hl-7">lintStagedConfig</span><span class="hl-0">;</span>
+</code></pre>
+<ul>
+<li>remove following lines from your package.json</li>
+</ul>
+<pre><code class="language-json"><span class="hl-1">&quot;lint-staged&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-2">&quot;*.js&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0">      </span><span class="hl-1">&quot;npm run lint:fix&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-1">&quot;npm run test:staged&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      </span><span class="hl-1">&quot;npm run gendoc&quot;</span><br/><span class="hl-0">    ],</span><br/><span class="hl-0">    </span><span class="hl-2">&quot;*.mdx&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0">      </span><span class="hl-1">&quot;prettier --write&quot;</span><br/><span class="hl-0">    ],</span><br/><span class="hl-0">    </span><span class="hl-2">&quot;*.json&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0">      </span><span class="hl-1">&quot;prettier --write&quot;</span><br/><span class="hl-0">    ]</span><br/><span class="hl-0">  },</span>
+</code></pre>
+<a href="#enabling-typescript" id="enabling-typescript" style="color: inherit; text-decoration: none;">
+  <h4>Enabling Typescript</h4>
+</a>
+<p>Version 3 has support to Typescript</p>
+<p>To enable typescript for your application source code add tsconfig.json file to your application root and add the json snippet below</p>
+<pre><code class="language-json"><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;extends&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;@elliemae/pui-cli/lib/typescript/app.tsconfig.json&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;compilerOptions&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-2">&quot;outDir&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;dist&quot;</span><br/><span class="hl-0">  },</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;include&quot;</span><span class="hl-0">: [</span><span class="hl-1">&quot;app/**/*&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;exclude&quot;</span><span class="hl-0">: [</span><span class="hl-1">&quot;node_modules&quot;</span><span class="hl-0">]</span><br/><span class="hl-0">}</span>
+</code></pre>
+<p>for library source code</p>
+<pre><code class="language-json"><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;extends&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;@elliemae/pui-cli/lib/typescript/library.tsconfig.json&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;compilerOptions&quot;</span><span class="hl-0">: {</span><br/><span class="hl-0">    </span><span class="hl-2">&quot;outDir&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;dist&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-2">&quot;declarationDir&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;dist/types&quot;</span><br/><span class="hl-0">  },</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;include&quot;</span><span class="hl-0">: [</span><span class="hl-1">&quot;lib/**/*&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;exclude&quot;</span><span class="hl-0">: [</span><span class="hl-1">&quot;node_modules&quot;</span><span class="hl-0">]</span><br/><span class="hl-0">}</span>
+</code></pre>
+<a href="#v1-to-v2" id="v1-to-v2" style="color: inherit; text-decoration: none;">
+  <h3>v1 to v2</h3>
+</a>
+<ul>
+<li>after cli upgrade to v2 sync up your application code with latest version of <a href="https://git.elliemae.io/platform-ui/pui-react-boilerplate">React boilerplate</a></li>
+</ul>
+</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-property"><a href="modules.html#commitlintConfig" class="tsd-kind-icon">commitlint<wbr/>Config</a></li><li class="tsd-kind-property"><a href="modules.html#eslintBaseConfig" class="tsd-kind-icon">eslint<wbr/>Base<wbr/>Config</a></li><li class="tsd-kind-property"><a href="modules.html#eslintConfig" class="tsd-kind-icon">eslint<wbr/>Config</a></li><li class="tsd-kind-property"><a href="modules.html#jestNodeConfig" class="tsd-kind-icon">jest<wbr/>Node<wbr/>Config</a></li><li class="tsd-kind-property"><a href="modules.html#loadRoutes" class="tsd-kind-icon">load<wbr/>Routes</a></li><li class="tsd-kind-property"><a href="modules.html#prettierConfig" class="tsd-kind-icon">prettier<wbr/>Config</a></li><li class="tsd-kind-property"><a href="modules.html#stylelintConfig" class="tsd-kind-icon">stylelint<wbr/>Config</a></li><li class="tsd-kind-variable"><a href="modules.html#babelConfig" class="tsd-kind-icon">babel<wbr/>Config</a></li><li class="tsd-kind-variable"><a href="modules.html#jestConfig" class="tsd-kind-icon">jest<wbr/>Config</a></li><li class="tsd-kind-variable"><a href="modules.html#lintStagedConfig" class="tsd-kind-icon">lint<wbr/>Staged<wbr/>Config</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>