feat: 增加几个语言支持

Co-authored-by: ygqygq2 <[email protected]>

README.md

@@ -62,6 +62,25 @@ Properties:
 | Insert Empty Line Before Log Message | Whether to insert an empty line before the log message or not                                                               | insertEmptyLineBeforeLogMessage | `false`        |
 | Insert Empty Line After Log Message  | Whether to insert an empty line after the log message or not                                                                | insertEmptyLineAfterLogMessage  | `false`        |
 
+## Support languages
+
+- javascript
+- typescript
+- php
+- csharp
+- c++
+- rust
+- kotlin
+- scala
+- python
+- ruby
+- perl
+- go
+- java
+- swift
+- shellscript
+- lua
+
 ## License
 
 MIT Copyright © Turbo Console Log

package.json

@@ -2,7 +2,7 @@
   "name": "turbo-print-log",
   "displayName": "Turbo Console Log for more language",
   "description": "选中变量，根据不同语言增加一行变量打印日志",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "publisher": "ygqygq2",
   "engines": {
     "vscode": "^1.85.0"
@@ -204,5 +204,8 @@
     "publisherDisplayName": "ygqygq2",
     "publisherId": "e0b1421e-635c-639a-85a0-8b271dcb3d11",
     "isPreReleaseVersion": false
+  },
+  "dependencies": {
+    "@ygqygq2/vscode-log": "^0.0.3"
   }
 }

src/commands/commentAllLogMessages.ts

@@ -1,6 +1,7 @@
+import { logger } from '@/extension';
+import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 import * as vscode from 'vscode';
 import { Command, ExtensionProperties, Message } from '../typings';
