Merge pull request #7 from formidablejs/release/0.1.1

Release/0.1.1

Author: donaldp

.github/workflows/tests.yml

@@ -3,12 +3,23 @@ name: Tests
 on: push
 
 jobs:
-  build:
-
+  linux:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
+    - name: Install modules
+      run: npm install
+    - name: Build lib
+      run: npm run build
+    - name: Run tests
+      run: npm test
+
+  windows:
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v4
     - name: Install modules
       run: npm install
     - name: Build lib

.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /lib
+/storage
 /test/e2e
 .env
 .env.backup

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@formidablejs/logger",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "main": "lib/index.js",
   "description": "The Formidable Logger is a Monolog-inspired logging library",
   "author": "Donald Pakkies",
@@ -23,20 +23,20 @@
     "@formidablejs/framework": "*"
   },
   "devDependencies": {
-    "@formidablejs/framework": "0.13.11",
-    "@types/jest": "^29.2.4",
+    "@formidablejs/framework": "0.23.8",
+    "@types/jest": "^29.5.5",
     "imba": "2.0.0-alpha.215",
-    "jest": "^29.3.1",
-    "ts-jest": "^29.0.3"
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.1"
   },
   "dependencies": {
     "@livy/console-formatter": "^1.0.3",
     "@livy/console-handler": "^1.0.3",
-    "@livy/contracts": "^1.1.1",
-    "@livy/file-handler": "^1.0.3",
-    "@livy/group-handler": "^1.0.3",
-    "@livy/line-formatter": "^1.0.3",
-    "@livy/logger": "^1.0.5",
+    "@livy/contracts": "^1.1.2",
+    "@livy/file-handler": "^1.0.4",
+    "@livy/group-handler": "^1.0.4",
+    "@livy/line-formatter": "^1.0.4",
+    "@livy/logger": "^1.0.6",
     "@livy/rotating-file-handler": "^1.0.4",
     "@livy/slack-webhook-handler": "^1.0.3",
     "got": "^12.5.3"

package.json

@@ -1,11 +1,24 @@
+import { existsSync, mkdirSync } from 'fs'
+import { dirname, join } from 'path'
 import { FileHandler } from '@livy/file-handler'
 import { LineFormatter } from '@livy/line-formatter'
 import { Driver } from '../Driver'
 
 export class SingleDriver < Driver
 
+	get path
+		let path\string = self.options.path ?? join(process.cwd!, 'storage', 'logs', 'formidable.log')
+
+		if (process.platform !== 'win32' && path.slice(0, 1) !== '/') || (process.platform === 'win32' && path.slice(1, 2) !== ':')
+			path = join(process.cwd!, path)
+
+		if !existsSync dirname(path)
+			try mkdirSync dirname(path), { recursive: true }
+
+		path
+
 	def handler
-		new FileHandler(self.options.path ?? 'storage/logs/formidable.log', {
+		new FileHandler(path, {
 			formatter: new LineFormatter({
 				include: {
 					datetime: true,

src/Drivers/SingleDriver.imba

@@ -21,6 +21,10 @@ export class Config extends ConfigRepository {
                         driver: 'console',
                         level: 'debug'
                     },
+                    file: {
+                        driver: 'single',
+                        level: 'debug',
+                    }
                 }
             }
         }

tests/app/config.ts

@@ -1,4 +1,7 @@
+
 import './app'
+import { existsSync, readFileSync, rmSync } from 'fs'
+import { join } from 'path'
 import { Log } from '../lib'
 
 describe('integration test', () => {
@@ -93,4 +96,20 @@ describe('integration test', () => {
             Log.channel('random-channel')
         }).toThrowError('Logging config is missing')
     })
+
+    it('Log to file', () => {
+        const random = Math.random().toString(36)
+
+        Log.channel('file').info(random)
+
+        const file = join(process.cwd(), 'storage', 'logs', 'formidable.log')
+
+        expect(existsSync(file)).toBeTruthy()
+
+        expect(readFileSync(file, 'utf-8')).toContain(random)
+
+        if (process.platform !== 'win32') {
+            rmSync(process.cwd() + '/storage', { recursive: true, force: true })
+        }
+    })
 })

tests/log.test.ts

@@ -1,12 +1,8 @@
-// auto-generated
+import { HandlerInterface } from "@livy/contracts/lib/handler-interface";
 
-export class Driver {
-    constructor(options?: {});
-    _options: {};
-    get options(): {};
-    /**
-    @returns { HandlerInterface }
-    */
+export class Driver<T = {}> {
+    _options: T;
+    constructor(options?: T);
+    get options(): T;
     handler(): HandlerInterface;
 }
-import { HandlerInterface } from "@livy/contracts/lib/handler-interface";

types/Driver.d.ts

@@ -1,7 +1,7 @@
-// auto-generated
+import { Driver } from "../Driver";
+import { FileHandler } from "@livy/file-handler";
 
 export class SingleDriver extends Driver {
+    get path(): string;
     handler(): FileHandler;
 }
-import { Driver } from "../Driver";
-import { FileHandler } from "@livy/file-handler";