casraf/simple-scaffold
1
0
Fork 0
mirror of https://github.com/chenasraf/simple-scaffold.git synced 2026-05-18 01:29:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: bfee26fb2e

Browse Source
This commit is contained in:
chenasraf
2024-02-02 00:44:36 +00:00
parent 24eff9dbaf
commit 43df6e746c
20 changed files with 58 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
404.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Page Not Found | 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/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Page Not Found | Simple Scaffold"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/404.html"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/404.html" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
assets/js/3bd150b0.7f274eed.js → assets/js/3bd150b0.83e20e07.js
View File

File diff suppressed because one or more lines are too long

2
assets/js/af0552f4.a9177571.js → assets/js/af0552f4.a7387875.js
View File

File diff suppressed because one or more lines are too long

1
assets/js/dd1ef1bb.11bb3352.js
View File

File diff suppressed because one or more lines are too long

1
assets/js/dd1ef1bb.9a7f1119.js Normal file
View File

File diff suppressed because one or more lines are too long

2
assets/js/f6aebfbf.2d2a8d1f.js → assets/js/f6aebfbf.be876a01.js
View File

File diff suppressed because one or more lines are too long

2
assets/js/runtime~main.8e7ce233.js → assets/js/runtime~main.7e107033.js
View File

@@ -1 +1 @@
(()=>{"use strict";var e,t,r,a,o,f={},n={};function d(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=f,d.c=n,e=[],d.O=(t,r,a,o)=>{if(!r){var f=1/0;for(i=0;i<e.length;i++){r=e[i][0],a=e[i][1],o=e[i][2];for(var n=!0,c=0;c<r.length;c++)(!1&o||f>=o)&&Object.keys(d.O).every((e=>d.O[e](r[c])))?r.splice(c--,1):(n=!1,o<f&&(f=o));if(n){e.splice(i--,1);var b=a();void 0!==b&&(t=b)}}return t}o=o||0;for(var i=e.length;i>0&&e[i-1][2]>o;i--)e[i]=e[i-1];e[i]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var f={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,d.d(o,f),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({53:"935f2afb",74:"4c5c6dbb",85:"1f391b9e",110:"4c5f7ef0",158:"af0552f4",189:"3bd150b0",237:"1df93b7f",306:"f6aebfbf",360:"e20f0e33",368:"a94703ab",414:"393be207",518:"a7bd4aaa",597:"5e8c322a",634:"dd1ef1bb",661:"5e95c892",683:"40bcb77d",813:"1004470c",879:"6cd1f720",882:"0d14a3de",902:"38e469bb",918:"17896441"}[e]||e)+"."+{53:"176563cc",74:"5eacaab7",85:"fb84bd49",110:"1eddde5d",158:"a9177571",189:"7f274eed",205:"a504205b",237:"195d85bd",306:"2d2a8d1f",360:"9355558a",368:"ce5eb4f8",414:"8d59245f",463:"1a7f0802",518:"29c729f3",597:"4a12ac30",634:"11bb3352",661:"35d85233",683:"8b969151",813:"bc0f48c6",879:"dde22d01",882:"a3aa7aad",902:"c2989604",918:"1fa4b72c"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="simple-scaffold-docs:",d.l=(e,t,r,f)=>{if(a[e])a[e].push(t);else{var n,c;if(void 0!==r)for(var b=document.getElementsByTagName("script"),i=0;i<b.length;i++){var l=b[i];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){n=l;break}}n||(c=!0,(n=document.createElement("script")).charset="utf-8",n.timeout=120,d.nc&&n.setAttribute("nonce",d.nc),n.setAttribute("data-webpack",o+r),n.src=e),a[e]=[t];var s=(t,r)=>{n.onerror=n.onload=null,clearTimeout(u);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},u=setTimeout(s.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=s.bind(null,n.onerror),n.onload=s.bind(null,n.onload),c&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/simple-scaffold/",d.gca=function(e){return e={17896441:"918","935f2afb":"53","4c5c6dbb":"74","1f391b9e":"85","4c5f7ef0":"110",af0552f4:"158","3bd150b0":"189","1df93b7f":"237",f6aebfbf:"306",e20f0e33:"360",a94703ab:"368","393be207":"414",a7bd4aaa:"518","5e8c322a":"597",dd1ef1bb:"634","5e95c892":"661","40bcb77d":"683","1004470c":"813","6cd1f720":"879","0d14a3de":"882","38e469bb":"902"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var f=d.p+d.u(t),n=new Error;d.l(f,(r=>{if(d.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),f=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+f+")",n.name="ChunkLoadError",n.type=o,n.request=f,a[1](n)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,f=r[0],n=r[1],c=r[2],b=0;if(f.some((t=>0!==e[t]))){for(a in n)d.o(n,a)&&(d.m[a]=n[a]);if(c)var i=c(d)}for(t&&t(r);b<f.length;b++)o=f[b],d.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return d.O(i)},r=self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();
(()=>{"use strict";var e,t,r,a,o,f={},n={};function d(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=f,d.c=n,e=[],d.O=(t,r,a,o)=>{if(!r){var f=1/0;for(i=0;i<e.length;i++){r=e[i][0],a=e[i][1],o=e[i][2];for(var n=!0,c=0;c<r.length;c++)(!1&o||f>=o)&&Object.keys(d.O).every((e=>d.O[e](r[c])))?r.splice(c--,1):(n=!1,o<f&&(f=o));if(n){e.splice(i--,1);var b=a();void 0!==b&&(t=b)}}return t}o=o||0;for(var i=e.length;i>0&&e[i-1][2]>o;i--)e[i]=e[i-1];e[i]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var f={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,d.d(o,f),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({53:"935f2afb",74:"4c5c6dbb",85:"1f391b9e",110:"4c5f7ef0",158:"af0552f4",189:"3bd150b0",237:"1df93b7f",306:"f6aebfbf",360:"e20f0e33",368:"a94703ab",414:"393be207",518:"a7bd4aaa",597:"5e8c322a",634:"dd1ef1bb",661:"5e95c892",683:"40bcb77d",813:"1004470c",879:"6cd1f720",882:"0d14a3de",902:"38e469bb",918:"17896441"}[e]||e)+"."+{53:"176563cc",74:"5eacaab7",85:"fb84bd49",110:"1eddde5d",158:"a7387875",189:"83e20e07",205:"a504205b",237:"195d85bd",306:"be876a01",360:"9355558a",368:"ce5eb4f8",414:"8d59245f",463:"1a7f0802",518:"29c729f3",597:"4a12ac30",634:"9a7f1119",661:"35d85233",683:"8b969151",813:"bc0f48c6",879:"dde22d01",882:"a3aa7aad",902:"c2989604",918:"1fa4b72c"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="simple-scaffold-docs:",d.l=(e,t,r,f)=>{if(a[e])a[e].push(t);else{var n,c;if(void 0!==r)for(var b=document.getElementsByTagName("script"),i=0;i<b.length;i++){var l=b[i];if(l.getAttribute("src")==e||l.getAttribute("data-webpack")==o+r){n=l;break}}n||(c=!0,(n=document.createElement("script")).charset="utf-8",n.timeout=120,d.nc&&n.setAttribute("nonce",d.nc),n.setAttribute("data-webpack",o+r),n.src=e),a[e]=[t];var s=(t,r)=>{n.onerror=n.onload=null,clearTimeout(u);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},u=setTimeout(s.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=s.bind(null,n.onerror),n.onload=s.bind(null,n.onload),c&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/simple-scaffold/",d.gca=function(e){return e={17896441:"918","935f2afb":"53","4c5c6dbb":"74","1f391b9e":"85","4c5f7ef0":"110",af0552f4:"158","3bd150b0":"189","1df93b7f":"237",f6aebfbf:"306",e20f0e33:"360",a94703ab:"368","393be207":"414",a7bd4aaa:"518","5e8c322a":"597",dd1ef1bb:"634","5e95c892":"661","40bcb77d":"683","1004470c":"813","6cd1f720":"879","0d14a3de":"882","38e469bb":"902"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var f=d.p+d.u(t),n=new Error;d.l(f,(r=>{if(d.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),f=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+f+")",n.name="ChunkLoadError",n.type=o,n.request=f,a[1](n)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,f=r[0],n=r[1],c=r[2],b=0;if(f.some((t=>0!==e[t]))){for(a in n)d.o(n,a)&&(d.m[a]=n[a]);if(c)var i=c(d)}for(t&&t(r);b<f.length;b++)o=f[b],d.o(e,o)&&e[o]&&e[o][0](),e[o]=0;return d.O(i)},r=self.webpackChunksimple_scaffold_docs=self.webpackChunksimple_scaffold_docs||[];r.forEach(t.bind(null,0)),r.push=t.bind(null,r.push.bind(r))})()})();

2
docs/api/index.html
View File

@@ -6,7 +6,7 @@
<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/"><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="Simple Scaffold"><meta data-rh="true" property="og:description" content="Simple Scaffold"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/api/"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

30
docs/api/interfaces/ScaffoldCmdConfig/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Interface: ScaffoldCmdConfig | 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/interfaces/ScaffoldCmdConfig"><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="Interface: ScaffoldCmdConfig | Simple Scaffold"><meta data-rh="true" name="description" content="The Scaffold config for CLI"><meta data-rh="true" property="og:description" content="The Scaffold config for CLI"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/api/interfaces/ScaffoldCmdConfig"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/interfaces/ScaffoldCmdConfig" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/interfaces/ScaffoldCmdConfig" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@@ -19,55 +19,55 @@ Contains less and more specific options than <a href="/simple-scaffold/docs/api/
<p>• <strong>name</strong>: <code>string</code></p>
<p>The name of the scaffold template to use.</p>
<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/802f43c/src/types.ts#L329" target="_blank" rel="noopener noreferrer">types.ts:329</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L329" target="_blank" rel="noopener noreferrer">types.ts:329</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="templates">templates<a href="#templates" class="hash-link" aria-label="Direct link to templates" title="Direct link to templates">​</a></h3>
<p>• <strong>templates</strong>: <code>string</code>[]</p>
<p>The templates to use for generation</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/802f43c/src/types.ts#L331" target="_blank" rel="noopener noreferrer">types.ts:331</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L331" target="_blank" rel="noopener noreferrer">types.ts:331</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="output">output<a href="#output" class="hash-link" aria-label="Direct link to output" title="Direct link to output">​</a></h3>
<p>• <strong>output</strong>: <code>string</code></p>
<p>The output path to write to</p>
<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/802f43c/src/types.ts#L333" target="_blank" rel="noopener noreferrer">types.ts:333</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L333" target="_blank" rel="noopener noreferrer">types.ts:333</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="subdir">subdir<a href="#subdir" class="hash-link" aria-label="Direct link to subdir" title="Direct link to subdir">​</a></h3>
<p>• <strong>subdir</strong>: <code>boolean</code></p>
<p>Whether to create subfolder with the input name</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/802f43c/src/types.ts#L335" target="_blank" rel="noopener noreferrer">types.ts:335</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L335" target="_blank" rel="noopener noreferrer">types.ts:335</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="subdirhelper">subdirHelper<a href="#subdirhelper" class="hash-link" aria-label="Direct link to subdirHelper" title="Direct link to subdirHelper">​</a></h3>
<p>• <code>Optional</code> <strong>subdirHelper</strong>: <code>string</code></p>
<p>Default transformer to apply to subfolder name when using <code>subdir: true</code></p>
<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/802f43c/src/types.ts#L337" target="_blank" rel="noopener noreferrer">types.ts:337</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L337" target="_blank" rel="noopener noreferrer">types.ts:337</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="data">data<a href="#data" class="hash-link" aria-label="Direct link to data" title="Direct link to data">​</a></h3>
<p>• <code>Optional</code> <strong>data</strong>: <code>Record</code>&lt;<code>string</code>, <code>string</code>&gt;</p>
<p>Add custom data to the templates</p>
<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/802f43c/src/types.ts#L339" target="_blank" rel="noopener noreferrer">types.ts:339</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L339" target="_blank" rel="noopener noreferrer">types.ts:339</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="appenddata">appendData<a href="#appenddata" class="hash-link" aria-label="Direct link to appendData" title="Direct link to appendData">​</a></h3>
<p>• <code>Optional</code> <strong>appendData</strong>: <code>Record</code>&lt;<code>string</code>, <code>string</code>&gt;</p>
<p>Add custom data to the template in a CLI-friendly syntax (and not JSON)</p>
<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/802f43c/src/types.ts#L341" target="_blank" rel="noopener noreferrer">types.ts:341</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L341" target="_blank" rel="noopener noreferrer">types.ts:341</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="overwrite">overwrite<a href="#overwrite" class="hash-link" aria-label="Direct link to overwrite" title="Direct link to overwrite">​</a></h3>
<p>• <strong>overwrite</strong>: <code>boolean</code></p>
<p>Enable to override output files, even if they already exist</p>
<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/802f43c/src/types.ts#L343" target="_blank" rel="noopener noreferrer">types.ts:343</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L343" target="_blank" rel="noopener noreferrer">types.ts:343</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="quiet">quiet<a href="#quiet" class="hash-link" aria-label="Direct link to quiet" title="Direct link to quiet">​</a></h3>
<p>• <strong>quiet</strong>: <code>boolean</code></p>
<p>Silence logs, same as <code>logLevel: &quot;none&quot;</code></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/802f43c/src/types.ts#L345" target="_blank" rel="noopener noreferrer">types.ts:345</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L345" target="_blank" rel="noopener noreferrer">types.ts:345</a></p>
<hr>
<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>• <strong>logLevel</strong>: <a href="/simple-scaffold/docs/api/modules#loglevel-1"><code>LogLevel</code></a></p>
@@ -75,30 +75,30 @@ Contains less and more specific options than <a href="/simple-scaffold/docs/api/
<p><strong><code>See</code></strong></p>
<p><a href="/simple-scaffold/docs/api/modules#loglevel">LogLevel</a></p>
<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/802f43c/src/types.ts#L351" target="_blank" rel="noopener noreferrer">types.ts:351</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L351" target="_blank" rel="noopener noreferrer">types.ts:351</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="dryrun">dryRun<a href="#dryrun" class="hash-link" aria-label="Direct link to dryRun" title="Direct link to dryRun">​</a></h3>
<p>• <strong>dryRun</strong>: <code>boolean</code></p>
<p>Don&#x27;t emit files. This is good for testing your scaffolds and making sure they don&#x27;t fail, without having to write actual file contents or create directories.</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/802f43c/src/types.ts#L353" target="_blank" rel="noopener noreferrer">types.ts:353</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L353" target="_blank" rel="noopener noreferrer">types.ts:353</a></p>
<hr>
<h3 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></h3>
<p>• <code>Optional</code> <strong>config</strong>: <code>string</code></p>
<p>Config file path to use</p>
<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/802f43c/src/types.ts#L355" target="_blank" rel="noopener noreferrer">types.ts:355</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L355" target="_blank" rel="noopener noreferrer">types.ts:355</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="key">key<a href="#key" class="hash-link" aria-label="Direct link to key" title="Direct link to key">​</a></h3>
<p>• <code>Optional</code> <strong>key</strong>: <code>string</code></p>
<p>The key of the template to use</p>
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-12">Defined in<a href="#defined-in-12" 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/802f43c/src/types.ts#L357" target="_blank" rel="noopener noreferrer">types.ts:357</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L357" target="_blank" rel="noopener noreferrer">types.ts:357</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="git">git<a href="#git" class="hash-link" aria-label="Direct link to git" title="Direct link to git">​</a></h3>
<p>• <code>Optional</code> <strong>git</strong>: <code>string</code></p>
<p>The git repository to use to fetch the config file</p>
<h4 class="anchor anchorWithStickyNavbar_zTgU" id="defined-in-13">Defined in<a href="#defined-in-13" 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/802f43c/src/types.ts#L359" target="_blank" rel="noopener noreferrer">types.ts:359</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/modules"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Exports</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="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#name" class="table-of-contents__link toc-highlight">name</a></li><li><a href="#templates" class="table-of-contents__link toc-highlight">templates</a></li><li><a href="#output" class="table-of-contents__link toc-highlight">output</a></li><li><a href="#subdir" class="table-of-contents__link toc-highlight">subdir</a></li><li><a href="#subdirhelper" class="table-of-contents__link toc-highlight">subdirHelper</a></li><li><a href="#data" class="table-of-contents__link toc-highlight">data</a></li><li><a href="#appenddata" class="table-of-contents__link toc-highlight">appendData</a></li><li><a href="#overwrite" class="table-of-contents__link toc-highlight">overwrite</a></li><li><a href="#quiet" class="table-of-contents__link toc-highlight">quiet</a></li><li><a href="#loglevel" class="table-of-contents__link toc-highlight">logLevel</a></li><li><a href="#dryrun" class="table-of-contents__link toc-highlight">dryRun</a></li><li><a href="#config" class="table-of-contents__link toc-highlight">config</a></li><li><a href="#key" class="table-of-contents__link toc-highlight">key</a></li><li><a href="#git" class="table-of-contents__link toc-highlight">git</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>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L359" target="_blank" rel="noopener noreferrer">types.ts:359</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/modules"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Exports</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="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#name" class="table-of-contents__link toc-highlight">name</a></li><li><a href="#templates" class="table-of-contents__link toc-highlight">templates</a></li><li><a href="#output" class="table-of-contents__link toc-highlight">output</a></li><li><a href="#subdir" class="table-of-contents__link toc-highlight">subdir</a></li><li><a href="#subdirhelper" class="table-of-contents__link toc-highlight">subdirHelper</a></li><li><a href="#data" class="table-of-contents__link toc-highlight">data</a></li><li><a href="#appenddata" class="table-of-contents__link toc-highlight">appendData</a></li><li><a href="#overwrite" class="table-of-contents__link toc-highlight">overwrite</a></li><li><a href="#quiet" class="table-of-contents__link toc-highlight">quiet</a></li><li><a href="#loglevel" class="table-of-contents__link toc-highlight">logLevel</a></li><li><a href="#dryrun" class="table-of-contents__link toc-highlight">dryRun</a></li><li><a href="#config" class="table-of-contents__link toc-highlight">config</a></li><li><a href="#key" class="table-of-contents__link toc-highlight">key</a></li><li><a href="#git" class="table-of-contents__link toc-highlight">git</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>

24
docs/api/interfaces/ScaffoldConfig/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Interface: ScaffoldConfig | 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/interfaces/ScaffoldConfig"><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="Interface: ScaffoldConfig | Simple Scaffold"><meta data-rh="true" name="description" content="The config object for defining a scaffolding group."><meta data-rh="true" property="og:description" content="The config object for defining a scaffolding group."><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/api/interfaces/ScaffoldConfig"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/interfaces/ScaffoldConfig" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/api/interfaces/ScaffoldConfig" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@@ -27,7 +27,7 @@
<p>Name to be passed to the generated files. <code>{{name}}</code> and <code>{{Name}}</code> inside contents and file names will be replaced
accordingly.</p>
<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/802f43c/src/types.ts#L19" target="_blank" rel="noopener noreferrer">types.ts:19</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L19" target="_blank" rel="noopener noreferrer">types.ts:19</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="templates">templates<a href="#templates" class="hash-link" aria-label="Direct link to templates" title="Direct link to templates">​</a></h3>
<p>• <strong>templates</strong>: <code>string</code>[]</p>
@@ -36,7 +36,7 @@ or a glob pattern for multiple file matching easily.</p>
<p><strong><code>Default</code></strong></p>
<div class="language-ts codeBlockContainer_lofb theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_CIqb"><pre tabindex="0" class="prism-code language-ts codeBlock_H1Bz thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_GTCY"><span class="token-line" style="color:#393A34"><span class="token plain">Current working directory</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>
<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/802f43c/src/types.ts#L27" target="_blank" rel="noopener noreferrer">types.ts:27</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L27" target="_blank" rel="noopener noreferrer">types.ts:27</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="output">output<a href="#output" class="hash-link" aria-label="Direct link to output" title="Direct link to output">​</a></h3>
<p>• <strong>output</strong>: <a href="/simple-scaffold/docs/api/modules#fileresponse"><code>FileResponse</code></a>&lt;<code>string</code>&gt;</p>
@@ -48,7 +48,7 @@ or a glob pattern for multiple file matching easily.</p>
<li><a href="/simple-scaffold/docs/api/modules#fileresponsehandler">FileResponseHandler</a></li>
</ul>
<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/802f43c/src/types.ts#L37" target="_blank" rel="noopener noreferrer">types.ts:37</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L37" target="_blank" rel="noopener noreferrer">types.ts:37</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="subdir">subdir<a href="#subdir" class="hash-link" aria-label="Direct link to subdir" title="Direct link to subdir">​</a></h3>
<p>• <code>Optional</code> <strong>subdir</strong>: <code>boolean</code></p>
@@ -58,14 +58,14 @@ the directory name.</p>
<p><strong><code>Default</code></strong></p>
<p><code>false</code></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/802f43c/src/types.ts#L47" target="_blank" rel="noopener noreferrer">types.ts:47</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L47" target="_blank" rel="noopener noreferrer">types.ts:47</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="data">data<a href="#data" class="hash-link" aria-label="Direct link to data" title="Direct link to data">​</a></h3>
<p>• <code>Optional</code> <strong>data</strong>: <code>Record</code>&lt;<code>string</code>, <code>any</code>&gt;</p>
<p>Add custom data to the templates. By default, only your app name is included as <code>{{name}}</code> and <code>{{Name}}</code>.</p>
<p>This can be any object that will be usable by Handlebars.</p>
<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/802f43c/src/types.ts#L54" target="_blank" rel="noopener noreferrer">types.ts:54</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L54" target="_blank" rel="noopener noreferrer">types.ts:54</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="overwrite">overwrite<a href="#overwrite" class="hash-link" aria-label="Direct link to overwrite" title="Direct link to overwrite">​</a></h3>
<p>• <code>Optional</code> <strong>overwrite</strong>: <a href="/simple-scaffold/docs/api/modules#fileresponse"><code>FileResponse</code></a>&lt;<code>boolean</code>&gt;</p>
@@ -81,7 +81,7 @@ a boolean for each file.</p>
<p><strong><code>Default</code></strong></p>
<p><code>false</code></p>
<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/802f43c/src/types.ts#L69" target="_blank" rel="noopener noreferrer">types.ts:69</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L69" target="_blank" rel="noopener noreferrer">types.ts:69</a></p>
<hr>
<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>Optional</code> <strong>logLevel</strong>: <a href="/simple-scaffold/docs/api/modules#loglevel-1"><code>LogLevel</code></a></p>
@@ -93,7 +93,7 @@ of the same level or higher.</p>
<p><strong><code>Default</code></strong></p>
<p><code>2 (info)</code></p>
<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/802f43c/src/types.ts#L81" target="_blank" rel="noopener noreferrer">types.ts:81</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L81" target="_blank" rel="noopener noreferrer">types.ts:81</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="dryrun">dryRun<a href="#dryrun" class="hash-link" aria-label="Direct link to dryRun" title="Direct link to dryRun">​</a></h3>
<p>• <code>Optional</code> <strong>dryRun</strong>: <code>boolean</code></p>
@@ -102,7 +102,7 @@ actual file contents or create directories.</p>
<p><strong><code>Default</code></strong></p>
<p><code>false</code></p>
<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/802f43c/src/types.ts#L89" target="_blank" rel="noopener noreferrer">types.ts:89</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L89" target="_blank" rel="noopener noreferrer">types.ts:89</a></p>
<hr>
<h3 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></h3>
<p>• <code>Optional</code> <strong>helpers</strong>: <code>Record</code>&lt;<code>string</code>, <code>HelperDelegate</code>&gt;</p>
@@ -126,7 +126,7 @@ and the value is the helper function itself. The signature of helpers is as foll
<li><a href="https://chenasraf.github.io/simple-scaffold/docs/usage/templates%7C" target="_blank" rel="noopener noreferrer">Templates</a></li>
</ul>
<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/802f43c/src/types.ts#L131" target="_blank" rel="noopener noreferrer">types.ts:131</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L131" target="_blank" rel="noopener noreferrer">types.ts:131</a></p>
<hr>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="subdirhelper">subdirHelper<a href="#subdirhelper" class="hash-link" aria-label="Direct link to subdirHelper" title="Direct link to subdirHelper">​</a></h3>
<p>• <code>Optional</code> <strong>subdirHelper</strong>: <code>string</code></p>
@@ -140,7 +140,7 @@ transformation is done.</p>
<li><a href="/simple-scaffold/docs/api/modules#defaulthelpers">DefaultHelpers</a></li>
</ul>
<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/802f43c/src/types.ts#L142" target="_blank" rel="noopener noreferrer">types.ts:142</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L142" target="_blank" rel="noopener noreferrer">types.ts:142</a></p>
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="methods">Methods<a href="#methods" class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods">​</a></h2>
<h3 class="anchor anchorWithStickyNavbar_zTgU" id="beforewrite">beforeWrite<a href="#beforewrite" class="hash-link" aria-label="Direct link to beforeWrite" title="Direct link to beforeWrite">​</a></h3>
<p>▸ <strong>beforeWrite</strong>(<code>content</code>, <code>rawContent</code>, <code>outputPath</code>): <code>undefined</code> | <code>string</code> | <code>Buffer</code> | <code>Promise</code>&lt;<code>undefined</code> | <code>string</code> | <code>Buffer</code>&gt;</p>
@@ -155,6 +155,6 @@ you may run formatters on a file, fix output in edge-cases not supported by help
<p>The final output of the file
contents-only, after further modifications - or <code>undefined</code> to use the original content (i.e. <code>content.toString()</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/802f43c/src/types.ts#L158" target="_blank" rel="noopener noreferrer">types.ts:158</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/interfaces/ScaffoldCmdConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">ScaffoldCmdConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/simple-scaffold/docs/usage/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Usage</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="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#name" class="table-of-contents__link toc-highlight">name</a></li><li><a href="#templates" class="table-of-contents__link toc-highlight">templates</a></li><li><a href="#output" class="table-of-contents__link toc-highlight">output</a></li><li><a href="#subdir" class="table-of-contents__link toc-highlight">subdir</a></li><li><a href="#data" class="table-of-contents__link toc-highlight">data</a></li><li><a href="#overwrite" class="table-of-contents__link toc-highlight">overwrite</a></li><li><a href="#loglevel" class="table-of-contents__link toc-highlight">logLevel</a></li><li><a href="#dryrun" class="table-of-contents__link toc-highlight">dryRun</a></li><li><a href="#helpers" class="table-of-contents__link toc-highlight">helpers</a></li><li><a href="#subdirhelper" class="table-of-contents__link toc-highlight">subdirHelper</a></li></ul></li><li><a href="#methods" class="table-of-contents__link toc-highlight">Methods</a><ul><li><a href="#beforewrite" class="table-of-contents__link toc-highlight">beforeWrite</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>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L158" target="_blank" rel="noopener noreferrer">types.ts:158</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/interfaces/ScaffoldCmdConfig"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">ScaffoldCmdConfig</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/simple-scaffold/docs/usage/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Usage</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="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#name" class="table-of-contents__link toc-highlight">name</a></li><li><a href="#templates" class="table-of-contents__link toc-highlight">templates</a></li><li><a href="#output" class="table-of-contents__link toc-highlight">output</a></li><li><a href="#subdir" class="table-of-contents__link toc-highlight">subdir</a></li><li><a href="#data" class="table-of-contents__link toc-highlight">data</a></li><li><a href="#overwrite" class="table-of-contents__link toc-highlight">overwrite</a></li><li><a href="#loglevel" class="table-of-contents__link toc-highlight">logLevel</a></li><li><a href="#dryrun" class="table-of-contents__link toc-highlight">dryRun</a></li><li><a href="#helpers" class="table-of-contents__link toc-highlight">helpers</a></li><li><a href="#subdirhelper" class="table-of-contents__link toc-highlight">subdirHelper</a></li></ul></li><li><a href="#methods" class="table-of-contents__link toc-highlight">Methods</a><ul><li><a href="#beforewrite" class="table-of-contents__link toc-highlight">beforeWrite</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>

28
docs/api/modules/index.html
View File

@@ -6,7 +6,7 @@
<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/favicon.ico"><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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@@ -47,7 +47,7 @@ pre-define the data and use a duplicated key.</p>
<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/802f43c/src/scaffold.ts#L57" target="_blank" rel="noopener noreferrer">scaffold.ts:57</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/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>&lt;<code>T</code>&gt;: (<code>fullPath</code>: <code>string</code>, <code>basedir</code>: <code>string</code>, <code>basename</code>: <code>string</code>) =&gt; <code>T</code></p>
@@ -61,7 +61,7 @@ pre-define the data and use a duplicated key.</p>
<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/802f43c/src/types.ts#L305" target="_blank" rel="noopener noreferrer">types.ts:305</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L305" target="_blank" rel="noopener noreferrer">types.ts:305</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>&lt;<code>T</code>&gt;: <code>T</code> | <a href="/simple-scaffold/docs/api/modules#fileresponsehandler"><code>FileResponseHandler</code></a>&lt;<code>T</code>&gt;</p>
@@ -78,7 +78,7 @@ Can either be:</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/802f43c/src/types.ts#L321" target="_blank" rel="noopener noreferrer">types.ts:321</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L321" target="_blank" rel="noopener noreferrer">types.ts:321</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>&quot;camelCase&quot;</code> | <code>&quot;hyphenCase&quot;</code> | <code>&quot;kebabCase&quot;</code> | <code>&quot;lowerCase&quot;</code> | <code>&quot;pascalCase&quot;</code> | <code>&quot;snakeCase&quot;</code> | <code>&quot;startCase&quot;</code> | <code>&quot;upperCase&quot;</code></p>
@@ -93,7 +93,7 @@ Can either be:</p>
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig#subdirhelper">ScaffoldConfig.subdirHelper</a></li>
</ul>
<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/802f43c/src/types.ts#L189" target="_blank" rel="noopener noreferrer">types.ts:189</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/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>&quot;date&quot;</code> | <code>&quot;now&quot;</code></p>
@@ -122,7 +122,7 @@ the current date.</p>
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</a></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/802f43c/src/types.ts#L236" target="_blank" rel="noopener noreferrer">types.ts:236</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/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>
@@ -137,13 +137,13 @@ replace <code>My Name</code> with <code>my_name</code> when producing the final
<li><a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig">ScaffoldConfig</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/802f43c/src/types.ts#L251" target="_blank" rel="noopener noreferrer">types.ts:251</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/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-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/802f43c/src/types.ts#L258" target="_blank" rel="noopener noreferrer">types.ts:258</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L258" target="_blank" rel="noopener noreferrer">types.ts:258</a></p>
<h2 class="anchor anchorWithStickyNavbar_zTgU" id="logging">Logging<a href="#logging" class="hash-link" aria-label="Direct link to Logging" title="Direct link to Logging">​</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>Ƭ <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>
@@ -156,16 +156,16 @@ For example, <code>2</code> or <code>info</code> are both valid.</p>
<p><strong><code>Default</code></strong></p>
<p><code>2 (info)</code></p>
<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/802f43c/src/types.ts#L260" target="_blank" rel="noopener noreferrer">types.ts:260</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/802f43c/src/types.ts#L291" target="_blank" rel="noopener noreferrer">types.ts:291</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L260" target="_blank" rel="noopener noreferrer">types.ts:260</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L291" target="_blank" rel="noopener noreferrer">types.ts:291</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="loglevel-1">LogLevel<a href="#loglevel-1" 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>
<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>&quot;none&quot;</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>&quot;debug&quot;</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>&quot;info&quot;</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>&quot;warning&quot;</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>&quot;error&quot;</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-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/802f43c/src/types.ts#L260" target="_blank" rel="noopener noreferrer">types.ts:260</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/802f43c/src/types.ts#L291" target="_blank" rel="noopener noreferrer">types.ts:291</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L260" target="_blank" rel="noopener noreferrer">types.ts:260</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L291" target="_blank" rel="noopener noreferrer">types.ts:291</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>&lt;<code>string</code>, <a href="/simple-scaffold/docs/api/interfaces/ScaffoldConfig"><code>ScaffoldConfig</code></a>&gt;</p>
@@ -176,7 +176,7 @@ For example, <code>2</code> or <code>info</code> are both valid.</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-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/802f43c/src/types.ts#L373" target="_blank" rel="noopener noreferrer">types.ts:373</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L373" target="_blank" rel="noopener noreferrer">types.ts:373</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>&lt;<a href="/simple-scaffold/docs/api/interfaces/ScaffoldCmdConfig"><code>ScaffoldCmdConfig</code></a>, <a href="/simple-scaffold/docs/api/modules#scaffoldconfigmap"><code>ScaffoldConfigMap</code></a>&gt;</p>
@@ -188,7 +188,7 @@ For example, <code>2</code> or <code>info</code> are both valid.</p>
<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-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/802f43c/src/types.ts#L381" target="_blank" rel="noopener noreferrer">types.ts:381</a></p>
<p><a href="https://github.com/chenasraf/simple-scaffold/blob/bfee26f/src/types.ts#L381" target="_blank" rel="noopener noreferrer">types.ts:381</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/ScaffoldCmdConfig"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">ScaffoldCmdConfig</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></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" class="table-of-contents__link toc-highlight">Logging</a><ul><li><a href="#loglevel" 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="#loglevel-1" class="table-of-contents__link toc-highlight">LogLevel</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><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>

2
docs/usage/cli/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">CLI Usage | 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/usage/cli"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="CLI Usage | Simple Scaffold"><meta data-rh="true" name="description" content="Available flags"><meta data-rh="true" property="og:description" content="Available flags"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/usage/cli"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/cli" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/cli" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/usage/configuration_files/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Configuration Files | 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/usage/configuration_files"><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="Configuration Files | Simple Scaffold"><meta data-rh="true" name="description" content="If you want to have reusable configurations which are complex and don&#x27;t fit into command lines"><meta data-rh="true" property="og:description" content="If you want to have reusable configurations which are complex and don&#x27;t fit into command lines"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/usage/configuration_files"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/configuration_files" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/configuration_files" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/usage/examples/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Examples | 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/usage/examples"><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="Examples | Simple Scaffold"><meta data-rh="true" name="description" content="Example files"><meta data-rh="true" property="og:description" content="Example files"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/usage/examples"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/examples" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/examples" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/usage/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Usage | 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/usage/"><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="Usage | Simple Scaffold"><meta data-rh="true" name="description" content="- CLI Usage"><meta data-rh="true" property="og:description" content="- CLI Usage"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/usage/"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

5
docs/usage/migration/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Migration | 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/usage/migration"><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="Migration | Simple Scaffold"><meta data-rh="true" name="description" content="v1.x to v2.x"><meta data-rh="true" property="og:description" content="v1.x to v2.x"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/usage/migration"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/migration" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/migration" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
@@ -27,8 +27,7 @@ Scaffold which file to look for inside the git project. There is a default file
which can find the file for you if it is in one of the supported filenames.</li>
</ul>
</li>
<li><code>verbose</code> can now take the names <code>debug</code>, <code>info</code>, <code>warn</code>, <code>error</code> or <code>none</code> (case insensitive) or
as usual by using the numbering from before.</li>
<li><code>verbose</code> can now take the names <code>debug</code>, <code>info</code>, <code>warn</code>, <code>error</code> or <code>none</code> (case insensitive).</li>
<li><code>--create-sub-folder</code> (<code>-s</code>) has been renamed to <code>--subdir</code> (<code>-s</code>) in the CLI. The Node.js names
have been changed as well.</li>
<li><code>--sub-folder-name-helper</code> (<code>-sh</code>) has been renamed to <code>--subdir-helper</code> (<code>-sh</code>). The Node.js

2
docs/usage/node/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Node.js Usage | 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/usage/node"><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="Node.js Usage | Simple Scaffold"><meta data-rh="true" name="description" content="You can build the scaffold yourself, if you want to create more complex arguments, scaffold groups,"><meta data-rh="true" property="og:description" content="You can build the scaffold yourself, if you want to create more complex arguments, scaffold groups,"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/usage/node"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/node" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/node" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
docs/usage/templates/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Template Files | 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/usage/templates"><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="Template Files | Simple Scaffold"><meta data-rh="true" name="description" content="Put your template files anywhere, and fill them with tokens for replacement."><meta data-rh="true" property="og:description" content="Put your template files anywhere, and fill them with tokens for replacement."><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/docs/usage/templates"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/templates" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/docs/usage/templates" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
index.html
View File

@@ -6,7 +6,7 @@
<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/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Simple Scaffold | Simple Scaffold"><meta data-rh="true" name="description" content="Description will go into a meta tag in &lt;head /&gt;"><meta data-rh="true" property="og:description" content="Description will go into a meta tag in &lt;head /&gt;"><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/" hreflang="x-default"><script data-rh="true">function insertBanner(){var n=document.createElement("div");n.id="__docusaurus-base-url-issue-banner-container";n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/simple-scaffold/</span> </p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n',document.body.prepend(n);var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,o="/"===s.substr(-1)?s:s+"/";e.innerHTML=o}document.addEventListener("DOMContentLoaded",(function(){void 0===window.docusaurus&&insertBanner()}))</script><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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">

2
markdown-page/index.html
View File

@@ -6,7 +6,7 @@
<title data-rh="true">Markdown page example | 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/markdown-page"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" property="og:title" content="Markdown page example | Simple Scaffold"><meta data-rh="true" name="description" content="You don&#x27;t need React to write simple standalone pages."><meta data-rh="true" property="og:description" content="You don&#x27;t need React to write simple standalone pages."><link data-rh="true" rel="icon" href="/simple-scaffold/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://chenasraf.github.io/simple-scaffold/markdown-page"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/markdown-page" hreflang="en"><link data-rh="true" rel="alternate" href="https://chenasraf.github.io/simple-scaffold/markdown-page" 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.76d0e6bb.css">
<script src="/simple-scaffold/assets/js/runtime~main.8e7ce233.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/runtime~main.7e107033.js" defer="defer"></script>
<script src="/simple-scaffold/assets/js/main.b4246d99.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">