整理项目结构；确认需要实现的转换

GPT.md

@@ -1,3 +1,15 @@
+docs: 
+
+右键二级菜单
+https://fishpi.cn/article/1630641187509
+https://code.visualstudio.com/api/references/contribution-points#contributes.menus
+https://code.visualstudio.com/api/references/contribution-points#contributes.submenus
+
+>extension.toCamelCase
+>Transform to
+
+=====
+
 请帮我用js写一个小驼峰，大驼峰，下划线写法互相转换的VSCode插件。实现按shift+alt+t自动在这几种模式下切换。我完全没有写过VSCode插件，所以你可能需要详细告诉我每一步该怎么做，谢谢你
 
 当然可以帮助您！创建一个VSCode插件涉及几个步骤，包括设置项目结构、编写代码以及打包和发布插件。以下是创建您所需插件的基本步骤：

package.json

@@ -9,27 +9,64 @@
   "categories": [
     "Other"
   ],
-  "activationEvents": [
-    "onCommand:extension.convertCase"
-  ],
   "main": "./out/extension.js",
   "contributes": {
     "commands": [
+      {
+        "command": "extension.convertCase",
+        "title": "字符串转换"
+      },
       {
         "command": "extension.toCamelCase",
-        "title": "转小驼峰 To Camel Case"
+        "title": "小驼峰 / 驼峰命名 (Camel Case) [ fooBar ]"
       },
       {
         "command": "extension.toPascalCase",
-        "title": "转大驼峰 To Pascal Case"
+        "title": "大驼峰 / 帕斯卡命名 (Pascal Case) [ FooBar ]"
+      },
+      {
+        "command": "extension.toKebabCase",
+        "title": "连字符 / 脊柱式命名 (Kebab Case / Spinal Case) [ foo-bar ]"
+      },
+      {
+        "command": "extension.toSnakeCase",
+        "title": "下划线 / 蛇形命名 (Snake Case) [ foo_bar ]"
+      },
+      {
+        "command": "extension.toSnakeUpperCase",
+        "title": "下划线大写 (Snake Upper Case) [ FOO_BAR ]"
       },
       {
         "command": "extension.toUpperCase",
-        "title": "转大写 To Upper Case"
+        "title": "全大写 (Upper Case) [ FOOBAR ]"
       },
       {
         "command": "extension.toLowerCase",
-        "title": "转小写 To Lower Case"
+        "title": "全小写 (Lower Case) [ foobar ]"
+      },
+      {
+        "command": "editor.action.transformToCamelcase",
+        "title": "[VSCode 自带] 驼峰式大小写 (Camel Case) [ fooBar ]"
+      },
+      {
+        "command": "editor.action.transformToKebabcase",
+        "title": "[VSCode 自带] Kebab 命名 (Kebab Case) [ foo-bar ]"
+      },
+      {
+        "command": "editor.action.transformToTitlecase",
+        "title": "[VSCode 自带] 词首字母大写 (Title Case) [ Foo Bar ]"
+      },
+      {
+        "command": "editor.action.transformToLowercase",
+        "title": "[VSCode 自带] 转换为小写 (Lower Case) [ foo bar ]"
+      },
+      {
+        "command": "editor.action.transformToUppercase",
+        "title": "[VSCode 自带] 转换为大写 (Upper Case) [ FOO BAR ]"
+      },
+      {
+        "command": "editor.action.transformToSnakecase",
+        "title": "[VSCode 自带] 转换为蛇形命名法 (Snake Case) [ foo_bar ]"
       }
     ],
     "keybindings": [
@@ -43,22 +80,63 @@
       "editor/context": [
         {
           "when": "editorTextFocus",
-          "submenu": "extension.stringConversion"
-        }
-      ],
-      "submenus": [
-        {
-          "id": "extension.stringConversion",
-          "when": "editorTextFocus",
-          "command": "extension.toCamelCase",
-          "label": "字符串转换"
+          "command": "extension.convertCase",
+          "group": "1_modification@9"
         },
         {
-          "when": "editorTextFocus",
-          "command": "extension.toPascalCase"
+          "submenu": "extension.stringConversionMenu",
+          "group": "1_modification@9"
+        }
+      ],
+      "extension.stringConversionMenu": [
+        {
+          "command": "extension.toCamelCase",
+          "group": "group-extension"
+        },
+        {
+          "command": "extension.toPascalCase",
+          "group": "group-extension"
+        },
+        {
+          "command": "extension.toUpperCase",
+          "group": "group-extension"
+        },
+        {
+          "command": "extension.toLowerCase",
+          "group": "group-extension"
+        },
+        {
+          "command": "editor.action.transformToCamelcase",
+          "group": "group-vscode"
+        },
+        {
+          "command": "editor.action.transformToKebabcase",
+          "group": "group-vscode"
+        },
+        {
+          "command": "editor.action.transformToTitlecase",
+          "group": "group-vscode"
+        },
+        {
+          "command": "editor.action.transformToLowercase",
+          "group": "group-vscode"
+        },
+        {
+          "command": "editor.action.transformToUppercase",
+          "group": "group-vscode"
+        },
+        {
+          "command": "editor.action.transformToSnakecase",
+          "group": "group-vscode"
         }
       ]
-    }
+    },
+    "submenus": [
+      {
+        "id": "extension.stringConversionMenu",
+        "label": "将字符串转换为..."
+      }
+    ]
   },
   "scripts": {
     "vscode:prepublish": "npm run compile",
@@ -69,14 +147,14 @@
     "test": "vscode-test"
   },
   "devDependencies": {
-    "@types/vscode": "^1.87.0",
     "@types/mocha": "^10.0.6",
     "@types/node": "18.x",
+    "@types/vscode": "^1.87.0",
     "@typescript-eslint/eslint-plugin": "^7.4.0",
     "@typescript-eslint/parser": "^7.4.0",
-    "eslint": "^8.57.0",
-    "typescript": "^5.3.3",
     "@vscode/test-cli": "^0.0.8",
-    "@vscode/test-electron": "^2.3.9"
+    "@vscode/test-electron": "^2.3.9",
+    "eslint": "^8.57.0",
+    "typescript": "^5.3.3"
   }
 }

