Merge branch 'beta'

Author: ptkdev

CHANGELOG.md

@@ -1,13 +1,19 @@
-# v2.0.3 (January 14, 2022)
+# v2.0.4 (January 14, 2022)
 
--   Fix: vanilla import with require()
+-   Fix: scripts
+-   Feature: examples
+-   Refactor: removed console.log()
 
 <!-- all-shields/sponsors-badges:START -->
 
 [![Donate Paypal](https://img.shields.io/badge/donate-paypal-005EA6.svg?style=for-the-badge&logo=paypal)](https://www.paypal.me/ptkdev) [![Donate Ko-Fi](https://img.shields.io/badge/donate-ko--fi-29abe0.svg?style=for-the-badge&logo=ko-fi)](https://ko-fi.com/ptkdev) [![Donate Github Sponsors](https://img.shields.io/badge/donate-sponsors-ea4aaa.svg?style=for-the-badge&logo=github)](https://github.com/sponsors/ptkdev) [![Donate Patreon](https://img.shields.io/badge/donate-patreon-F87668.svg?style=for-the-badge&logo=patreon)](https://www.patreon.com/join/ptkdev) [![Donate Bitcoin](https://img.shields.io/badge/BTC-35jQmZCy4nsxoMM3QPFrnZePDVhdKaHMRH-E38B29.svg?style=flat-square&logo=bitcoin)](https://ptk.dev/img/icons/menu/bitcoin_wallet.png) [![Donate Ethereum](https://img.shields.io/badge/ETH-0x8b8171661bEb032828e82baBb0B5B98Ba8fBEBFc-4E8EE9.svg?style=flat-square&logo=ethereum)](https://ptk.dev/img/icons/menu/ethereum_wallet.png)
 
 <!-- all-shields/sponsors-badges:END -->
 
+# v2.0.3 (January 14, 2022)
+
+-   Fix: vanilla import with require()
+
 # v2.0.2 (January 14, 2022)
 
 -   Refactor: code quality, scripts and interfaces

README.md

@@ -2,7 +2,7 @@
 
 <!-- all-shields/header-badges:START -->
 
-[![v2.0.3](https://img.shields.io/badge/version-v2.0.3-lightgray.svg?style=flat&logo=)](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/CHANGELOG.md) [![](https://img.shields.io/npm/v/@ptkdev/node-module-boilerplate?color=CC3534&logo=npm)](https://www.npmjs.com/package/@ptkdev/node-module-boilerplate) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/LICENSE.md) [![Language: TypeScript](https://img.shields.io/badge/language-typescript-blue.svg?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![ECMAScript: 2019](https://img.shields.io/badge/ES-9-F7DF1E.svg?style=flat&logo=javascript)](https://github.com/tc39/ecma262) [![Discord Server](https://discordapp.com/api/guilds/383373985666301975/embed.png)](https://discord.ptkdev.io)
+[![v2.0.4-beta.1](https://img.shields.io/badge/version-v2.0.4--beta.1-lightgray.svg?style=flat&logo=)](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/CHANGELOG.md) [![](https://img.shields.io/npm/v/@ptkdev/node-module-boilerplate?color=CC3534&logo=npm)](https://www.npmjs.com/package/@ptkdev/node-module-boilerplate) [![License: MIT](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat&logo=license)](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/LICENSE.md) [![Language: TypeScript](https://img.shields.io/badge/language-typescript-blue.svg?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![ECMAScript: 2019](https://img.shields.io/badge/ES-9-F7DF1E.svg?style=flat&logo=javascript)](https://github.com/tc39/ecma262) [![Discord Server](https://discordapp.com/api/guilds/383373985666301975/embed.png)](https://discord.ptkdev.io)
 
 <!-- all-shields/header-badges:END -->
 

package.json

@@ -2,7 +2,7 @@
 	"name": "@ptkdev/node-module-boilerplate",
 	"displayName": "Node NPM Library Boilerplate",
 	"description": "Create your npm library with this friendly boilerplate. Use this respository as template for your new node library/module",
-	"version": "2.0.3",
+	"version": "2.0.4-beta.1",
 	"main": "dist/functions/module.js",
 	"publishConfig": {
 		"access": "public"

scripts/changelog_release.ts

@@ -9,18 +9,21 @@
  *
  */
 import * as fs from "fs";
+import Logger from "@ptkdev/logger";
+
+const logger = new Logger();
 
 if (fs.existsSync("./CHANGELOG.md")) {
-	fs.readFile("./CHANGELOG.md", "utf8", (err, data) => {
-		if (err) {
-			console.log(err);
+	fs.readFile("./CHANGELOG.md", "utf8", (error, data) => {
+		if (error) {
+			logger.error(JSON.stringify(error));
 		}
 
 		const changelog = data.match(/\n([\s\S]*)-->\n/gm);
 		changelog?.forEach((c) => {
-			fs.writeFile("./CHANGELOG_RELEASE.txt", c, function writeJSON(err) {
-				if (err) {
-					console.log(err);
+			fs.writeFile("./CHANGELOG_RELEASE.txt", c, function writeJSON(error) {
+				if (error) {
+					logger.error(JSON.stringify(error));
 				}
 			});
 		});

scripts/githash.ts

@@ -8,23 +8,31 @@
  * @license: MIT License
  *
  */
+import Logger from "@ptkdev/logger";
 import fs from "fs";
 import path from "path";
 import { execSync } from "child_process";
 import semver from "../package.json";
 
+const gitdotfile = `${__dirname}/../.git/config`;
+const logger = new Logger();
+let branch = "";
+let hash = "";
+
 const execSyncWrapper = (command: string) => {
-	let stdout: string | null = null;
+	let stdout = "";
 	try {
 		stdout = execSync(command).toString().trim();
 	} catch (error) {
-		console.error(error);
+		logger.error(JSON.stringify(error));
 	}
 	return stdout;
 };
 
-const branch = execSyncWrapper("git rev-parse --abbrev-ref HEAD");
-const hash = execSyncWrapper("git rev-parse --short=7 HEAD");
+if (fs.existsSync(gitdotfile)) {
+	branch = execSyncWrapper("git rev-parse --abbrev-ref HEAD");
+	hash = execSyncWrapper("git rev-parse --short=7 HEAD");
+}
 
 const obj = {
 	semver: semver.version.split("-")[0],

scripts/setup.ts

@@ -11,11 +11,13 @@
  * @license: MIT License
  *
  */
-import * as shell from "shelljs";
+import Logger from "@ptkdev/logger";
 const replace = require("replace-in-file");
 const setup = require("../setup.json");
 const pkg = require("../package.json");
 
+const logger = new Logger();
+
 (async () => {
 	try {
 		await replace({
@@ -25,7 +27,7 @@ const pkg = require("../package.json");
 			to: setup.github_full_repository_url,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -36,7 +38,7 @@ const pkg = require("../package.json");
 			to: setup.github_full_repository_url,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -47,7 +49,7 @@ const pkg = require("../package.json");
 			to: setup.github_repository_url.replace("github.com", "githubusercontent.com"),
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -58,7 +60,7 @@ const pkg = require("../package.json");
 			to: setup.github_repository_url.replace("github.com", "githubusercontent.com"),
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -69,7 +71,7 @@ const pkg = require("../package.json");
 			to: setup.github_repository_url,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -80,7 +82,7 @@ const pkg = require("../package.json");
 			to: setup.github_repository_url,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -91,7 +93,7 @@ const pkg = require("../package.json");
 			to: setup.package_org !== "" ? `${setup.package_org}/${setup.package_name}` : setup.package_name,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -102,7 +104,7 @@ const pkg = require("../package.json");
 			to: setup.display_name,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -113,7 +115,7 @@ const pkg = require("../package.json");
 			to: setup.description,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -124,7 +126,7 @@ const pkg = require("../package.json");
 			to: setup.author,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -135,7 +137,7 @@ const pkg = require("../package.json");
 			to: setup.author_markdown,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -146,7 +148,7 @@ const pkg = require("../package.json");
 			to: `"projectName": "${setup.github_full_repository_url.replace("github.com/", "")}"`,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -157,7 +159,7 @@ const pkg = require("../package.json");
 			to: `"projectOwner": "${setup.github_nickname}"`,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -168,7 +170,7 @@ const pkg = require("../package.json");
 			to: setup.github_nickname,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -179,7 +181,7 @@ const pkg = require("../package.json");
 			to: setup.package_name.replace(setup.package_org),
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -190,7 +192,7 @@ const pkg = require("../package.json");
 			to: setup.email,
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 
 	try {
@@ -201,6 +203,6 @@ const pkg = require("../package.json");
 			to: "1.0.0",
 		});
 	} catch (error) {
-		console.error("Error occurred:", error);
+		logger.error(JSON.stringify(error));
 	}
 })();

scripts/version.ts

@@ -9,9 +9,12 @@
  *
  */
 import * as fs from "fs";
+import Logger from "@ptkdev/logger";
 import { argv } from "yargs";
 import pkg from "../package.json";
 
+const logger = new Logger();
+
 const version = pkg.version.split(".");
 let next_version, patch;
 
@@ -43,9 +46,9 @@ switch (argv.cmd) {
 pkg.version = next_version;
 
 if (fs.existsSync("./package.json")) {
-	fs.writeFile("./package.json", JSON.stringify(pkg), function writeJSON(err) {
-		if (err) {
-			console.log(err);
+	fs.writeFile("./package.json", JSON.stringify(pkg), function writeJSON(error) {
+		if (error) {
+			logger.error(JSON.stringify(error));
 		}
 	});
 }