Merge branch 'release/0.1.0' into develop

Author: devsheva

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [unreleased]
+## [0.1.0] - 2024-09-03
 
 ### 🚀 Features
 
@@ -11,6 +11,11 @@ All notable changes to this project will be documented in this file.
 - *(logger)* Add base class with logger property
 - *(logger)* Add name and level property
 - *(logger)* Add log method for all levels
+- Add changelog with git-cliff
+
+### 🐛 Bug Fixes
+
+- [**breaking**] Remove base class since it was causing runtime error
 
 ### 🚜 Refactor
 
@@ -19,6 +24,7 @@ All notable changes to this project will be documented in this file.
 ### 📚 Documentation
 
 - Use shields.io for badges
+- Add instructions on how to temporary type a property added by a decorator
 
 ### 🧪 Testing
 

README.md

@@ -4,3 +4,19 @@
 ![Codecov](https://img.shields.io/codecov/c/github/devsheva/simplelog)
 
 A simple logger decorator amplify like
+
+## Important
+
+**Experimental decorators** are used for this package implementation and since experimental it has some bugs like unsafe typing.
+TypeScript compiler complains when it finds out a property used inside a class that calls a decorator cause it cannot infer it, so as a temporary workaround simply declare an interface
+
+```ts
+interface Example {logger: any}
+
+@Logger()
+class Example {
+   hello() {
+    this.logger.debug() // THIS IS VALID
+   }
+}
+```

spec/base.spec.ts

@@ -1,5 +1,5 @@
 import { describe, expect, expectTypeOf, it, vi } from 'vitest'
-import Base from '../src/base.js'
+
 import {
   getLogLevel,
   loggerDecorator,
@@ -9,19 +9,28 @@ import {
 
 describe('logger', () => {
   it('has a logger property', () => {
-    class Test extends Base {}
+    interface Test {
+      logger: any
+    }
+    class Test {}
     loggerDecorator()(Test)
 
     expect(Test.prototype).toHaveProperty('logger')
   })
 
   it('overrides name if not provided', () => {
-    class Test extends Base {}
+    interface Test {
+      logger: any
+    }
+    class Test {}
     loggerDecorator()(Test)
   })
 
   it('sets name if provided', () => {
-    class Test extends Base {}
+    interface Test {
+      logger: any
+    }
+    class Test {}
     loggerDecorator('test')(Test)
     const instance = new Test()
     expect(instance.logger).toHaveProperty('name', 'test')
@@ -30,14 +39,20 @@ describe('logger', () => {
   describe('options', () => {
     describe('level', () => {
       it('defaults to info', () => {
-        class Test extends Base {}
+        interface Test {
+          logger: any
+        }
+        class Test {}
         loggerDecorator()(Test)
         const instance = new Test()
         expect(instance.logger).toHaveProperty('level', 'info')
       })
 
       it('can be overridden', () => {
-        class Test extends Base {}
+        interface Test {
+          logger: any
+        }
+        class Test {}
         loggerDecorator('', { level: 'debug' })(Test)
         const instance = new Test()
         expect(instance.logger).toHaveProperty('level', 'debug')
@@ -49,7 +64,10 @@ describe('logger', () => {
     it.each(['verbose', 'debug', 'info', 'warn', 'error'])(
       `has a %s method`,
       (level) => {
-        class Test extends Base {}
+        interface Test {
+          logger: any
+        }
+        class Test {}
         loggerDecorator()(Test)
         const instance = new Test()
         expect(instance.logger).toHaveProperty(level)
@@ -58,7 +76,10 @@ describe('logger', () => {
     )
 
     it('should log a message at the specified level', () => {
-      class Test extends Base {
+      interface Test {
+        logger: any
+      }
+      class Test {
         hello() {
           this.logger.debug('hello')
         }
@@ -72,7 +93,10 @@ describe('logger', () => {
     })
 
     it('should not log a message at a lower level', () => {
-      class Test extends Base {
+      interface Test {
+        logger: any
+      }
+      class Test {
         hello() {
           this.logger.debug('hello')
         }