autosnippet 1.1.23 → 1.2.1

package/README.md

@@ -12,16 +12,24 @@ $ npm install -g autosnippet
 
 请在当前 Xcode 项目文件目录下使用以下所有命令。
 
-### init
+### root
 
 在 Xcode 项目的根目录执行此命令以创建工作空间：
 
 ```bash
-$ asd init
+$ asd root
 ```
 
 创建工作空间时，会将子工作空间的 Snippet 配置信息收集到当前工作空间。
 
+### init
+
+在 Xcode 项目的spm模块目录执行此命令以创建模块工作空间：
+
+```bash
+$ asd init
+```
+
 ### create
 
 创建 Xcode 代码片段的命令，在标记有 `// ACode` 代码的文件目录中：
@@ -117,6 +125,4 @@ Xcode 会检测 `<#` 和 `#>` 标记，并将它们之间的文本作为占位
 
 1. 选择一个占位符
 2. `⌥⌘E` 选择下一个占位符，`⌥⇧⌘E` 选择上一个占位符
-3. 输入修改的内容，所有选中的占位符都会被修改
-
-感谢使用。
+3. 输入修改的内容，所有选中的占位符都会被修改

package/bin/asnip.js

@@ -181,13 +181,33 @@ commander
 		// ✅ 使用异步版本查找配置文件
 		const specFile = await findPath.findASSpecPathAsync(CMD_PATH);
 		if (!specFile) {
-			console.error('未找到 AutoSnippet.boxspec.json 配置文件');
+			console.error('❌ 安装失败：未找到 AutoSnippet.boxspec.json 配置文件');
+			console.error('请先执行 asd init 初始化工作空间');
 			return;
 		}
 		// ✅ 先聚合子模块配置到主配置文件
 		await init.mergeSubSpecs(specFile);
 		// 然后安装 snippets
-		install.addCodeSnippets(specFile);
+		const result = install.addCodeSnippets(specFile);
+		
+		if (result && result.success) {
+			if (result.count) {
+				console.log(`✅ 安装成功：已安装 ${result.count} 个代码片段`);
+			} else if (result.successCount !== undefined) {
+				const total = result.total || 0;
+				const success = result.successCount || 0;
+				const error = result.errorCount || 0;
+				if (error === 0) {
+					console.log(`✅ 安装成功：已安装 ${success} 个代码片段`);
+				} else {
+					console.log(`⚠️  安装完成：成功 ${success} 个，失败 ${error} 个，共 ${total} 个`);
+				}
+			} else {
+				console.log('✅ 安装成功');
+			}
+		} else {
+			console.error('❌ 安装失败：', result?.error || '未知错误');
+		}
 	});
 
 commander

package/bin/create.js

@@ -507,6 +507,8 @@ function removeAcodeMark(filePath, positionList) {
 }
 
 function escapeString(string) {
+	// 必须先转义 &，否则会把 < 转成 <
+	string = string.replace(/&/g, '&');
 	string = string.replace(/</g, '&lt;');
 	string = string.replace(/>/g, '&gt;');
 	return string;

package/bin/install.js

@@ -74,13 +74,18 @@ function writeSingleSnippet(snippet, template) {
 					let turnValue = '';
 
 					for (var index = 0; index < value.length; index++) {
+						// ✅ 对代码内容进行特殊字符转义
+						const escapedLine = escapeString(value[index]);
 						if (index === 0) {
-							turnValue += value[index] + '\n';
+							turnValue += escapedLine + '\n';
 						} else {
-							turnValue += '\t' + value[index] + '\n';
+							turnValue += '\t' + escapedLine + '\n';
 						}
 					}
 					value = turnValue;
+				} else {
+					// ✅ 对非数组值也进行转义（如 summary）
+					value = escapeString(value);
 				}
 				tempVal = '\t<string>' + value + '</string>\n';
 			}
