mirror of
https://github.com/chenasraf/simple-scaffold.git
synced 2026-05-18 01:29:09 +00:00
208 lines
49 KiB
HTML
208 lines
49 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/modules" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.1.1">
|
||
<title data-rh="true">simple-scaffold | Simple Scaffold</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:image" content="https://chenasraf.github.io/simple-scaffold/img/docusaurus-social-card.jpg"><meta data-rh="true" name="twitter:image" content="https://chenasraf.github.io/simple-scaffold/img/docusaurus-social-card.jpg"><meta data-rh="true" property="og:url" content="https://chenasraf.github.io/simple-scaffold/docs/api/modules"><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="simple-scaffold | Simple Scaffold"><meta data-rh="true" name="description" content="Interfaces"><meta data-rh="true" property="og:description" content="Interfaces"><link data-rh="true" rel="icon" href="/simple-scaffold/img/logo.svg"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/api/modules"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/modules" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/modules" hreflang="x-default"><link rel="preconnect" href="https://www.googletagmanager.com">
|
||
<script>window.dataLayer=window.dataLayer||[]</script>
|
||
<script>!function(e,t,a,n,g){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var m=t.getElementsByTagName(a)[0],r=t.createElement(a);r.async=!0,r.src="https://www.googletagmanager.com/gtm.js?id=GTM-KHQS9TQ",m.parentNode.insertBefore(r,m)}(window,document,"script","dataLayer")</script><link rel="stylesheet" href="/simple-scaffold/assets/css/styles.8a64fb18.css">
|
||
<script src="/simple-scaffold/assets/js/runtime~main.2ebcc92b.js" defer="defer"></script>
|
||
<script src="/simple-scaffold/assets/js/main.2f095d9a.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-KHQS9TQ" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||
|
||
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"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_xD9F" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="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="/simple-scaffold/"><div class="navbar__logo"><img src="/simple-scaffold/img/logo.svg" alt="Simple Scaffold" class="themedComponent_RIc6 themedComponent--light_aQWN"><img src="/simple-scaffold/img/logo.svg" alt="Simple Scaffold" class="themedComponent_RIc6 themedComponent--dark_XAeT"></div><b class="navbar__title text--truncate">Simple Scaffold</b></a><a class="navbar__item navbar__link" href="/simple-scaffold/docs/api/">API</a><a class="navbar__item navbar__link" href="/simple-scaffold/docs/usage/">Usage</a></div><div class="navbar__items navbar__items--right"><a href="https://npmjs.com/package/simple-scaffold" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">NPM<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><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"></path></svg></a><a href="https://github.com/chenasraf/simple-scaffold" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><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"></path></svg></a><div class="toggle_N2tU colorModeToggle_R3HC"><button class="clean-btn toggleButton_TIRg toggleButtonDisabled_Dghz" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_T53_"><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" class="darkToggleIcon_erRR"><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></button></div><div class="navbarSearchContainer_YstM"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_DnkQ"><div class="docsWrapper_RNIR"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_x6Zs" type="button"></button><div class="docRoot_W9dQ"><aside class="theme-doc-sidebar-container docSidebarContainer_ORMb"><div class="sidebarViewport_oNap"><div class="sidebar_Q8WE"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_R1FV"><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"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/simple-scaffold/docs/api/">API</a><button aria-label="Collapse sidebar category 'API'" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/simple-scaffold/docs/api/modules">Exports</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" tabindex="0" href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">Interfaces</a></div></li></ul></li><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="menu__link menu__link--sublist" aria-expanded="false" href="/simple-scaffold/docs/usage/">Usage</a><button aria-label="Expand sidebar category 'Usage'" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></div></aside><main class="docMainContainer_h1op"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_IS56"><div class="docItemContainer_A3Fn"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_gzph" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/simple-scaffold/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_k91F"><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 itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/simple-scaffold/docs/api/"><span itemprop="name">API</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Exports</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_gU2I theme-doc-toc-mobile tocMobile_LZkL"><button type="button" class="clean-btn tocCollapsibleButton_dItm">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>simple-scaffold</h1></header><h2 class="anchor anchorWithStickyNavbar_zTgU" id="interfaces">Interfaces<a href="#interfaces" class="hash-link" aria-label="Direct link to Interfaces" title="Direct link to Interfaces"></a></h2>
|
||
<ul>
|
||
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a></li>
|
||
</ul>
|
||
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="main">Main<a href="#main" class="hash-link" aria-label="Direct link to Main" title="Direct link to Main"></a></h2>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="scaffold">Scaffold<a href="#scaffold" class="hash-link" aria-label="Direct link to Scaffold" title="Direct link to Scaffold"></a></h3>
|
||
<p>▸ <strong>Scaffold</strong>(<code>config</code>): <code>Promise</code><<code>void</code>></p>
|
||
<p>Create a scaffold using given <code>options</code>.</p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="create-files">Create files<a href="#create-files" class="hash-link" aria-label="Direct link to Create files" title="Direct link to Create files"></a></h4>
|
||
<p>To create a file structure to output, use any directory and file structure you would like.
|
||
Inside folder names, file names or file contents, you may place <code>{{ var }}</code> where <code>var</code> is either
|
||
<code>name</code> which is the scaffold name you provided or one of the keys you provided in the <code>data</code> option.</p>
|
||
<p>The contents and names will be replaced with the transformed values so you can use your original structure as a
|
||
boilerplate for other projects, components, modules, or even single files.</p>
|
||
<p>The files will maintain their structure, starting from the directory containing the template (or the template itself
|
||
if it is already a directory), and will output from that directory into the directory defined by <code>config.output</code>.</p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="helpers">Helpers<a href="#helpers" class="hash-link" aria-label="Direct link to Helpers" title="Direct link to Helpers"></a></h4>
|
||
<p>Helpers are functions you can use to transform your <code>{{ var }}</code> contents into other values without having to
|
||
pre-define the data and use a duplicated key.</p>
|
||
<p>Any functions you provide in <code>helpers</code> option will also be available to you to make custom formatting as you see fit
|
||
(for example, formatting a date)</p>
|
||
<p>For available default values, see <a href="/simple-scaffold/docs/api/modules#defaulthelpers">DefaultHelpers</a>.</p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h4>
|
||
<table><thead><tr><th style="text-align:left">Name</th><th style="text-align:left">Type</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left"><code>config</code></td><td style="text-align:left"><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig"><code>ScaffoldConfig</code></a></td><td style="text-align:left">The main configuration object</td></tr></tbody></table>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns"></a></h4>
|
||
<p><code>Promise</code><<code>void</code>></p>
|
||
<p>A promise that resolves when the scaffold is complete</p>
|
||
<p><strong><code>See</code></strong></p>
|
||
<ul>
|
||
<li><a href="/simple-scaffold/docs/api/modules#defaulthelpers">DefaultHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/modules#casehelpers">CaseHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/modules#datehelpers">DateHelpers</a></li>
|
||
</ul>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in">Defined in<a href="#defined-in" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/scaffold.ts#L57" target="_blank" rel="noopener noreferrer">scaffold.ts:57</a></p>
|
||
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="config">Config<a href="#config" class="hash-link" aria-label="Direct link to Config" title="Direct link to Config"></a></h2>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="fileresponsehandler">FileResponseHandler<a href="#fileresponsehandler" class="hash-link" aria-label="Direct link to FileResponseHandler" title="Direct link to FileResponseHandler"></a></h3>
|
||
<p>Ƭ <strong>FileResponseHandler</strong><<code>T</code>>: (<code>fullPath</code>: <code>string</code>, <code>basedir</code>: <code>string</code>, <code>basename</code>: <code>string</code>) => <code>T</code></p>
|
||
<p>A function that takes path information about file, and returns a value of type <code>T</code></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="type-parameters">Type parameters<a href="#type-parameters" class="hash-link" aria-label="Direct link to Type parameters" title="Direct link to Type parameters"></a></h4>
|
||
<table><thead><tr><th style="text-align:left">Name</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left"><code>T</code></td><td style="text-align:left">The return type for the function</td></tr></tbody></table>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="type-declaration">Type declaration<a href="#type-declaration" class="hash-link" aria-label="Direct link to Type declaration" title="Direct link to Type declaration"></a></h4>
|
||
<p>▸ (<code>fullPath</code>, <code>basedir</code>, <code>basename</code>): <code>T</code></p>
|
||
<h5 class="anchor anchorWithStickyNavbar_zTgU" id="parameters-1">Parameters<a href="#parameters-1" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters"></a></h5>
|
||
<table><thead><tr><th style="text-align:left">Name</th><th style="text-align:left">Type</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left"><code>fullPath</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">The full path of the current file</td></tr><tr><td style="text-align:left"><code>basedir</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">The directory containing the current file</td></tr><tr><td style="text-align:left"><code>basename</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">The name of the file</td></tr></tbody></table>
|
||
<h5 class="anchor anchorWithStickyNavbar_zTgU" id="returns-1">Returns<a href="#returns-1" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns"></a></h5>
|
||
<p><code>T</code></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-1">Defined in<a href="#defined-in-1" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L314" target="_blank" rel="noopener noreferrer">types.ts:314</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="fileresponse">FileResponse<a href="#fileresponse" class="hash-link" aria-label="Direct link to FileResponse" title="Direct link to FileResponse"></a></h3>
|
||
<p>Ƭ <strong>FileResponse</strong><<code>T</code>>: <code>T</code> | <a href="/simple-scaffold/docs/api/modules#fileresponsehandler"><code>FileResponseHandler</code></a><<code>T</code>></p>
|
||
<p>Represents a response for file path information.
|
||
Can either be:</p>
|
||
<ol>
|
||
<li><code>T</code> - static value</li>
|
||
<li>A function with the following signature which returns <code>T</code>:<!-- -->
|
||
<div class="language-typescript codeBlockContainer_lofb theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_CIqb"><pre tabindex="0" class="prism-code language-typescript codeBlock_H1Bz thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GTCY"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">fullPath</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> basedir</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> basename</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</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 constant" style="color:#36acaa">T</span><br></span></code></pre><div class="buttonGroup_m1Eb"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_H9jk" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon__y5V"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_JBPS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
</li>
|
||
</ol>
|
||
<p><strong><code>See</code></strong></p>
|
||
<p><a href="/simple-scaffold/docs/api/modules#fileresponsehandler">FileResponseHandler</a></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="type-parameters-1">Type parameters<a href="#type-parameters-1" class="hash-link" aria-label="Direct link to Type parameters" title="Direct link to Type parameters"></a></h4>
|
||
<table><thead><tr><th style="text-align:left">Name</th></tr></thead><tbody><tr><td style="text-align:left"><code>T</code></td></tr></tbody></table>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-2">Defined in<a href="#defined-in-2" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L330" target="_blank" rel="noopener noreferrer">types.ts:330</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="scaffoldconfigmap">ScaffoldConfigMap<a href="#scaffoldconfigmap" class="hash-link" aria-label="Direct link to ScaffoldConfigMap" title="Direct link to ScaffoldConfigMap"></a></h3>
|
||
<p>Ƭ <strong>ScaffoldConfigMap</strong>: <code>Record</code><<code>string</code>, <a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig"><code>ScaffoldConfig</code></a>></p>
|
||
<p>A mapping of scaffold template keys to their configurations.</p>
|
||
<p>Each configuration is a <a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a> object.</p>
|
||
<p>The key is the name of the template, and the value is the configuration for that template.</p>
|
||
<p>When no template key is provided to the scaffold command, the "default" template is used.</p>
|
||
<p><strong><code>See</code></strong></p>
|
||
<p><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-3">Defined in<a href="#defined-in-3" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L386" target="_blank" rel="noopener noreferrer">types.ts:386</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="scaffoldconfigfile">ScaffoldConfigFile<a href="#scaffoldconfigfile" class="hash-link" aria-label="Direct link to ScaffoldConfigFile" title="Direct link to ScaffoldConfigFile"></a></h3>
|
||
<p>Ƭ <strong>ScaffoldConfigFile</strong>: <code>AsyncResolver</code><<a href="/simple-scaffold/docs/api/modules#scaffoldcmdconfig"><code>ScaffoldCmdConfig</code></a>, <a href="/simple-scaffold/docs/api/modules#scaffoldconfigmap"><code>ScaffoldConfigMap</code></a>></p>
|
||
<p>The scaffold config file is either:</p>
|
||
<ul>
|
||
<li>A <a href="/simple-scaffold/docs/api/modules#scaffoldconfigmap">ScaffoldConfigMap</a> object</li>
|
||
<li>A function that returns a <a href="/simple-scaffold/docs/api/modules#scaffoldconfigmap">ScaffoldConfigMap</a> object</li>
|
||
<li>A promise that resolves to a <a href="/simple-scaffold/docs/api/modules#scaffoldconfigmap">ScaffoldConfigMap</a> object</li>
|
||
<li>A function that returns a promise that resolves to a <a href="/simple-scaffold/docs/api/modules#scaffoldconfigmap">ScaffoldConfigMap</a> object</li>
|
||
</ul>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-4">Defined in<a href="#defined-in-4" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L397" target="_blank" rel="noopener noreferrer">types.ts:397</a></p>
|
||
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="helpers-1">Helpers<a href="#helpers-1" class="hash-link" aria-label="Direct link to Helpers" title="Direct link to Helpers"></a></h2>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="casehelpers">CaseHelpers<a href="#casehelpers" class="hash-link" aria-label="Direct link to CaseHelpers" title="Direct link to CaseHelpers"></a></h3>
|
||
<p>Ƭ <strong>CaseHelpers</strong>: <code>"camelCase"</code> | <code>"hyphenCase"</code> | <code>"kebabCase"</code> | <code>"lowerCase"</code> | <code>"pascalCase"</code> | <code>"snakeCase"</code> | <code>"startCase"</code> | <code>"upperCase"</code></p>
|
||
<p>The names of the available helper functions that relate to text capitalization.</p>
|
||
<p>These are available for <code>subfolderNameHelper</code>.</p>
|
||
<table><thead><tr><th>Helper name</th><th>Example code</th><th>Example output</th></tr></thead><tbody><tr><td>[None]</td><td><code>{{ name }}</code></td><td>my name</td></tr><tr><td><code>camelCase</code></td><td><code>{{ camelCase name }}</code></td><td>myName</td></tr><tr><td><code>snakeCase</code></td><td><code>{{ snakeCase name }}</code></td><td>my_name</td></tr><tr><td><code>startCase</code></td><td><code>{{ startCase name }}</code></td><td>My Name</td></tr><tr><td><code>kebabCase</code></td><td><code>{{ kebabCase name }}</code></td><td>my-name</td></tr><tr><td><code>hyphenCase</code></td><td><code>{{ hyphenCase name }}</code></td><td>my-name</td></tr><tr><td><code>pascalCase</code></td><td><code>{{ pascalCase name }}</code></td><td>MyName</td></tr><tr><td><code>upperCase</code></td><td><code>{{ upperCase name }}</code></td><td>MY NAME</td></tr><tr><td><code>lowerCase</code></td><td><code>{{ lowerCase name }}</code></td><td>my name</td></tr></tbody></table>
|
||
<p><strong><code>See</code></strong></p>
|
||
<ul>
|
||
<li><a href="/simple-scaffold/docs/api/modules#defaulthelpers">DefaultHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/modules#datehelpers">DateHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig#subdirhelper">ScaffoldConfig.subdirHelper</a></li>
|
||
</ul>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-5">Defined in<a href="#defined-in-5" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L189" target="_blank" rel="noopener noreferrer">types.ts:189</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="datehelpers">DateHelpers<a href="#datehelpers" class="hash-link" aria-label="Direct link to DateHelpers" title="Direct link to DateHelpers"></a></h3>
|
||
<p>Ƭ <strong>DateHelpers</strong>: <code>"date"</code> | <code>"now"</code></p>
|
||
<p>The names of the available helper functions that relate to dates.</p>
|
||
<table><thead><tr><th>Helper name</th><th>Description</th><th>Example code</th><th>Example output</th></tr></thead><tbody><tr><td><code>now</code></td><td>Current date with format</td><td><code>{{ now "yyyy-MM-dd HH:mm" }}</code></td><td><code>2042-01-01 15:00</code></td></tr><tr><td><code>now</code> (with offset)</td><td>Current date with format, and with offset</td><td><code>{{ now "yyyy-MM-dd HH:mm" -1 "hours" }}</code></td><td><code>2042-01-01 14:00</code></td></tr><tr><td><code>date</code></td><td>Custom date with format</td><td><code>{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" }}</code></td><td><code>2042-01-01 15:00</code></td></tr><tr><td><code>date</code> (with offset)</td><td>Custom date with format, and with offset</td><td><code>{{ date "2042-01-01T15:00:00Z" "yyyy-MM-dd HH:mm" -1 "days" }}</code></td><td><code>2041-31-12 15:00</code></td></tr><tr><td><code>date</code> (with date from <code>--data</code>)</td><td>Custom date with format, with data from the <code>data</code> config option</td><td><code>{{ date myCustomDate "yyyy-MM-dd HH:mm" }}</code></td><td><code>2042-01-01 12:00</code></td></tr></tbody></table>
|
||
<p>Further details:</p>
|
||
<ul>
|
||
<li>
|
||
<p>We use <a href="https://date-fns.org/docs/" target="_blank" rel="noopener noreferrer"><code>date-fns</code></a> for parsing/manipulating the dates. If you want
|
||
more information on the date tokens to use, refer to
|
||
<a href="https://date-fns.org/docs/format" target="_blank" rel="noopener noreferrer">their format documentation</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p>The date helper format takes the following arguments:</p>
|
||
<div class="language-typescript codeBlockContainer_lofb theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_CIqb"><pre tabindex="0" class="prism-code language-typescript codeBlock_H1Bz thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GTCY"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">(</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> date</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> format</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> offsetAmount</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> offsetType</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"years"</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"months"</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"weeks"</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"days"</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"hours"</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"minutes"</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">"seconds"</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">)</span><br></span></code></pre><div class="buttonGroup_m1Eb"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_H9jk" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon__y5V"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_JBPS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
|
||
</li>
|
||
<li>
|
||
<p><strong>The now helper</strong> (for current time) takes the same arguments, minus the first one (<code>date</code>) as it is implicitly
|
||
the current date.</p>
|
||
</li>
|
||
</ul>
|
||
<p><strong><code>See</code></strong></p>
|
||
<ul>
|
||
<li><a href="/simple-scaffold/docs/api/modules#defaulthelpers">DefaultHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/modules#casehelpers">CaseHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a></li>
|
||
</ul>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-6">Defined in<a href="#defined-in-6" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L236" target="_blank" rel="noopener noreferrer">types.ts:236</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="defaulthelpers">DefaultHelpers<a href="#defaulthelpers" class="hash-link" aria-label="Direct link to DefaultHelpers" title="Direct link to DefaultHelpers"></a></h3>
|
||
<p>Ƭ <strong>DefaultHelpers</strong>: <a href="/simple-scaffold/docs/api/modules#casehelpers"><code>CaseHelpers</code></a> | <a href="/simple-scaffold/docs/api/modules#datehelpers"><code>DateHelpers</code></a></p>
|
||
<p>The names of all the available helper functions in templates.
|
||
Simple-Scaffold provides some built-in text transformation filters usable by Handlebars.js.</p>
|
||
<p>For example, you may use <code>{{ snakeCase name }}</code> inside a template file or filename, and it will
|
||
replace <code>My Name</code> with <code>my_name</code> when producing the final value.</p>
|
||
<p><strong><code>See</code></strong></p>
|
||
<ul>
|
||
<li><a href="/simple-scaffold/docs/api/modules#casehelpers">CaseHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/modules#datehelpers">DateHelpers</a></li>
|
||
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a></li>
|
||
</ul>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-7">Defined in<a href="#defined-in-7" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L251" target="_blank" rel="noopener noreferrer">types.ts:251</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="helper">Helper<a href="#helper" class="hash-link" aria-label="Direct link to Helper" title="Direct link to Helper"></a></h3>
|
||
<p>Ƭ <strong>Helper</strong>: <code>HelperDelegate</code></p>
|
||
<p>Helper function, see <a href="https://handlebarsjs.com/guide/#custom-helpers" target="_blank" rel="noopener noreferrer">https://handlebarsjs.com/guide/#custom-helpers</a></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-8">Defined in<a href="#defined-in-8" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L258" target="_blank" rel="noopener noreferrer">types.ts:258</a></p>
|
||
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="logging-const">Logging (const)<a href="#logging-const" class="hash-link" aria-label="Direct link to Logging (const)" title="Direct link to Logging (const)"></a></h2>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="loglevel">LogLevel<a href="#loglevel" class="hash-link" aria-label="Direct link to LogLevel" title="Direct link to LogLevel"></a></h3>
|
||
<p>• <code>Const</code> <strong>LogLevel</strong>: <code>Object</code></p>
|
||
<p>The amount of information to log when generating scaffold.
|
||
When not <code>none</code>, the selected level will be the lowest level included.</p>
|
||
<p>For example, level <code>info</code> will include <code>info</code>, <code>warning</code> and <code>error</code>, but not <code>debug</code>; and <code>warning</code> will only
|
||
show <code>warning</code> and <code>error</code>, but not <code>info</code> or <code>debug</code>.</p>
|
||
<p><strong><code>Default</code></strong></p>
|
||
<p><code>info</code></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="type-declaration-1">Type declaration<a href="#type-declaration-1" class="hash-link" aria-label="Direct link to Type declaration" title="Direct link to Type declaration"></a></h4>
|
||
<table><thead><tr><th style="text-align:left">Name</th><th style="text-align:left">Type</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left"><code>none</code></td><td style="text-align:left"><code>"none"</code></td><td style="text-align:left">Silent output</td></tr><tr><td style="text-align:left"><code>debug</code></td><td style="text-align:left"><code>"debug"</code></td><td style="text-align:left">Debugging information. Very verbose and only recommended for troubleshooting.</td></tr><tr><td style="text-align:left"><code>info</code></td><td style="text-align:left"><code>"info"</code></td><td style="text-align:left">The regular level of logging. Major actions are logged to show the scaffold progress. <strong><code>Default</code></strong> <code>ts </code></td></tr><tr><td style="text-align:left"><code>warning</code></td><td style="text-align:left"><code>"warning"</code></td><td style="text-align:left">Warnings such as when file fails to replace token values properly in template.</td></tr><tr><td style="text-align:left"><code>error</code></td><td style="text-align:left"><code>"error"</code></td><td style="text-align:left">Errors, such as missing files, bad replacement token syntax, or un-writable directories.</td></tr></tbody></table>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-9">Defined in<a href="#defined-in-9" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L272" target="_blank" rel="noopener noreferrer">types.ts:272</a></p>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L300" target="_blank" rel="noopener noreferrer">types.ts:300</a></p>
|
||
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="logging-type">Logging (type)<a href="#logging-type" class="hash-link" aria-label="Direct link to Logging (type)" title="Direct link to Logging (type)"></a></h2>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="loglevel-1">LogLevel<a href="#loglevel-1" class="hash-link" aria-label="Direct link to LogLevel" title="Direct link to LogLevel"></a></h3>
|
||
<p>Ƭ <strong>LogLevel</strong>: typeof <a href="/simple-scaffold/docs/api/modules#loglevel"><code>LogLevel</code></a>[keyof typeof <a href="/simple-scaffold/docs/api/modules#loglevel"><code>LogLevel</code></a>]</p>
|
||
<p>The amount of information to log when generating scaffold.
|
||
When not <code>none</code>, the selected level will be the lowest level included.</p>
|
||
<p>For example, level <code>info</code> will include <code>info</code>, <code>warning</code> and <code>error</code>, but not <code>debug</code>; and <code>warning</code> will only
|
||
show <code>warning</code> and <code>error</code>, but not <code>info</code> or <code>debug</code>.</p>
|
||
<p><strong><code>Default</code></strong></p>
|
||
<p><code>info</code></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-10">Defined in<a href="#defined-in-10" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L272" target="_blank" rel="noopener noreferrer">types.ts:272</a></p>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L300" target="_blank" rel="noopener noreferrer">types.ts:300</a></p>
|
||
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="other">Other<a href="#other" class="hash-link" aria-label="Direct link to Other" title="Direct link to Other"></a></h2>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="scaffoldcmdconfig">ScaffoldCmdConfig<a href="#scaffoldcmdconfig" class="hash-link" aria-label="Direct link to ScaffoldCmdConfig" title="Direct link to ScaffoldCmdConfig"></a></h3>
|
||
<p>Ƭ <strong>ScaffoldCmdConfig</strong>: <code>Object</code></p>
|
||
<p>The Scaffold config for CLI
|
||
Contains less and more specific options than <a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a></p>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="type-declaration-2">Type declaration<a href="#type-declaration-2" class="hash-link" aria-label="Direct link to Type declaration" title="Direct link to Type declaration"></a></h4>
|
||
<table><thead><tr><th style="text-align:left">Name</th><th style="text-align:left">Type</th><th style="text-align:left">Description</th></tr></thead><tbody><tr><td style="text-align:left"><code>name</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">The name of the scaffold template to use.</td></tr><tr><td style="text-align:left"><code>templates</code></td><td style="text-align:left"><code>string</code>[]</td><td style="text-align:left">The templates to use for generation</td></tr><tr><td style="text-align:left"><code>output</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">The output path to write to</td></tr><tr><td style="text-align:left"><code>subdir</code></td><td style="text-align:left"><code>boolean</code></td><td style="text-align:left">Whether to create subfolder with the input name</td></tr><tr><td style="text-align:left"><code>subdirHelper?</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">Default transformer to apply to subfolder name when using <code>subdir: true</code></td></tr><tr><td style="text-align:left"><code>data?</code></td><td style="text-align:left"><code>Record</code><<code>string</code>, <code>string</code>></td><td style="text-align:left">Add custom data to the templates</td></tr><tr><td style="text-align:left"><code>appendData?</code></td><td style="text-align:left"><code>Record</code><<code>string</code>, <code>string</code>></td><td style="text-align:left">Add custom data to the template in a CLI-friendly syntax (and not JSON)</td></tr><tr><td style="text-align:left"><code>overwrite</code></td><td style="text-align:left"><code>boolean</code></td><td style="text-align:left">Enable to override output files, even if they already exist</td></tr><tr><td style="text-align:left"><code>quiet</code></td><td style="text-align:left"><code>boolean</code></td><td style="text-align:left">Silence logs, same as <code>logLevel: "none"</code></td></tr><tr><td style="text-align:left"><code>logLevel</code></td><td style="text-align:left"><a href="/simple-scaffold/docs/api/modules#loglevel-1"><code>LogLevel</code></a></td><td style="text-align:left">Determine amount of logs to display. <strong><code>See</code></strong> <a href="/simple-scaffold/docs/api/modules#loglevel">LogLevel</a></td></tr><tr><td style="text-align:left"><code>dryRun</code></td><td style="text-align:left"><code>boolean</code></td><td style="text-align:left">Don't emit files. This is good for testing your scaffolds and making sure they don't fail, without having to write actual file contents or create directories.</td></tr><tr><td style="text-align:left"><code>config?</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">Config file path to use</td></tr><tr><td style="text-align:left"><code>key?</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">The key of the template to use</td></tr><tr><td style="text-align:left"><code>git?</code></td><td style="text-align:left"><code>string</code></td><td style="text-align:left">The git repository to use to fetch the config file</td></tr><tr><td style="text-align:left"><code>version</code></td><td style="text-align:left"><code>boolean</code></td><td style="text-align:left">Display version</td></tr></tbody></table>
|
||
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-11">Defined in<a href="#defined-in-11" class="hash-link" aria-label="Direct link to Defined in" title="Direct link to Defined in"></a></h4>
|
||
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/859b304/src/types.ts#L336" target="_blank" rel="noopener noreferrer">types.ts:336</a></p>
|
||
<hr>
|
||
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="default">default<a href="#default" class="hash-link" aria-label="Direct link to default" title="Direct link to default"></a></h3>
|
||
<p>Renames and re-exports <a href="/simple-scaffold/docs/api/modules#scaffold">Scaffold</a></p></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/simple-scaffold/docs/api/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Readme</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">ScaffoldConfig</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_Xz4f thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#interfaces" class="table-of-contents__link toc-highlight">Interfaces</a></li><li><a href="#main" class="table-of-contents__link toc-highlight">Main</a><ul><li><a href="#scaffold" class="table-of-contents__link toc-highlight">Scaffold</a></li></ul></li><li><a href="#config" class="table-of-contents__link toc-highlight">Config</a><ul><li><a href="#fileresponsehandler" class="table-of-contents__link toc-highlight">FileResponseHandler</a></li><li><a href="#fileresponse" class="table-of-contents__link toc-highlight">FileResponse</a></li><li><a href="#scaffoldconfigmap" class="table-of-contents__link toc-highlight">ScaffoldConfigMap</a></li><li><a href="#scaffoldconfigfile" class="table-of-contents__link toc-highlight">ScaffoldConfigFile</a></li></ul></li><li><a href="#helpers-1" class="table-of-contents__link toc-highlight">Helpers</a><ul><li><a href="#casehelpers" class="table-of-contents__link toc-highlight">CaseHelpers</a></li><li><a href="#datehelpers" class="table-of-contents__link toc-highlight">DateHelpers</a></li><li><a href="#defaulthelpers" class="table-of-contents__link toc-highlight">DefaultHelpers</a></li><li><a href="#helper" class="table-of-contents__link toc-highlight">Helper</a></li></ul></li><li><a href="#logging-const" class="table-of-contents__link toc-highlight">Logging (const)</a><ul><li><a href="#loglevel" class="table-of-contents__link toc-highlight">LogLevel</a></li></ul></li><li><a href="#logging-type" class="table-of-contents__link toc-highlight">Logging (type)</a><ul><li><a href="#loglevel-1" class="table-of-contents__link toc-highlight">LogLevel</a></li></ul></li><li><a href="#other" class="table-of-contents__link toc-highlight">Other</a><ul><li><a href="#scaffoldcmdconfig" class="table-of-contents__link toc-highlight">ScaffoldCmdConfig</a></li><li><a href="#default" class="table-of-contents__link toc-highlight">default</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="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="/simple-scaffold/docs/intro">Tutorial</a></li></ul></div><div class="col footer__col"><div class="footer__title">More from @casraf</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://chenasraf.github.io/massarg" target="_blank" rel="noopener noreferrer" class="footer__link-item">Massarg - CLI Argument Parser<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><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"></path></svg></a></li><li class="footer__item"><a href="https://casraf.dev" target="_blank" rel="noopener noreferrer" class="footer__link-item">Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><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"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://npmjs.com/package/simple-scaffold" target="_blank" rel="noopener noreferrer" class="footer__link-item">npm<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><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"></path></svg></a></li><li class="footer__item"><a href="https://github.com/chenasraf/simple-scaffold" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_MnLA"><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"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 Chen Asraf. Built with Docusaurus.</div></div></div></footer></div>
|
||
</body>
|
||
</html> |