docs: update README and add tests for message directives

Author: KeJunMao

README.md

@@ -188,7 +188,7 @@ class MyClass {
 
 You instruct the compiler to generate user-defined compiler errors and warnings and informational messages.
 
-- `#error`: Generates an error.
+- `#error`: Generates an error, but does not terminate compilation.
 - `#warning`: Generates a warning.
 - `#info`: Generates an informational message.
 
@@ -197,6 +197,18 @@ You instruct the compiler to generate user-defined compiler errors and warnings
 // #warning this is a warning message
 // #info this is an info message
 ```
+
+Of course, it can also be combined with conditional compilation:
+
+```ts
+// #if DEBUG
+// #info Debug mode is on
+// #endif
+// #if !DEBUG
+// #info Debug mode is off
+// #endif
+```
+
 ## Custom directive
 
 You can used `defineDirective` to define your own directive.

README.zh-cn.md

@@ -187,7 +187,7 @@ class MyClass {
 
 可以指示编译器生成用户定义的编译器错误、警告和信息。
 
-- `#error`: 生成一条错误消息。
+- `#error`: 生成一条错误消息，但不会终止编译。
 - `#warning`: 生成一条警告消息。
 - `#info`: 生成一条信息消息。
 
@@ -197,6 +197,17 @@ class MyClass {
 // #info this is an info message
 ```
 
+当然，也可以和条件编译结合使用：
+
+```ts
+// #if DEBUG
+// #info Debug mode is on
+// #endif
+// #if !DEBUG
+// #info Debug mode is off
+// #endif
+```
+
 ## 自定义指令
 
 您可以使用 `defineDirective` 定义自己的指令。

test/message.test.ts

@@ -0,0 +1,68 @@
+import { describe, expect, it, vi } from 'vitest'
+import { Context, ifDirective, MessageDirective } from '../src'
+
+describe('message', () => {
+  it('should log error message', () => {
+    const context = new Context({
+      // @ts-expect-error ignore
+      directives: [MessageDirective],
+    })
+
+    const loggerErrorSpy = vi.spyOn(context.logger, 'error')
+    const code = '// #error This is an error message'
+
+    context.transform(code, 'test.js')
+
+    expect(loggerErrorSpy).toHaveBeenCalledWith('This is an error message', { timestamp: true })
+  })
+
+  it('should log warning message', () => {
+    const context = new Context({
+      // @ts-expect-error ignore
+      directives: [MessageDirective],
+    })
+
+    const loggerWarnSpy = vi.spyOn(context.logger, 'warn')
+    const code = '// #warning This is a warning message'
+
+    context.transform(code, 'test.js')
+
+    expect(loggerWarnSpy).toHaveBeenCalledWith('This is a warning message', { timestamp: true })
+  })
+
+  it('should log info message', () => {
+    const context = new Context({
+      // @ts-expect-error ignore
+      directives: [MessageDirective],
+    })
+
+    const loggerInfoSpy = vi.spyOn(context.logger, 'info')
+    const code = '// #info This is an info message'
+
+    context.transform(code, 'test.js')
+
+    expect(loggerInfoSpy).toHaveBeenCalledWith('This is an info message', { timestamp: true })
+  })
+
+  it('with if directive', () => {
+    const context = new Context({
+      // @ts-expect-error ignore
+      directives: [ifDirective, MessageDirective],
+    })
+    context.env.DEV = true
+
+    const loggerInfoSpy = vi.spyOn(context.logger, 'info')
+    const code = `
+        // #if DEV
+        // #info DEV mode is on
+        // #endif
+
+        // #if !DEV
+        // #info DEV mode is off
+        // #endif
+        `
+
+    context.transform(code, 'test.js')
+    expect(loggerInfoSpy).toHaveBeenCalledWith('DEV mode is on', { timestamp: true })
+  })
+})