@@ -118,8 +123,8 @@ function addCodeSnippets(specFile, singleSnippet) {
 			template = JSON.parse(data);
 		}
 	} catch (err) {
-		console.error(err);
-		return;
+		console.error('安装失败：无法读取模板文件', err.message);
+		return { success: false, error: err.message };
 	}
 
 	// ✅ 如果指定了单个代码片段，只处理这个片段
@@ -134,7 +139,7 @@ function addCodeSnippets(specFile, singleSnippet) {
 		} catch (err) {
 			console.error(err);
 		}
-		return;
+		return { success: true, count: 1 };
 	}
 
 	// 原有逻辑：处理所有代码片段（用于 install 命令）
@@ -146,8 +151,8 @@ function addCodeSnippets(specFile, singleSnippet) {
 			cache.updateCache(specFile, data);
 		}
 	} catch (err) {
-		console.error(err);
-		return;
+		console.error('安装失败：无法读取配置文件', err.message);
+		return { success: false, error: err.message };
 	}
 
 	// 拼装配置文件
@@ -155,6 +160,8 @@ function addCodeSnippets(specFile, singleSnippet) {
 		let content = '';
 		let identifier = '';
 		let holderArr = [];
+		let successCount = 0;
+		let errorCount = 0;
 
 		placeholder.list.forEach(function (placeVal) {
 			holderArr.push(placeVal);
@@ -209,13 +216,18 @@ function addCodeSnippets(specFile, singleSnippet) {
 						let turnValue = '';
 
 						for (var index = 0; index < value.length; index++) {
+							// ✅ 对代码内容进行特殊字符转义
+							const escapedLine = escapeString(value[index]);
 							if (index === 0) {
-								turnValue += value[index] + '\n';
+								turnValue += escapedLine + '\n';
 							} else {
-								turnValue += '\t' + value[index] + '\n';
+								turnValue += '\t' + escapedLine + '\n';
 							}
 						}
 						value = turnValue;
+					} else {
+						// ✅ 对非数组值也进行转义（如 summary）
+						value = escapeString(value);
 					}
 					tempVal = '\t<string>' + value + '</string>\n';
 				}
@@ -235,15 +247,23 @@ function addCodeSnippets(specFile, singleSnippet) {
 				try {
 					const snippetFile = path.join(snippetsPath, identifier + '.codesnippet');
 					fs.writeFileSync(snippetFile, content);
+					successCount++;
 				} catch (err) {
-					console.log(err);
+					console.error(`安装片段失败 [${identifier}]:`, err.message);
+					errorCount++;
 				}
 			}
 		});
+
+		return { success: true, successCount, errorCount, total: holderArr.length };
 	}
