@itleanchatbot/shared-models-js-postgres 1.0.0

package/README.md

@@ -0,0 +1,86 @@
+# Logger #
+
+O pacote da Itlean para logs é uma abstração para a geração de logs de sistema, como console e file log.
+
+## External dependencies ##
+
+Usamos o log4js para gerar os logs dentro da camada abstrata
+<https://www.npmjs.com/package/log4js>
+
+## Methods usages ##
+
+~~~javascript
+    // pass - LOGGER_LEVEL, LOGGER_TYPE, LOGGER_FILE
+    const logger = Factory.getLogger('debug', 'console', '')
+~~~
+
+* Debug
+
+~~~javascript
+    logger.debug('example debug', [ { param: 'debug' } ])
+    /*
+        Result
+
+        [2020-09-18T15:59:00.293] [DEBUG] default - example debug [ { param: 'debug' } ]
+    */
+~~~
+
+* Info
+
+~~~javascript
+    logger.info('example info', [ { param: 'info' } ])
+    /*
+        Result
+
+        [2020-09-18T15:59:00.306] [INFO] default - example info [ { param: 'info' } ]
+    */
+~~~
+
+* Warn
+
+~~~javascript
+    logger.warning('example warning', [ { param: 'warning' } ])
+    /*
+        Result
+
+        [2020-09-18T15:59:00.307] [WARN] default - example warning [ { param: 'warning' } ]
+    */
+~~~
+
+* Error
+
+~~~javascript
+    logger.error('example error', [ { param: 'error' } ])
+    /*
+        Result
+
+        [2020-09-18T15:59:00.307] [ERROR] default - example error [ { param: 'error' } ]
+    */
+~~~
+
+* Exception
+
+~~~javascript
+    logger.exception(new Error('example exception'))
+    /*
+        Result
+
+        [2020-09-18T15:59:00.308] [ERROR] default - example exception Error: test to exception
+          at Object.it (D:\dev\itlean\packages\logger\test\logger.test.ts:56:19)
+          at Object.asyncJestTest (D:\dev\itlean\packages\logger\node_modules\jest-jasmine2\build\jasmineAsyncInstall.js:106:37)
+          at resolve (D:\dev\itlean\packages\logger\node_modules\jest-jasmine2\build\queueRunner.js:45:12)
+          at new Promise (<anonymous>)
+          at mapper (D:\dev\itlean\packages\logger\node_modules\jest-jasmine2\build\queueRunner.js:28:19)
+          at promise.then (D:\dev\itlean\packages\logger\node_modules\jest-jasmine2\build\queueRunner.js:75:41)
+          at process._tickCallback (internal/process/next_tick.js:68:7)
+    */
+
+   // usages
+
+   try {
+       const db = new Connection() // throw if fail connection
+   }
+   catch(e) {
+       logger.exception(e)
+   }
+~~~

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@itleanchatbot/shared-models-js-postgres",
+  "version": "1.0.0",
+  "description": "Shared Models JS Postgres",
+  "main": "index.js",
+  "license": "ISC",
+  "author": "Wilber da Silva <wilber.costa@itlean.com>",
+  "scripts": {
+    "lint": "npx eslint \"{src,apps,libs,test}/**/*.js\" --fix",
+    "format": "npm run format:src",
+    "format:src": "npx prettier --write \"src/**/*.js\""
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
+      "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true"
+    }
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^11.0.0",
+    "@commitlint/config-conventional": "^11.0.0",
+    "commitizen": "^4.2.2",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^7.15.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^7.0.0",
+    "eslint-config-standard": "^16.0.2",
+    "eslint-plugin-prettier": "^3.3.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "husky": "^4.3.6",
+    "jest": "^26.6.3",
+    "prettier": "^2.2.1"
+  },
+  "dependencies": {}
+}