creatium 0.1.5 → 0.1.7

package/README.md

@@ -27,10 +27,6 @@ Demo of the `creatium` library:
 
 ![demo](https://github.com/pigeonposse/creatium/raw/main/docs/public/example.gif)
 
-## 📄 Description
-
-Build your create-bins quickly and easily
-
 ## Table of contents
 
 - [🤔 What is it `creatium`?](#-what-is-it-creatium)
@@ -38,88 +34,20 @@ Build your create-bins quickly and easily
 - [🔑 Installation](#-installation)
 - [🚀 Usage](#-usage)
   - [Simple use case](#simple-use-case)
-    - [Project structure](#project-structure)
-    - [src/core.js](#srccorejs)
-    - [src/bin.js](#srcbinjs)
-    - [src/lib.js](#srclibjs)
-    - [package.json](#packagejson)
-    - [Data (templates)](#data-templates)
-    - [Execute](#execute)
   - [Advanced use case](#advanced-use-case)
-    - [Project structure](#project-structure)
-    - [src/core.js](#srccorejs)
-    - [src/bin.js](#srcbinjs)
-    - [src/lib.js](#srclibjs)
-    - [package.json](#packagejson)
-    - [Data (templates & partials)](#data-templates--partials)
-    - [Execute](#execute)
 - [Api documentation](#api-documentation)
   - [Classes](#classes)
-    - [Creatium](#creatium)
-    - [CreatiumCore\<C\>](#creatiumcorec)
   - [Type Aliases](#type-aliases)
-    - [CliOpts](#cliopts)
-    - [Config](#config)
-    - [CreateOpts](#createopts)
-    - [CreateTemplateOpts](#createtemplateopts)
   - [Variables](#variables)
-    - [env](#env)
-    - [INSTALLER](#installer)
-    - [OPTION](#option)
-    - [prompt](#prompt)
-    - [style](#style)
-    - [sys](#sys)
-    - [TEXT\_EDITOR](#text_editor)
 - [👨‍💻 Development](#-development)
 - [☕ Donate](#-donate)
 - [📜 License](#-license)
 - [🐦 About us](#-about-us)
 
 
+## 📄 Description
 
-## Table of contents
-
-- [🤔 What is it `creatium`?](#-what-is-it-creatium)
-- [📄 Description](#-description)
-- [🔑 Installation](#-installation)
-- [🚀 Usage](#-usage)
-  - [Simple use case](#simple-use-case)
-    - [Project structure](#project-structure)
-    - [src/core.js](#srccorejs)
-    - [src/bin.js](#srcbinjs)
-    - [src/lib.js](#srclibjs)
-    - [package.json](#packagejson)
-    - [Data (templates)](#data-templates)
-    - [Execute](#execute)
-  - [Advanced use case](#advanced-use-case)
-    - [Project structure](#project-structure)
-    - [src/core.js](#srccorejs)
-    - [src/bin.js](#srcbinjs)
-    - [src/lib.js](#srclibjs)
-    - [package.json](#packagejson)
-    - [Data (templates & partials)](#data-templates--partials)
-    - [Execute](#execute)
-- [Api documentation](#api-documentation)
-  - [Classes](#classes)
-    - [Creatium](#creatium)
-    - [CreatiumCore\<C\>](#creatiumcorec)
-  - [Type Aliases](#type-aliases)
-    - [CliOpts](#cliopts)
-    - [Config](#config)
-    - [CreateOpts](#createopts)
-    - [CreateTemplateOpts](#createtemplateopts)
-  - [Variables](#variables)
-    - [env](#env)
-    - [INSTALLER](#installer)
-    - [OPTION](#option)
-    - [prompt](#prompt)
-    - [style](#style)
-    - [sys](#sys)
-    - [TEXT\_EDITOR](#text_editor)
-- [👨‍💻 Development](#-development)
-- [☕ Donate](#-donate)
-- [📜 License](#-license)
-- [🐦 About us](#-about-us)
+Build your create-bins quickly and easily
 
 
 ## 🔑 Installation
@@ -1139,6 +1067,7 @@ If the `outro` option is undefined, the default outro message will be used.
 ```ts
 replacePlaceholders(args: {
   input: string;
+  inputOpts: Options;
   params: Params;
 }): Promise<void>
 ```
@@ -1155,6 +1084,7 @@ in the content are replaced with values from the `params` object.
 | ------ | ------ | ------ |
 | `args` | `object` | The arguments object. |
 | `args.input`? | `string` | The directory path containing files with placeholders. |
+| `args.inputOpts`? | `Options` | - |
 | `args.params`? | `Params` | An object containing key-value pairs for replacing placeholders. |
 
 ###### Returns
@@ -1168,7 +1098,7 @@ A Promise that resolves once all placeholders have been replaced.
 ```ts
 await core.replacePlaceholders( {
   input  : 'my/project/path',
-  params : { placeholder1: 'value1', placeholder2: 'value2' },
+  params : { consts: { version: '1.0.0' }, prompt: { name: 'My Project' } },
 })
 ```
 

package/dist/main.d.mts

@@ -1395,12 +1395,13 @@ declare class CreatiumCore<C extends Config = Config> {
      * @example
      * await core.replacePlaceholders( {
      *   input  : 'my/project/path',
-     *   params : { placeholder1: 'value1', placeholder2: 'value2' },
+     *   params : { consts: { version: '1.0.0' }, prompt: { name: 'My Project' } },
      * })
      */
-    replacePlaceholders({ input, params, }?: {
+    replacePlaceholders({ input, params, inputOpts, }?: {
         input?: string;
         params?: Parameters<typeof replacePlaceholders>[0]['params'];
+        inputOpts?: Parameters<typeof getPaths>[1];
     }): Promise<void>;
     /**
      * Return the input path of a template by name or path.

package/dist/main.d.ts

@@ -1395,12 +1395,13 @@ declare class CreatiumCore<C extends Config = Config> {
      * @example
      * await core.replacePlaceholders( {
      *   input  : 'my/project/path',
-     *   params : { placeholder1: 'value1', placeholder2: 'value2' },
+     *   params : { consts: { version: '1.0.0' }, prompt: { name: 'My Project' } },
      * })
      */
-    replacePlaceholders({ input, params, }?: {
+    replacePlaceholders({ input, params, inputOpts, }?: {
         input?: string;
         params?: Parameters<typeof replacePlaceholders>[0]['params'];
+        inputOpts?: Parameters<typeof getPaths>[1];
     }): Promise<void>;
     /**
      * Return the input path of a template by name or path.

package/dist/main.mjs

@@ -1586,7 +1586,7 @@ class CreatiumCore {
    */
   async intro(message) {
     if (message)
-      this.utils.prompt.outro(message);
+      this.utils.prompt.intro(message);
     else if (typeof this.config.intro === "function")
       await this.config.intro(__privateGet$1(this, _data) || {});
     else if (this.config.intro === void 0) {
@@ -1604,12 +1604,14 @@ class CreatiumCore {
    * @param {string} [message] The outro message.
    */
   async outro(message) {
+    this.utils.prompt.log.step("");
     if (message)
       this.utils.prompt.outro(message);
     else if (typeof this.config.outro === "function" && __privateGet$1(this, _data))
       await this.config.outro(__privateGet$1(this, _data));
-    else if (this.config.outro === void 0)
+    else if (this.config.outro === void 0) {
       this.utils.prompt.outro("Successfully completed \u{1F308}");
+    }
   }
   /**
    * Copy a directory from input path to output path.
@@ -1718,12 +1720,13 @@ class CreatiumCore {
    * @example
    * await core.replacePlaceholders( {
    *   input  : 'my/project/path',
-   *   params : { placeholder1: 'value1', placeholder2: 'value2' },
+   *   params : { consts: { version: '1.0.0' }, prompt: { name: 'My Project' } },
    * })
    */
   async replacePlaceholders({
     input,
-    params
+    params,
+    inputOpts
   } = {}) {
     if (!input)
       input = __privateGet$1(this, _cwd);
@@ -1741,7 +1744,11 @@ class CreatiumCore {
         return void 0;
       }
     };
-    const paths = await getPaths([input], { onlyFiles: true });
+    const paths = await getPaths([input], {
+      onlyFiles: true,
+      dot: true,
+      ...inputOpts || {}
+    });
     console.debug({ templatePaths: paths });
     for (const path of paths) {
       const content = await getContent(path);
@@ -1845,7 +1852,6 @@ class CreatiumCore {
         input: data.output,
         editor: openEditor
       });
-      this.utils.prompt.log.step("");
       await this.outro();
     } catch (e) {
       const error = e instanceof Error ? e.message : e?.toString();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "creatium",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Build your create-bins quickly and easily",
   "bugs": {
     "url": "https://github.com/pigeonposse/creatium/issues",
@@ -34,12 +34,12 @@
     "boxen": "8.0.1",
     "chalk": "5.3.0",
     "columnify": "1.6.0",
-    "conf": "13.0.1",
+    "conf": "13.1.0",
     "deepmerge-ts": "7.1.3",
     "globby": "14.0.2",
     "gradient-string": "3.0.0",
     "string-width": "7.2.0",
-    "table": "6.8.2",
+    "table": "6.9.0",
     "update-notifier": "7.3.1",
     "yargs": "17.7.2"
   },
@@ -47,7 +47,7 @@
     "@types/columnify": "1.5.4",
     "@types/update-notifier": "6.0.8",
     "@types/yargs": "17.0.33",
-    "@creatium/repo-config": "0.1.4"
+    "@creatium/repo-config": "0.1.6"
   },
   "publishConfig": {
     "access": "public",