creatium 0.1.3 → 0.1.5

package/README.md

@@ -12,12 +12,76 @@
 [![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge&logo=medium&logoColor=white)](https://medium.com/@pigeonposse)
 
 
+[![License](https://img.shields.io/github/license/pigeonposse/creatium?color=green&style=for-the-badge&logoColor=white)](https://github.com/pigeonposse/creatium/blob/main/LICENSE)
+[![Version](https://img.shields.io/npm/v/creatium?color=blue&style=for-the-badge&label=Version)](https://www.npmjs.com/package/creatium)
+
+## 🤔 What is it `creatium`?
+
+`creatium` is a JavaScript Library for creating project templates.
+
+> Useful for create-binaries like `pnpm create backan`
+
+[Read more](https://www.npmjs.com/package/creatium)
+
+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)
+- [📄 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)
+
+
+
+## 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)
@@ -72,14 +136,6 @@ deno install creatium
 bun add creatium
 ```
 
-## 🤔 What is it `creatium`?
-
-`creatium` is a CLI and Library for creating project templates.
-
-> Useful for create-binaries like `pnpm create backan`
-
-[Read more](https://www.npmjs.com/package/creatium)
-
 ## 🚀 Usage
 
 Create a cli and a library project with `creatium`
@@ -1524,8 +1580,6 @@ Text editor values used in `openEditor` option.
 | `WEBSTORM` | `"webstorm"` | 'webstorm' |
 
 
-***
-
 ## 👨‍💻 Development
 
 __creatium__ is an open-source project and its development is open to anyone who wants to participate.

package/dist/main.mjs

@@ -1609,7 +1609,7 @@ class CreatiumCore {
     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)
-      this.utils.prompt.outro("Succesfully finished \u{1F308}");
+      this.utils.prompt.outro("Successfully completed \u{1F308}");
   }
   /**
    * Copy a directory from input path to output path.
@@ -1661,7 +1661,7 @@ class CreatiumCore {
     try {
       s.start(`Installing with ${installer}`);
       await execChild(command[installer]);
-      s.stop(__privateGet$1(this, _style).tick + " Package installed successfully");
+      s.stop(`${__privateGet$1(this, _style).tick} Package installed with [${installer}] successfully`);
     } catch (_e) {
       if (this.debugMode)
         s.stop(`Error in installation with [${installer}]: ${_e?.toString()}`);
@@ -1697,12 +1697,12 @@ class CreatiumCore {
     try {
       s.start(`Opening in ${editor}`);
       await execChild(`${editor} ${input}`);
-      s.stop(__privateGet$1(this, _style).tick + " TEXT_EDITOR opened successfully");
+      s.stop(`${__privateGet$1(this, _style).tick} Text editor [${editor}] opened successfully`);
     } catch (_e) {
       if (this.debugMode)
-        s.stop(`Error opening in [${editor}]: ${_e?.toString()}`);
+        s.stop(`Error opening [${editor}] text editor: ${_e?.toString()}`);
       else
-        s.stop("Error opening TEXT_EDITOR");
+        s.stop(`Error opening [${editor}] text editor`);
     }
   }
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "creatium",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Build your create-bins quickly and easily",
   "bugs": {
     "url": "https://github.com/pigeonposse/creatium/issues",
@@ -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.2"
+    "@creatium/repo-config": "0.1.4"
   },
   "publishConfig": {
     "access": "public",