@ttoss/logger 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 0.1.1 (2023-04-25)
+
+### Bug Fixes
+
+- public access logger package ([#298](https://github.com/ttoss/ttoss/issues/298)) ([79ce406](https://github.com/ttoss/ttoss/commit/79ce406631943687a9814f2b8f23adbe79aab206))

package/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 ttoss.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @ttoss/logger
+
+Simple environment agnostic logger.
+
+## Motivation
+
+Often, for debugging some piece of code, developers use console.log for it. When the application goes for production, some of these logs still appears, most because they forget to clear these logs.
+These package solves this, providing some levels of log that are emitted based on the environment of the application.
+
+## Log Levels vs Environments
+
+<table>
+<thead>
+<tr><th>Log Level</th><th>Environment</th></tr>
+</thead>
+<tbody>
+<tr><td>Warn</td><td>Dev-only</td></tr>
+<tr><td>Error</td><td>All</td></tr>
+<tr><td>Info</td><td>Dev-only</td></tr>
+</tbody>
+</table>
+
+## How to use
+
+Just instantiate the logger, provide a context name and start to use:
+
+```ts
+import { Logger } from '@ttoss/logger';
+
+const logger = Logger('createContext');
+
+logger.warn('This will emit an warn on console');
+
+logger.error('This will emit a log of type error on console');
+
+loggger.info('This will emit a simple log on console');
+```

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@ttoss/logger",
+  "version": "0.1.1",
+  "description": "Simple environment agnostic logger",
+  "license": "MIT",
+  "contributors": [
+    "Eron Alves <eron.alves@rocketmail.com>"
+  ],
+  "main": "index.js",
+  "devDependencies": {
+    "@ttoss/config": "^1.29.5"
+  },
+  "keywords": [],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "13f3d2b990be54d050adfe8d05d10cf16d127177"
+}

package/src/index.ts

@@ -0,0 +1,24 @@
+const { log, warn, error } = console;
+const isDev: boolean =
+  (import.meta as any)?.env?.DEV || (process.env as any)?.DEV === 'true';
+
+export const Logger = (prefix: string) => {
+  return {
+    warn: (value: string) => {
+      if (isDev) {
+        const now = new Date();
+        warn(`[${now}] - ${prefix} - ${value}`);
+      }
+    },
+    info: (value: string) => {
+      if (isDev) {
+        const now = new Date();
+        log(`[${now}] - ${prefix} - ${value}`);
+      }
+    },
+    error: (value: string) => {
+      const now = new Date();
+      error(`[${now}] - ${prefix} - ${value}`);
+    },
+  };
+};

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@ttoss/config/tsconfig.json",
+  // supports `import.meta`
+  "compilerOptions": {
+    "module": "es2020"
+  }
+}