src/extension.ts

@@ -1,7 +1,9 @@
 // The module 'vscode' contains the VS Code extensibility API
 // Import the module and reference it with the alias vscode in your code below
 import * as vscode from 'vscode';
-import * as TextConversion from './text-conversion';
+import * as TextConversion from './main-code/text-conversion';
+
+type ConvertFunction = (selectionText: string) => string | undefined;
 
 // This method is called when your extension is activated
 // Your extension is activated the very first time the command is executed
@@ -20,51 +22,57 @@ export function activate(context: vscode.ExtensionContext) {
 	// 	vscode.window.showInformationMessage('Hello World from text-conversion!');
 	// });
 
-	const handleEditorReplace = (convertFunction: (selectionText: string) => string) => {
+	const handleEditorReplace = (convertFunction: ConvertFunction) => {
 		// 获取当前编辑器
 		let editor = vscode.window.activeTextEditor;
-		if (editor) {
-			let document = editor.document;
-			let selection = editor.selection;
-
-			// 获取选中的文本
-			let text = document.getText(selection);
-			// 转换文本
-			let converted = convertFunction(text);
-
-			// 当转换后文本与转换前相同时，跳过转换
-			if (text === converted) {
-				console.log('selection text is same to converted text, skip replace contents.');
-				return;
-			}
-
-			// 替换文本
-			console.log('replace selection text', text, 'to', converted);
-			editor.edit(editBuilder => {
-				editBuilder.replace(selection, converted);
-			});
+		if (!editor) {
+			return;
 		}
+		
+		console.log('============ start convert ============');
+		let document = editor.document;
+		let selection = editor.selection;
+
+		// 获取选中的文本
+		let text = document.getText(selection);
+
+		// 转换文本
+		const converted = convertFunction(text);
+		console.log('converted', converted);
+
+		// 无法转换时，跳过转换
+		if (converted === undefined) {
+			console.log('converted text is undefined, skip replace contents.');
+			return;
+		}
+
+		// 当转换后文本与转换前相同时，跳过转换
+		if (converted === text) {
+			console.log('selection text is same to converted text, skip replace contents.');
+			return;
+		}
+
+		// 替换文本
+		console.log('replace selection text', text, 'to', converted);
+		editor.edit(editBuilder => {
+			editBuilder.replace(selection, converted);
+		});
+		console.log('============ finish convert ============');
 	};
 
-	let disposableCamelCase = vscode.commands.registerCommand('extension.toCamelCase', () => {
-		handleEditorReplace(TextConversion.toCamelCase);
-	});
-	context.subscriptions.push(disposableCamelCase);
+	const commands: Array<{ command: string; convertFunction: ConvertFunction }> = [
+		{ command: 'extension.toCamelCase', convertFunction: TextConversion.toCamelCase },
+		{ command: 'extension.toPascalCase', convertFunction: TextConversion.toPascalCase },
+		{ command: 'extension.toUpperCase', convertFunction: TextConversion.toUpperCase },
+		{ command: 'extension.toLowerCase', convertFunction: TextConversion.toLowerCase },
+	];
 
-	let disposablePascalCase = vscode.commands.registerCommand('extension.toPascalCase', () => {
-		handleEditorReplace(TextConversion.toPascalCase);
-	});
-	context.subscriptions.push(disposablePascalCase);
-
-	let disposableUpperCase = vscode.commands.registerCommand('extension.toUpperCase', () => {
-		handleEditorReplace(TextConversion.toUpperCase);
-	});
-	context.subscriptions.push(disposableUpperCase);
-
-	let disposableLowerCase = vscode.commands.registerCommand('extension.toLowerCase', () => {
-		handleEditorReplace(TextConversion.toLowerCase);
-	});
-	context.subscriptions.push(disposableLowerCase);
+	for (const { command, convertFunction } of commands) {
+		let disposable = vscode.commands.registerCommand(command, () => {
+			handleEditorReplace(convertFunction);
+		});
+		context.subscriptions.push(disposable);
+	}
 
 }
 

src/main-code/text-conversion.ts

@@ -3,6 +3,7 @@
  * 
  * @param {string} str user selection
  * @returns 
+ * @since 2024-03-28
  */
 export function toCamelCase(str: string): string {
     return str.replace(/_([a-z])/g, (g) => g[1].toUpperCase());
@@ -13,6 +14,7 @@ export function toCamelCase(str: string): string {
  * 
  * @param {string} str user selection
  * @returns 
+ * @since 2024-03-28
  */
 export function toPascalCase(str: string): string {
     return str.replace(/(^\w|_\w)/g, (g) => g.toUpperCase().replace('_', ''));
@@ -23,6 +25,7 @@ export function toPascalCase(str: string): string {
  * 
  * @param {string} str user selection
  * @returns 
+ * @since 2024-03-28
  */
 export function toUpperCase(str: string): string {
     return str.toUpperCase();
@@ -33,6 +36,7 @@ export function toUpperCase(str: string): string {
  * 
  * @param {string} str user selection
  * @returns 
+ * @since 2024-03-28
  */
 export function toLowerCase(str: string): string {
     return str.toLowerCase();

src/main-code/text-split.ts

@@ -0,0 +1,89 @@
+
+const handlerList = [];
+/**
+ * 小驼峰处理中间件
+ * 
+ * @param str 
+ * @since 2024-03-29
+ */
+const camelCaseHandler = (str: string) => {
+    // 是否是小驼峰
+    const regexp = /^$/g; // need done
+    // if()
+};
+handlerList.push(camelCaseHandler);
+
+/**
+ * 小驼峰处理中间件
+ * 
+ * @param str 
+ * @since 2024-03-29
+ */
+const pascalCaseHandler = (str: string) => {
+    // 是否是小驼峰
+    const regexp = /^$/g; // need done
+};
+handlerList.push(pascalCaseHandler);
+
+type SplitFailResult = {
+    success: false
+    errMsg: string
+};
+
+type SplitSuccessResult = {
+    success: true
+    result: Array<string>
+};
+
+type SplitResult = SplitFailResult | SplitSuccessResult;
+
+/**
+ * 分词
+ * 
+ * @param str 
+ * @since 2024-03-29
+ */
+export function splitWord(str: string): SplitResult {
+    // check parameter type
+    if (typeof str !== 'string') {
+        return { success: false, errMsg: `str is not string, type: ${typeof str}` };
+    }
+
+    // check parameter length
+    if (str.length === 0) {
+        return { success: false, errMsg: 'str is empty string.' };
+    }
+    else if (str.length > 64) {
+        return { success: false, errMsg: 'str is too long, it does not appear to be an acceptable input.' };
+    }
+
+    // check whether the input matches the criteria
+    // 是否包含空格
+    const isContainSpace = str.indexOf(' ') !== -1;
+    // 是否包含连字符
+    const isContainHyphen = str.indexOf('-') !== -1;
+    // 是否包含下划线
+    const isContainUnderline = str.indexOf('_') !== -1;
+    // 是否包含除空格外的其他连字符 (检查字符串是否包含 - 或 _ ，并且不包含空格)
+    const isContainSeparator =  /^[^\s]*[-_]+[^\s]*$/.test(str);
+
+    // 是否是小驼峰命名法
+    const isCamelCase = /^[a-z][a-zA-Z]*$/;
+    // 是否是大驼峰命名法
+    const isPascalCase = /^[A-Z][a-zA-Z]*$/;
+    // 是否包含大写字母
+    const isContainUpperCaseLetter = /[A-Z]/.test(str);
+    // 是否包含小写字母
+    const isContainLowerCaseLetter = /[a-z]/.test(str);
+    // 是否包含字母
+    const isContainLetter = /[a-zA-Z]/.test(str);
+
+    return { success: true, result: [] };
+}
+
+const result = splitWord('hello world');
+if (result.success) {
+    console.log('success!', result.result);
+} else {
+    console.log('skip!', result.errMsg);
+}

src/test/extension.test.ts

@@ -5,36 +5,6 @@ import * as assert from 'assert';
 import * as vscode from 'vscode';
 // import * as myExtension from '../../extension';
 
-enum TextFormat {
-	/** 独立单词 */
-	SINGLE_WORD,
-	/** 小驼峰 */
-	CAMEL_CASE,
-	/** 大驼峰 */
-	PASCAL_CASE,
-	/** 大写 */
-	UPPER_CASE,
-	/** 小写 */
-	LOWER_CASE,
-}
-
-interface TestCase {
-	input: string
-	inputType: TextFormat | Array<TextFormat>
-	output: {
-		camelCase: string
-	}
-}
-const testCase: Array<TestCase> = [
-	{
-		input: '',
-		inputType: [],
-		output: {
-			camelCase: '',
-		}
-	},
-];
-
 suite('Extension Test Suite', () => {
 	vscode.window.showInformationMessage('Start all tests.');
 

src/test/test-case.ts

@@ -0,0 +1,128 @@
+
+
+enum SkipReason {
+    /** 空字符串 */
+    EMPTY_STRING,
+    /** 字符串过长 */
+    STRING_TOO_LONG,
+    /** 不包含英文字母 */
+    NOT_CONTAIN_LETTERS,
+}
+
+type TestSkipCase = {
+    /** 当 input 不是规范的输入时，isSkip 为 true */
+    isSkip: true
+    skipReason: SkipReason
+};
+type TestReplaceCase = {
+    isSkip: false
+    splitResult: Array<string>
+    output: {
+        camelCase: string
+        pascalCase: string
+    }
+};
+type TestCase = (TestSkipCase | TestReplaceCase) & {
+    input: string | Array<string>
+};
+
+/*
+Have a nice day!
+foo--bar
+foo -bar
+pineApple
+*/
+const testCase: Array<TestCase> = [
+    {
+        input:
+            ''
+        ,
+        isSkip: true,
+        skipReason: SkipReason.EMPTY_STRING
+    },
+    {
+        input:
+            `China's factory activity expanded in March after five consecutive months of contraction, an official survey revealed on Sunday, adding to a run of indicators that suggest the stabilization of the world's second-largest economy.`
+        ,
+        isSkip: true,
+        skipReason: SkipReason.STRING_TOO_LONG
+    },
+    {
+        input:
+            `今天是星期日`
+        ,
+        isSkip: true,
+        skipReason: SkipReason.NOT_CONTAIN_LETTERS
+    },
+    {
+        input: [
+            'test case',
+            'test_case',
+            'test-case',
+            'testCase',
+            'TestCase',
+            'TEST_CASE',
+        ],
+        isSkip: false,
+        splitResult: [
+            ''
+        ],
+        output: {
+            camelCase: 'testCase',
+            pascalCase: 'TestCase',
+        }
+    },
+    {
+        input: [
+            ' A nice day! ',
+            ' a_nice_day! ',
+            ' ANiceDay! ',
+            ' A_NICE_DAY! ',
+            ' A_Nice_DaY ',
+            ' A-NiCe_Day ',
+            ' A----NiCe_Day_-_-- ',
+        ],
+        isSkip: false,
+        splitResult: [
+            ''
+        ],
+        output: {
+            camelCase: ' aNiceDay! ',
+            pascalCase: ' ANiceDay! ',
+        }
+    },
+    {
+        input: [
+            ' A niCe-Day-',
+            ' A niceDay',
+        ],
+        isSkip: false,
+        splitResult: [
+            ''
+        ],
+        output: {
+            camelCase: ' a niceDay',
+            pascalCase: ' A NiceDay',
+        }
+    },
+    {
+        input: [
+            'Have a nice day!',
+            'have a nice day!',
+            'Have-a-nice-day!',
+            'have-a-nice-day!',
+            'HAVE-A-NICE-DAY!',
+            'Have_a_nice_day!',
+            'have_a_nice_day!',
+            'HAVE_A_NICE_DAY!',
+            'HaveANiceDay!',
+            'haveANiceDay!',
+        ],
+        isSkip: false,
+        splitResult: ['have', 'a', 'nice', 'day', '!'],
+        output: {
+            camelCase: ' a niceDay',
+            pascalCase: ' A NiceDay',
+        }
+    },
+];

src/type-definition/support-case.ts

@@ -0,0 +1,72 @@
+export enum SupportCase {
+    /**
+     * 小驼峰 / 驼峰命名
+     * Camel Case
+     * e.g. fooBar
+     * 
+     * @alias: camelCase / CamelCase / camel_case / CAMEL_CASE
+     * @since 2024-04-02
+     */
+    CAMEL_CASE,
+
+    /**
+     * 大驼峰 / 帕斯卡命名
+     * Pascal Case
+     * e.g. FooBar
+     * 
+     * @alias: pascalCase / PascalCase / pascal_case / PASCAL_CASE
+     * @since 2024-04-02
+     */
+    PASCAL_CASE,
+
+    /**
+     * 连字符 / 脊柱式命名
+     * Kebab Case / Spinal Case
+     * e.g. foo-bar
+     * 
+     * @alias: kebabCase / KebabCase / kebab_case / KEBAB_CASE
+     *         spinalCase / SpinalCase / spinal_case / SPINAL_CASE
+     * @since 2024-04-02
+     */
+    KEBAB_CASE,
+
+    /**
+     * 下划线 / 蛇形命名
+     * Snake Case
+     * e.g. foo_bar
+     * 
+     * @alias: snakeCase / SnakeCase / snake_case / SNAKE_CASE
+     * @since 2024-04-02
+     */
+    SNAKE_CASE,
+
+    /**
+     * 下划线大写
+     * Snake Upper Case
+     * e.g. FOO_BAR
+     * 
+     * @alias: snakeUpperCase / SnakeUpperCase / snake_upper_case / SNAKE_UPPER_CASE
+     * @since 2024-04-02
+     */
+    SNAKE_UPPER_CASE,
+
+    /**
+     * 全大写
+     * Upper Case
+     * e.g. FOO_BAR / FOOBAR
+     * 
+     * @alias: upperCase / UpperCase / upper_case / UPPER_CASE
+     * @since 2024-04-02
+     */
+    UPPER_CASE,
+
+    /**
+     * 全小写
+     * Lower Case
+     * e.g. foo_bar / foobar
+     * 
+     * @alias: lowerCase / LowerCase / lower_case / LOWER_CASE
+     * @since 2024-04-02
+     */
+    LOWER_CASE,
+}

test-code.md

@@ -13,4 +13,6 @@ const HELLO_WORLD = ''
 const helloworld = ''
 // 大写
 const HELLOWORLD = ''
+// 加空格
+const a = 'hello world'
 ```