[Release] v1.0.20210830

ptkdev · ptkdev · commit 4faf55c78db1 · 2021-08-31T00:44:55.000+02:00
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -49,13 +49,6 @@ module.exports = {
 				"beforeColon": false
 			}
 		],
-		"indent": [
-			"error",
-			"tab",
-			{
-				"SwitchCase": 1
-			}
-		],
 		"quotes": [
 			"error",
 			"double",
diff --git a/.gitignore b/.gitignore
@@ -123,5 +123,6 @@ npm-debug.log
 #######
 /app/configs/config.js
 /app/configs/config.ts
+/app/configs/config.json
 /dist
 /build
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,4 @@
+/dist
+/build
+/node_modules
+package-lock.json
diff --git a/.prettierrc b/.prettierrc
@@ -1,6 +1,6 @@
 {
 	"bracketSpacing": true,
-	"printWidth": 160,
+	"printWidth": 120,
 	"semi": true,
 	"singleQuote": false,
 	"tabWidth": 4,
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -6,10 +6,10 @@
 	},
 	"eslint.format.enable": true,
 	"[javascript]": {
-		"editor.defaultFormatter": "dbaeumer.vscode-eslint"
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
 	},
 	"[typescript]": {
-		"editor.defaultFormatter": "vscode.typescript-language-features"
+		"editor.defaultFormatter": "esbenp.prettier-vscode"
 	},
 	"[scss]": {
 		"editor.defaultFormatter": "esbenp.prettier-vscode"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,20 @@
-# v1.0.20210412 (April 12, 2021)
+# v1.0.20210830 (April 12, 2021)
 
--   Fix: minor fix
--   Fix: readme of issues
+-   Security: update
+-   Fix: translations
+-   Fix: Typescript, strict mode enabled
 
 <!-- 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 -->
 
+# v1.0.20210412 (April 12, 2021)
+
+-   Fix: minor fix
+-   Fix: readme of issues
+
 # v1.0.20210404 (April 04, 2021)
 
 -   Feature: Setup
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 <!-- all-shields/header-badges:START -->
 
-[![v1.0.20210412](https://img.shields.io/badge/version-v1.0.20210412-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)
+[![v1.0.20210830](https://img.shields.io/badge/version-v1.0.20210830-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 -->
 
diff --git a/app/configs/config.js.tpl b/app/configs/config.js.tpl
diff --git a/app/configs/config.json.tpl b/app/configs/config.json.tpl
@@ -0,0 +1,17 @@
+{
+	"server": { "port": 5000 },
+	"debug": true,
+	"language": "en",
+	"logger": {
+		"path": { "debug_log": "./logs/debug.log", "error_log": "./logs/errors.log" },
+		"language": "en",
+		"colors": "enabled",
+		"debug": "enabled",
+		"info": "enabled",
+		"warning": "enabled",
+		"error": "enabled",
+		"sponsor": "enabled",
+		"write": "enabled",
+		"type": "log"
+	}
+}
diff --git a/app/functions/module.ts b/app/functions/module.ts
@@ -43,7 +43,7 @@ const m = async ({ text }: ModuleInterface): Promise<ModuleResponseInterface> =>
 	const app = () => text;
 
 	return {
-		app
+		app,
 	};
 };
 
diff --git a/app/functions/run.ts b/app/functions/run.ts
@@ -10,11 +10,12 @@
  *
  */
 import m from "@app/functions/module";
-import configs from "@configs/config";
-
+import configs from "@configs/config.json";
+import translate from "@translations/translate.js";
+import logger from "@app/utils/logger";
 (async () => {
-	const { app } = await m({ text: "hello-world" });
+	const { app } = await m({ text: translate("hello", { name: "Boilerplate" }) });
 
-	console.log(app());
-	console.log(`debug: ${configs.debug}`);
+	logger.info(app());
+	logger.debug(configs.debug ? "true" : "false");
 })();
diff --git a/app/routes/translations.ts b/app/routes/translations.ts
@@ -11,4 +11,10 @@
 import en from "@translations/en.json";
 import it from "@translations/it.json";
 
-export default { en, it };
+const translations: any = {
+	en,
+	it,
+};
+
+export { it, en };
+export default translations;
diff --git a/app/translations/en.json b/app/translations/en.json
@@ -5,5 +5,5 @@
 		"contributors": ["Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptk.dev)"]
 	},
 	"app_name": "node-module-boilerplate",
-	"hello": "Hello World!"
+	"hello": "Hello ##name##!"
 }
diff --git a/app/translations/it.json b/app/translations/it.json
@@ -5,5 +5,5 @@
 		"contributors": ["Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptk.dev)"]
 	},
 	"app_name": "node-module-boilerplate",
-	"hello": "Ciao Mondo!"
+	"hello": "Ciao ##name##!"
 }
diff --git a/app/translations/translate.ts b/app/translations/translate.ts
@@ -0,0 +1,77 @@
+/**
+ * Translate
+ * =====================
+ *
+ * @contributors: Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptk.dev)
+ *
+ * @license: MIT License
+ *
+ */
+import config from "@configs/config.json";
+import translations from "@app/routes/translations";
+
+interface TranslateParamsInterface {
+	name?: string;
+}
+
+/**
+ * Replace Params
+ * =====================
+ * If translation text is: hi ##name## how are you?
+ * This function replace ##name## token with correct value
+ *
+ * @param {string} text - text of current phrase to translate (mandatory)
+ * @param {Object} language_params - object with token to replace, example: {name:"alex"} (mandatory)
+ *
+ * @return {string} text - text with replaced token
+ *
+ */
+const replaceParams = (text: string, language_params: TranslateParamsInterface): string => {
+	for (const [key, value] of Object.entries(language_params)) {
+		text = text.replace(`##${key}##`, value);
+	}
+
+	return text;
+};
+
+/**
+ * Check
+ * =====================
+ * Check if exist translation in selected language, if not exist get string of phrase from "en" translation
+ *
+ * @param {string} language_id - key of translation phrase from /translations/*.json (mandatory)
+ *
+ * @return {string} text - text of available translation
+ *
+ */
+const check = (language_id: string): string => {
+	if (translations && translations[config.language] && translations[config.language][language_id]) {
+		return translations[config.language][language_id];
+	}
+
+	return translations["en"][language_id] || "";
+};
+
+/**
+ * Translate
+ * =====================
+ * Get correct translation
+ *
+ * @param {string} language_id - key of translation phrase from /translations/*.json (mandatory)
+ * @param {Object} language_params - object with token to replace, example: {name:"alex"} (optional)
+ *
+ * @return {string} text - text of available translation
+ *
+ */
+const translate = (language_id: string, language_params?: TranslateParamsInterface): string => {
+	let text = "";
+	text = check(language_id);
+	if (language_params) {
+		text = replaceParams(text, language_params);
+	}
+
+	return text;
+};
+
+export { translate };
+export default translate;
diff --git a/app/types/module.type.ts b/app/types/module.type.ts
@@ -26,7 +26,7 @@ export interface ModuleInterface {
 	 * @param { String } text - input text
 	 *
 	 */
-	text: string
+	text: string;
 }
 
 /**
@@ -40,10 +40,10 @@ export interface ModuleResponseInterface {
 	 * =====================
 	 * Get text
 	 *
-	  * @interface [ModuleResponseInterface](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/app/types/module.type.ts)
+	 * @interface [ModuleResponseInterface](https://github.com/ptkdev-boilerplate/node-module-boilerplate/blob/main/app/types/module.type.ts)
 	 *
 	 * @return {fn} string - run app() for output text
 	 *
 	 */
-	app(): string
+	app(): string;
 }