-import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 
 export function commentAllLogMessagesCommand(): Command {
   return {
@@ -41,6 +42,7 @@ export function commentAllLogMessagesCommand(): Command {
 
       // 在编辑器中添加注释
       const singleLineCommentSymbol = debugMessage.getSingleLineCommentSymbol();
+      logger.info('Comment debug log');
       editor.edit((editBuilder) => {
         logMessages.forEach(({ spaces, lines }) => {
           lines.forEach((line: vscode.Range) => {

src/commands/deleteAllLogMessages.ts

@@ -1,6 +1,7 @@
+import { logger } from '@/extension';
+import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 import * as vscode from 'vscode';
 import { Command, ExtensionProperties, Message } from '../typings';
-import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 
 // 导出一个函数，用于删除所有日志消息
 export function deleteAllLogMessagesCommand(): Command {
@@ -62,9 +63,9 @@ export function deleteAllLogMessagesCommand(): Command {
         })
         .then((success) => {
           if (success) {
-            vscode.window.showInformationMessage('TurboConsoleLog: Delete debug log successes.');
+            logger.info('Delete debug log success.');
           } else {
-            vscode.window.showErrorMessage('TurboConsoleLog: Delete debug log failed.');
+            logger.info('Delete debug log failed.');
           }
         });
     },

src/commands/displayLogMessage.ts

@@ -1,7 +1,8 @@
+import { logger } from '@/extension';
+import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 import * as vscode from 'vscode';
 import { Command, ExtensionProperties } from '../typings';
 import { getTabSize } from '../utils/getTabSize';
-import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 
 // 插入调试日志/更新调试日志行号
 export function displayLogMessageCommand(): Command {
@@ -45,6 +46,7 @@ export function displayLogMessageCommand(): Command {
         // 如果选择文本不为空
         if (selectedVar.trim().length !== 0) {
           // 使用编辑器编辑
+          logger.info('Insert debug log');
           await editor.edit((editBuilder) => {
             // 调用debugMessage.insertMessage函数
             debugMessage.insertMessage(

src/commands/uncommentAllLogMessages.ts

@@ -1,6 +1,7 @@
+import { logger } from '@/extension';
+import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 import * as vscode from 'vscode';
 import { Command, ExtensionProperties, Message } from '../typings';
-import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 
 export function uncommentAllLogMessagesCommand(): Command {
   return {
@@ -21,7 +22,9 @@ export function uncommentAllLogMessagesCommand(): Command {
       const document: vscode.TextDocument = editor.document;
 
       // 检测所有日志消息
-      const logFunctionByLanguageId = debugMessage?.getLanguageProcessor().getLogFunction(logFunction);
+      const logFunctionByLanguageId = debugMessage
+        ?.getLanguageProcessor()
+        .getLogFunction(logFunction);
       const logMessages: Message[] = debugMessage.detectAll(
         document,
         logFunctionByLanguageId,
@@ -32,6 +35,7 @@ export function uncommentAllLogMessagesCommand(): Command {
       // 遍历所有日志消息，并删除注释
       const singleLineCommentSymbol = debugMessage.getSingleLineCommentSymbol();
       const regex = new RegExp(`${singleLineCommentSymbol}`, 'g');
+      logger.info('Uncomment debug log');
       editor.edit((editBuilder) => {
         logMessages.forEach(({ spaces, lines }) => {
           lines.forEach((line: vscode.Range) => {

src/commands/updateLineNumAllLogMessages.ts

@@ -1,6 +1,7 @@
+import { logger } from '@/extension';
+import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 import * as vscode from 'vscode';
 import { Command, ExtensionProperties, Message } from '../typings';
-import { instanceDebugMessage } from '@/utils/instanceDebugMessage';
 
 export function updateLineNumAllLogMessagesCommand(): Command {
   return {
@@ -27,7 +28,9 @@ export function updateLineNumAllLogMessagesCommand(): Command {
       }
 
       // 检测所有日志消息
-      const logFunctionByLanguageId = debugMessage?.getLanguageProcessor().getLogFunction(logFunction);
+      const logFunctionByLanguageId = debugMessage
+        ?.getLanguageProcessor()
+        .getLogFunction(logFunction);
       const logMessages: Message[] = debugMessage.detectAll(
         document,
         logFunctionByLanguageId,
@@ -37,6 +40,7 @@ export function updateLineNumAllLogMessagesCommand(): Command {
 
       // 遍历所有日志消息，并更新行号
       const oldLineNum = new RegExp(`:(\\d+) ${delimiterInsideMessage}`);
+      logger.info('Update debug log line number');
       editor.edit((editBuilder) => {
         logMessages.forEach(({ spaces, lines }) => {
           lines.forEach((line: vscode.Range) => {

src/constants.ts

@@ -0,0 +1 @@
+export const CHANNEL_TITLE = 'Turbo Console Log';

src/error/CustomErrorCode.enum.ts

@@ -0,0 +1,21 @@
+import { createErrorCodeMessages, ErrorCodeMessage } from '@ygqygq2/vscode-log';
+
+export enum CustomErrorCode {
+  // 运行相关错误 (1000 - 1009)
+  RUN_ERROR = 1000,
+}
+
+const extensionPrefix = '';
+
+const execCustomErrorCodeMessage = {
+  [CustomErrorCode.RUN_ERROR]: `${extensionPrefix}Run error.`,
+};
+
+export const customErrorCodeMessages: ErrorCodeMessage = {
+  ...execCustomErrorCodeMessage,
+};
+
+export const { errorCodeEnum, errorCodeMessages } = createErrorCodeMessages(
+  CustomErrorCode,
+  customErrorCodeMessages,
+);

src/error/index.ts

@@ -0,0 +1,4 @@
+import { errorCodeEnum as ErrorCode, errorCodeMessages } from './CustomErrorCode.enum';
+
+export { CustomError } from '@ygqygq2/vscode-log';
+export { ErrorCode, errorCodeMessages };

src/extension.ts

@@ -1,6 +1,13 @@
+import { Logger } from '@ygqygq2/vscode-log';
 import * as vscode from 'vscode';
-import { Command, ExtensionProperties } from './typings';
 import { getAllCommands } from './commands/';
+import { CHANNEL_TITLE } from './constants';
+import { CustomError, errorCodeMessages } from './error';
+import { Command, ExtensionProperties } from './typings';
+
+CustomError.configure(errorCodeMessages);
+Logger.configure(vscode.window, CHANNEL_TITLE);
+export const logger = Logger.getInstance();
 
 // 导出一个函数，用于激活插件
 export function activate(): void {

src/test/suite/displayLogMessage.test.ts

@@ -12,6 +12,15 @@ import { displayLogMessageCommand } from '@/commands/displayLogMessage';
 import { ExtensionProperties } from '@/typings';
 
 vi.mock('vscode');
+vi.mock('@/extension', () => ({
+  logger: {
+    trace: vi.fn(),
+    debug: vi.fn(),
+    info: vi.fn(),
+    warn: vi.fn(),
+    error: vi.fn(),
+  },
+}));
 
 describe('displayLogMessageCommand', () => {
   let mockEditor: TextEditor | undefined;

src/test/unit/commands/commentAllLogMessages.spec.ts

@@ -1,3 +1,6 @@
+import { commentAllLogMessagesCommand } from '@/commands/commentAllLogMessages';
+import { ExtensionProperties } from '@/typings';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import {
   Position,
   Range,
@@ -7,11 +10,17 @@ import {
   TextEditorEdit,
   window,
 } from 'vscode';
-import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
-import { commentAllLogMessagesCommand } from '@/commands/commentAllLogMessages';
-import { ExtensionProperties } from '@/typings';
 
 vi.mock('vscode');
+vi.mock('@/extension', () => ({
+  logger: {
+    trace: vi.fn(),
+    debug: vi.fn(),
+    info: vi.fn(),
+    warn: vi.fn(),
+    error: vi.fn(),
+  },
+}));
 
 describe('commentAllLogMessagesCommand', () => {
   let mockEditor: TextEditor | undefined;

src/test/unit/commands/deleteAllLogMessages.spec.ts

@@ -1,3 +1,6 @@
+import { deleteAllLogMessagesCommand } from '@/commands/deleteAllLogMessages';
+import { ExtensionProperties } from '@/typings';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import {
   Position,
   Range,
@@ -7,11 +10,17 @@ import {
   TextEditorEdit,
   window,
 } from 'vscode';
-import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
-import { deleteAllLogMessagesCommand } from '@/commands/deleteAllLogMessages';
-import { ExtensionProperties } from '@/typings';
 
 vi.mock('vscode');
+vi.mock('@/extension', () => ({
+  logger: {
+    trace: vi.fn(),
+    debug: vi.fn(),
+    info: vi.fn(),
+    warn: vi.fn(),
+    error: vi.fn(),
+  },
+}));
 
 describe('deleteAllLogMessagesCommand', () => {
   let mockEditor: TextEditor | undefined;

src/test/unit/commands/displayLogMessage.spec.ts

@@ -1,3 +1,6 @@
+import { displayLogMessageCommand } from '@/commands/displayLogMessage';
+import { ExtensionProperties } from '@/typings';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import {
   Position,
   Range,
@@ -7,11 +10,17 @@ import {
   TextEditorEdit,
   window,
 } from 'vscode';
-import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
-import { displayLogMessageCommand } from '@/commands/displayLogMessage';
-import { ExtensionProperties } from '@/typings';
 
 vi.mock('vscode');
+vi.mock('@/extension', () => ({
+  logger: {
+    trace: vi.fn(),
+    debug: vi.fn(),
+    info: vi.fn(),
+    warn: vi.fn(),
+    error: vi.fn(),
+  },
+}));
 
 describe('displayLogMessageCommand', () => {
   let mockEditor: TextEditor | undefined;

src/test/unit/commands/uncommentAllLogMessages.spec.ts

@@ -1,3 +1,6 @@
+import { uncommentAllLogMessagesCommand } from '@/commands/uncommentAllLogMessages';
+import { ExtensionProperties } from '@/typings';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import {
   Position,
   Range,
@@ -7,11 +10,17 @@ import {
   TextEditorEdit,
   window,
 } from 'vscode';
-import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
-import { uncommentAllLogMessagesCommand } from '@/commands/uncommentAllLogMessages';
-import { ExtensionProperties } from '@/typings';
 
 vi.mock('vscode');
+vi.mock('@/extension', () => ({
+  logger: {
+    trace: vi.fn(),
+    debug: vi.fn(),
+    info: vi.fn(),
+    warn: vi.fn(),
+    error: vi.fn(),
+  },
+}));
 
 describe('uncommentAllLogMessagesCommand', () => {
   let mockEditor: TextEditor | undefined;

src/test/unit/commands/updateLineNumAllLogMessages.spec.ts

@@ -1,3 +1,6 @@
+import { updateLineNumAllLogMessagesCommand } from '@/commands/updateLineNumAllLogMessages';
+import { ExtensionProperties } from '@/typings';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
 import {
   Position,
   Range,
@@ -7,11 +10,17 @@ import {
   TextEditorEdit,
   window,
 } from 'vscode';
-import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
-import { updateLineNumAllLogMessagesCommand } from '@/commands/updateLineNumAllLogMessages';
-import { ExtensionProperties } from '@/typings';
 
 vi.mock('vscode');
+vi.mock('@/extension', () => ({
+  logger: {
+    trace: vi.fn(),
+    debug: vi.fn(),
+    info: vi.fn(),
+    warn: vi.fn(),
+    error: vi.fn(),
+  },
+}));
 
 describe('updateLineNumAllLogMessagesCommand', () => {
   let mockEditor: TextEditor | undefined;