+
+	return { success: false, error: '配置文件格式错误' };
 }
 
 function escapeString(string) {
+	// 必须先转义 &，否则会把 &lt; 转成 &amp;lt;
+	string = string.replace(/&/g, '&amp;');
 	string = string.replace(/</g, '&lt;');
 	string = string.replace(/>/g, '&gt;');
 	return string;

package/bin/watch.js

@@ -1,11 +1,10 @@
 #!/usr/bin/env node
 
-const fs = require('fs');
+const chokidar = require('chokidar');
 const path = require('path');
 const open = require('open');
 const injection = require('./injection.js');
 
-// 全局路径
 const CMD_PATH = process.cwd();
 const cache = require('./cache.js');
 
@@ -14,94 +13,151 @@ const alinkMark = 'alink';
 const wellMark = '#';
 const atMark = '@';
 
-// ✅ 更新正则以匹配包含相对路径的新格式：// ahead <Module/Header.h> relative/path/to/Header.h
 const headerReg = /^\/\/ ahead <\w+\/\w+.h>(\s+.+)?$/;
 const headerSwiftReg = /^\/\/ ahead \w+$/;
 const importReg = /^\#import\s*<\w+\/\w+.h>$/;
 const importSwiftReg = /^import\s*\w+$/;
 
+const debounceTimers = new Map();
+const DEBOUNCE_DELAY = 300;
+
 let timeoutLink = null;
 let timeoutHead = null;
 
 function watchFileChange(specFile, watchRootPath) {
-	// ✅ 如果指定了监听根目录，使用它；否则使用当前工作目录
 	const filePath = watchRootPath || CMD_PATH;
-	console.log(`[watchFileChange] 监听目录: ${filePath}`);
-	console.log(`[watchFileChange] 配置文件: ${specFile}`);
-	let isReading = false;
-
-	fs.watch(filePath, {recursive: true}, (event, filename) => {
-		if (filename) {
-			setTimeout(() => {
-				if (!watchFileFilter(filePath, filename)) {
-					return;
-				}
-				if (isReading) {
+	
+	const ignored = [
+		'**/node_modules/**',
+		'**/.git/**',
+		'**/.mgit/**',
+		'**/.easybox/**',
+		'**/xcuserdata/**',
+		'**/.build/**',
+		'**/*.swp',
+		'**/*.tmp',
+		'**/*~.m',
+		'**/*~.h',
+	];
+	
+	const filePattern = ['**/*.m', '**/*.h', '**/*.swift'];
+	
+	console.log(`✅ 文件监听已启动: ${filePath}`);
+	
+	const watcher = chokidar.watch(filePattern, {
+		cwd: filePath,
+		ignored: ignored,
+		ignoreInitial: true,
+		persistent: true,
+		awaitWriteFinish: {
+			stabilityThreshold: 300,
+			pollInterval: 100
+		}
+	});
+
+	watcher.on('change', (relativePath) => {
+		const fullPath = path.join(filePath, relativePath);
+		handleFileChange(specFile, fullPath, relativePath);
+	});
+
+	watcher.on('add', (relativePath) => {
+		const fullPath = path.join(filePath, relativePath);
+		handleFileChange(specFile, fullPath, relativePath);
+	});
+
+	watcher.on('error', (error) => {
+		console.error('文件监听错误:', error.message);
+	});
+
+	watcher.on('ready', () => {
+		console.log('文件监听器已就绪，等待文件变更...');
+	});
+
+	return watcher;
+}
+
+function handleFileChange(specFile, fullPath, relativePath) {
+	const existingTimer = debounceTimers.get(fullPath);
+	if (existingTimer) {
+		clearTimeout(existingTimer);
+	}
+
+	const timer = setTimeout(() => {
+		debounceTimers.delete(fullPath);
+		processFileChange(specFile, fullPath, relativePath);
+	}, DEBOUNCE_DELAY);
+
+	debounceTimers.set(fullPath, timer);
+}
+
+function processFileChange(specFile, updateFile, relativePath) {
+	const fs = require('fs');
+	
+	fs.access(updateFile, fs.constants.F_OK, (err) => {
+		if (err) {
+			return;
+		}
+
+		fs.stat(updateFile, (statErr, stats) => {
+			if (statErr || stats.isDirectory()) {
+				return;
+			}
+
+			fs.readFile(updateFile, 'utf8', (readErr, data) => {
+				if (readErr) {
 					return;
 				}
-				isReading = true;
-
-				let updateFile = path.join(filePath, filename);
-				fs.readFile(updateFile, 'utf8', (err, data) => {
-					isReading = false;
-					if (err) {
-						console.error(err);
-						return;
-					}
 
-					const isSwift = filename.endsWith('.swift');
-					const currImportReg = isSwift ? importSwiftReg : importReg;
-					const currHeaderReg = isSwift ? headerSwiftReg : headerReg;
-
-					let importArray = [];
-					let headerLine = null;
-					let alinkLine = null;
-
-					const lineArray = data.split('\n');
-					lineArray.forEach(element => {
-						const lineVal = element.trim();
-
-						if (currImportReg.test(lineVal)) {
-							importArray.push(lineVal);
-						}
-						if (lineVal.startsWith(headerMark)) {
-							headerLine = lineVal;
-							console.log('headerLine: ' + headerLine);
-						}
-						if (lineVal.startsWith(atMark) && lineVal.endsWith(wellMark + alinkMark)) {
-							alinkLine = lineVal;
-							console.log('alinkLine: ' + alinkLine);
-						}
-					});
-
-					if (alinkLine) {
-
-						clearTimeout(timeoutLink);
-						timeoutLink = setTimeout(() => {
-							openLink(specFile, alinkLine);
-						}, 300);
-					}
+				const filename = path.basename(updateFile);
+				const isSwift = filename.endsWith('.swift');
+				const currImportReg = isSwift ? importSwiftReg : importReg;
+				const currHeaderReg = isSwift ? headerSwiftReg : headerReg;
+
+				let importArray = [];
+				let headerLine = null;
+				let alinkLine = null;
 
-					if (headerLine && currHeaderReg.test(headerLine)) {
+				const lineArray = data.split('\n');
+				lineArray.forEach(element => {
+					const lineVal = element.trim();
 
-						clearTimeout(timeoutHead);
-						timeoutHead = setTimeout(() => {
-							checkAnotherFile(specFile, updateFile, headerLine, importArray, isSwift);
-						}, 300);
+					if (currImportReg.test(lineVal)) {
+						importArray.push(lineVal);
+					}
+					if (lineVal.startsWith(headerMark)) {
+						headerLine = lineVal;
+					}
+					if (lineVal.startsWith(atMark) && lineVal.endsWith(wellMark + alinkMark)) {
+						alinkLine = lineVal;
 					}
 				});
-			}, 1000);
-		}
+
+				if (alinkLine) {
+					clearTimeout(timeoutLink);
+					timeoutLink = setTimeout(() => {
+						openLink(specFile, alinkLine);
+					}, DEBOUNCE_DELAY);
+				}
+
+				if (headerLine && currHeaderReg.test(headerLine)) {
+					clearTimeout(timeoutHead);
+					timeoutHead = setTimeout(() => {
+						checkAnotherFile(specFile, updateFile, headerLine, importArray, isSwift);
+					}, DEBOUNCE_DELAY);
+				}
+			});
+		});
 	});
 }
 
 function checkAnotherFile(specFile, updateFile, headerLine, importArray, isSwift) {
+	const fs = require('fs');
+	
 	if (isSwift || updateFile.endsWith('.h')) {
 		injection.handleHeaderLine(specFile, updateFile, headerLine, importArray, isSwift);
 		return;
 	}
 
-	// 识别.h文件的引入头文件
 	const dotIndex = updateFile.lastIndexOf('.');
 	const mainPathFile = updateFile.substring(0, dotIndex) + '.h';
 
@@ -119,7 +175,6 @@ function checkAnotherFile(specFile, updateFile, headerLine, importArray, isSwift
 			const lineArray = data.split('\n');
 			lineArray.forEach(element => {
 				const lineVal = element.trim();
-
 				if (importReg.test(lineVal)) {
 					importArray.push(lineVal);
 				}
@@ -155,24 +210,4 @@ function openLink(specFile, inputWord) {
 	}
 }
 
-function watchFileFilter(filePath, filename) {
-	let updateFile = path.join(filePath, filename);
-	if (updateFile.includes('xcuserdata')
-		|| updateFile.includes('.git')
-		|| updateFile.includes('.mgit')
-		|| updateFile.includes('.easybox')) {
-		return false;
-	}
-	if (filename.endsWith('~.m')
-		|| filename.endsWith('~.h')) {
-		return false;
-	}
-	if (!filename.endsWith('.m')
-		&& !filename.endsWith('.h')
-		&& !filename.endsWith('.swift')) {
-		return false;
-	}
-	return true;
-}
-
 exports.watchFileChange = watchFileChange;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "autosnippet",
-    "version": "1.1.23",
+    "version": "1.2.1",
     "description": "A iOS module management tool.",
     "main": "index.js",
     "scripts": {
@@ -22,6 +22,7 @@
         "url": "git+https://github.com/GxFn/AutoSnippet.git"
     },
     "dependencies": {
+        "chokidar": "^3.6.0",
         "commander": "^7.2.0",
         "inquirer": "^8.0.0",
         "minimist": "^1.2.5",