diff --git a/app/utils/logger.ts b/app/utils/logger.ts
@@ -0,0 +1,18 @@
+/**
+ * Logger
+ * =====================
+ * The best alternative to the console.log statement
+ *
+ * @contributors: Patryk Rzucidło [@ptkdev] <support@ptkdev.io> (https://ptk.dev)
+ *
+ * @license: MIT License
+ *
+ */
+import Logger, { LoggerOptions } from "@ptkdev/logger";
+import config from "@configs/config.json";
+
+const options: LoggerOptions = config.logger as unknown as LoggerOptions; // typescript issue https://github.com/microsoft/TypeScript/issues/26552#issuecomment-484124880
+const logger = new Logger(options);
+
+export { logger };
+export default logger;
diff --git a/jest.config.js b/jest.config.js
@@ -3,8 +3,8 @@ module.exports = {
 	testEnvironment: "node",
 	globals: {
 		"ts-jest": {
-			"tsconfig": "tsconfig.json",
-			"compiler": "ttypescript"
-		}
+			tsconfig: "tsconfig.json",
+			compiler: "ttypescript",
+		},
 	},
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/scripts/configs.ts b/scripts/configs.ts
diff --git a/scripts/debug.ts b/scripts/debug.ts
diff --git a/tsconfig.json b/tsconfig.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +/dist
 +/build
 +/node_modules
 +package-lock.json
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"bracketSpacing": true,`
`3`		`- "printWidth": 160,`
	`3`	`+ "printWidth": 120,`
`4`	`4`	`"semi": true,`
`5`	`5`	`"singleQuote": false,`
`6`	`6`	`"tabWidth": 4,`