autosnippet 1.1.12 → 1.1.14

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 高雪峰
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,36 +1,36 @@
 # AutoSnippet
 
-A iOS module management tool. Use the command line to create an Xcode Snippet, generate a JSON file, and share it with other developers in the code repository.
+一个 iOS 模块管理工具。使用命令行创建 Xcode 代码片段，生成 JSON 配置文件，并在代码仓库中与其他开发者共享。
 
-## Installation
+## 安装
 
 ```bash
 $ npm install -g autosnippet
 ```
 
-## Options
+## 命令选项
 
-Please use all the following commands in the current Xcode project file directory.
+请在当前 Xcode 项目文件目录下使用以下所有命令。
 
 ### init
 
-Execute this command in the root directory of the Xcode project to create a workspace:
+在 Xcode 项目的根目录执行此命令以创建工作空间：
 
 ```bash
 $ asd init
 ```
 
-When creating a workspace, the Snippet configuration information of the sub-workspace will be collected to the current workspace.
+创建工作空间时，会将子工作空间的 Snippet 配置信息收集到当前工作空间。
 
 ### create
 
-Command to create an Xcode Snippet, in the file directory marked with `// ACode` code:
+创建 Xcode 代码片段的命令，在标记有 `// ACode` 代码的文件目录中：
 
 ```bash
 $ asd c
 ```
 
-Code like this:
+代码示例：
 
 ```
 // ACode
@@ -40,22 +40,22 @@ UIView *view = [[UIView alloc] init];
 
 ### install
 
-Add the shared Snippet to the Xcode environment:
+将共享的代码片段添加到 Xcode 环境：
 
 ```bash
 $ asd i
 ```
 
-Use code Snippet like this:
+使用代码片段示例：
 
 ```
-// view is code key entered when creating
+// view 是创建时输入的代码键
 @view 
 ```
 
 ### share
 
-Share local Snippet:
+共享本地代码片段：
 
 ```bash
 $ asd s
@@ -63,60 +63,60 @@ $ asd s
 
 ### watch
 
-In modular projects, recognize that Snippet automatically injects dependency header files:
+在模块化项目中，识别代码片段并自动注入依赖头文件：
 
 ```bash
 $ asd w
 ```
 
-#### Append header file
+#### 追加头文件
 
-After the watch is turned on, if you want to append the header file, perform the following operations:
+开启监听后，如果想要追加头文件，请执行以下操作：
 
-1. Down arrow to select the headerVersion of Snippet
-2. Press the `Enter`
-3. `Command + S` save file
+1. 向下箭头选择代码片段的 headerVersion
+2. 按 `Enter` 键
+3. `Command + S` 保存文件
 
-Within 1 second, the header file is automatically added to the file header.
+在 1 秒内，头文件会自动添加到文件头部。
 
-#### Browser view
+#### 浏览器查看
 
-After the watch is turned on, if you want to view more information about the module in the browser, perform the following operations:
+开启监听后，如果想要在浏览器中查看模块的更多信息，请执行以下操作：
 
-1. Enter `@` and `module key`
-2. Enter `#` and `ALink`
-3. `Command + S` save file
+1. 输入 `@` 和 `模块键`
+2. 输入 `#` 和 `ALink`
+3. `Command + S` 保存文件
 
-Automatically jump to the browser to open the link configured during creation, and open the README.md file without a link.
+会自动跳转到浏览器打开创建时配置的链接，如果没有链接则打开 README.md 文件。
 
-Use ALink like this:
+使用 ALink 示例：
 
 ```
 @view#ALink
 ```
 
-## Other
+## 其他
 
-### Shortcuts for placeholders
+### 占位符快捷键
 
-You can add a placeholder in your snippets too using following tag:
+您也可以在代码片段中添加占位符，使用以下标签：
 
 ```
 <#placeholder#>
 ```
 
-E.g: the above placeholder can be written as:
+例如：上面的占位符可以写成：
 
 ```
 <#view: UIView#>
 ```
 
-Xcode detects <# and #> tokens and will make the text between them a placeholder. We can switch between multiple placeholders by pressing `Tab` key.
+Xcode 会检测 `<#` 和 `#>` 标记，并将它们之间的文本作为占位符。我们可以通过按 `Tab` 键在多个占位符之间切换。
 
-When there are multiple same placeholders, use `⌥⌘E` to select multiple placeholders continuously:
+当有多个相同的占位符时，使用 `⌥⌘E` 连续选择多个占位符：
 
-1. Select a placeholder
-2. `⌥⌘E` selects the next placeholder, `⌥⇧⌘E` selects the previous placeholder
-3. Enter the modified content, all selected placeholders will be modified
+1. 选择一个占位符
+2. `⌥⌘E` 选择下一个占位符，`⌥⇧⌘E` 选择上一个占位符
+3. 输入修改的内容，所有选中的占位符都会被修改
 
-Thanks.
+感谢使用。

package/bin/asnip.js

@@ -15,8 +15,66 @@ const watch = require('./watch.js');
 const cache = require('./cache.js');
 const share = require('./share.js');
 const init = require('./init.js');
+const config = require('./config.js');
 
-function askQuestions(specFile) {
+// 获取配置文件路径（测试模式优先使用 BiliDemo 配置）
+function getSpecFile(callback) {
+	// 测试模式下，优先使用 BiliDemo 的配置文件
+	if (config.isTestMode()) {
+		const configPath = config.getConfigPath();
+		if (configPath && fs.existsSync(configPath)) {
+			callback(configPath);
+			return;
+		}
+	}
+	
+	// 否则使用原有的查找逻辑
+	findPath.findASSpecPath(CMD_PATH, callback);
+}
+
+/**
+ * 先查找包含 // ACode 标记的文件，找到后再询问
+ */
+async function findAndAsk(specFile) {
+	console.log('正在查找包含 // ACode 标记的文件...\n');
+	
+	const filesWithACode = await create.findFilesWithACode(CMD_PATH);
+	
+	if (filesWithACode.length === 0) {
+		console.log('未找到包含 // ACode 标记的文件。');
+		console.log('请在代码中添加 // ACode 标记，例如：');
+		console.log('');
+		console.log('// ACode');
+		console.log('UIView *view = [[UIView alloc] init];');
+		console.log('// ACode');
+		console.log('');
+		return;
+	}
+	
+	// 显示找到的文件
+	console.log(`找到 ${filesWithACode.length} 个包含 // ACode 标记的文件：\n`);
+	filesWithACode.forEach((file, index) => {
+		console.log(`  ${index + 1}. ${file.name} (第 ${file.line} 行)`);
+	});
+	console.log('');
+	
+	// 如果只有一个文件，直接使用；如果有多个，让用户选择
+	let selectedFile = null;
+	if (filesWithACode.length === 1) {
+		selectedFile = filesWithACode[0].path;
+		console.log(`将使用文件: ${filesWithACode[0].name}\n`);
+	} else {
+		// 多个文件时，让用户选择（这里简化处理，使用第一个）
+		// 可以后续扩展为让用户选择
+		selectedFile = filesWithACode[0].path;
+		console.log(`将使用第一个文件: ${filesWithACode[0].name}\n`);
+	}
+	
+	// 找到标记后，开始询问
+	askQuestions(specFile, selectedFile);
+}
+
+function askQuestions(specFile, selectedFilePath) {
 	// 开始问问题
 	const questions = [{
 			type: 'input',
@@ -106,7 +164,8 @@ function askQuestions(specFile) {
 	];
 
 	inquirer.prompt(questions).then((answers) => {
-		create.createCodeSnippets(specFile, answers, null);
+		// 将选中的文件路径传递给 createCodeSnippets
+		create.createCodeSnippets(specFile, answers, null, selectedFilePath);
 	});
 }
 
@@ -127,7 +186,7 @@ commander
 	.command('i')
 	.description('add the shared Snippet to the Xcode environment')
 	.action(() => {
-		findPath.findASSpecPath(CMD_PATH, function (specFile) {
+		getSpecFile(function (specFile) {
 			install.addCodeSnippets(specFile);
 		});
 	});
@@ -136,7 +195,7 @@ commander
 	.command('s')
 	.description('share local Xcode Snippet')
 	.action(() => {
-		findPath.findASSpecPath(CMD_PATH, function (specFile) {
+		getSpecFile(function (specFile) {
 			share.shareCodeSnippets(specFile);
 		});
 	});
@@ -145,8 +204,8 @@ commander
 	.command('c')
 	.description('create an Xcode Snippet, in the file directory marked with `// ACode` code')
 	.action(() => {
-		findPath.findASSpecPath(CMD_PATH, function (specFile) {
-			askQuestions(specFile);
+		getSpecFile(function (specFile) {
+			findAndAsk(specFile);
 		});
 	});
 
@@ -154,7 +213,7 @@ commander
 	.command('u <word> [key] [value]')
 	.description('modify the `// ACode` code corresponding to `word`')
 	.action((word, key, value) => {
-		findPath.findASSpecPath(CMD_PATH, function (specFile) {
+		getSpecFile(function (specFile) {
 			create.updateCodeSnippets(specFile, word, key, value);
 		});
 	});
@@ -163,7 +222,7 @@ commander
 	.command('w')
 	.description('recognize that Snippet automatically injects dependency header files')
 	.action(() => {
-		findPath.findASSpecPath(CMD_PATH, function (specFile) {
+		getSpecFile(function (specFile) {
 			install.addCodeSnippets(specFile);
 			watch.watchFileChange(specFile);
 		});

package/bin/cache.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 
 const fs = require('fs');
+const path = require('path');
+const config = require('./config.js');
 
 const SpecCache = 'SpecCache_';
 const KeysCache = 'KeysCache_';
@@ -114,15 +116,12 @@ async function getHeadCache(specFile) {
 function getFilePathFromHolderPath(key, specFile) {
 	const pathBuff = Buffer.from(specFile, 'utf-8');
 	const fileName = key + pathBuff.toString('base64') + '.json';
-	const filePath = __dirname + '/../../AutoSnippetCache/';
+	
+	// ✅ 使用配置模块获取缓存路径
+	const cachePath = config.getCachePath();
+	const filePath = path.join(cachePath, fileName);
 
-	try {
-		fs.accessSync(filePath, fs.F_OK);
-	} catch (err) {
-		fs.mkdirSync(filePath);
-	}
-
-	return filePath + fileName;
+	return filePath;
 }
 
 exports.updateCache = updateCache;

package/bin/config.js

@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fs = require('fs');
+
+// 检测是否为测试模式
+// 通过环境变量 AUTOSNIPPET_TEST_MODE 或检测 BiliDemo 目录
+function isTestMode() {
+	// 优先检查环境变量
+	if (process.env.AUTOSNIPPET_TEST_MODE === 'true') {
+		return true;
+	}
+	
+	// 检查当前工作目录是否在 BiliDemo 项目内
+	const cwd = process.cwd();
+	if (cwd.includes('BiliDemo')) {
+		return true;
+	}
+	
+	return false;
+}
+
+// 获取 BiliDemo 项目根目录
+function getBiliDemoRoot() {
+	const cwd = process.cwd();
+	const parts = cwd.split(path.sep);
+	
+	for (let i = parts.length; i > 0; i--) {
+		const testPath = parts.slice(0, i).join(path.sep);
+		if (fs.existsSync(path.join(testPath, 'BiliDili', 'AutoSnippet.boxspec.json'))) {
+			return testPath;
+		}
+	}
+	
+	return null;
+}
+
+// 获取配置文件路径
+function getConfigPath() {
+	if (isTestMode()) {
+		const biliDemoRoot = getBiliDemoRoot();
+		if (biliDemoRoot) {
+			return path.join(biliDemoRoot, 'BiliDili', 'AutoSnippet.boxspec.json');
+		}
+	}
+	return null;
+}
+
+// 获取代码片段输出路径（测试模式写入 AutoSnippetCache，生产模式写入 Xcode）
+function getSnippetsPath() {
+	if (isTestMode()) {
+		// ✅ 测试模式：写入 AutoSnippetCache/Snippets/
+		// __dirname: AutoSnippet/bin
+		// 目标路径: AutoSnippet/AutoSnippetCache/Snippets
+		const cachePath = path.join(__dirname, '../../AutoSnippetCache/Snippets');
+		try {
+			fs.accessSync(cachePath, fs.constants.F_OK);
+		} catch (err) {
+			fs.mkdirSync(cachePath, { recursive: true });
+		}
+		return cachePath;
+	} else {
+		// 生产模式：写入 Xcode CodeSnippets 目录
+		const USER_HOME = process.env.HOME || process.env.USERPROFILE;
+		return path.join(USER_HOME, 'Library/Developer/Xcode/UserData/CodeSnippets');
+	}
+}
+
+// 获取缓存目录路径
+function getCachePath() {
+	// ✅ 缓存始终在 AutoSnippetCache 目录
+	// __dirname: AutoSnippet/bin
+	// 目标路径: AutoSnippet/AutoSnippetCache
+	const cachePath = path.join(__dirname, '../../AutoSnippetCache');
+	try {
+		fs.accessSync(cachePath, fs.constants.F_OK);
+	} catch (err) {
+		fs.mkdirSync(cachePath, { recursive: true });
+	}
+	return cachePath;
+}
+
+module.exports = {
+	isTestMode,
+	getBiliDemoRoot,
+	getConfigPath,
+	getSnippetsPath,
+	getCachePath
+};

package/bin/create.js

@@ -6,9 +6,32 @@ const readline = require('readline');
 const cache = require('./cache.js');
 const findPath = require('./findPath.js');
 const install = require('./install.js');
+// 全局常量
+const README_NAME = 'readme.md';
 // 全局路径
 const CMD_PATH = process.cwd();
 
+/**
+ * 根据文件路径确定模块名（SPM）
+ */
+function determineModuleName(filePath, packageInfo) {
+	// 从路径中提取模块名
+	// 例如：Services/Services/BDNetworkControl/Code/... -> BDNetworkControl
+	const packagePath = packageInfo.path;
+	const relativePath = path.relative(packagePath, filePath);
+	const segments = relativePath.split(path.sep);
+
+	// 查找匹配的 target
+	for (const segment of segments) {
+		if (packageInfo.targets.includes(segment)) {
+			return segment;
+		}
+	}
+
+	// 如果找不到，使用第一个 target
+	return packageInfo.targets[0] || packageInfo.name;
+}
+
 function updateCodeSnippets(specFile, word, key, value) {
 	if (key && key !== 'title' && key !== 'link' && key !== 'summary') {
 		console.log('此项属性不存在或不可修改。');
@@ -54,12 +77,61 @@ function updateCodeSnippets(specFile, word, key, value) {
 	}
 }
 
-function createCodeSnippets(specFile, answers, updateSnippet) {
+/**
+ * 查找包含 // ACode 标记的文件
+ */
+async function findFilesWithACode(filePath) {
+	const filesWithACode = [];
+	
+	try {
+		const files = await fs.promises.readdir(filePath);
+		
+		for (const filename of files) {
+			const filedir = path.join(filePath, filename);
+			try {
+				const stats = await fs.promises.lstat(filedir);
+				if (stats.isFile()) {
+					// 只检查源代码文件
+					if (filename.endsWith('.m') || filename.endsWith('.h') || filename.endsWith('.swift')) {
+						const content = await fs.promises.readFile(filedir, 'utf8');
+						const lines = content.split('\n');
+						
+						// 检查是否包含 // ACode 标记
+						for (let i = 0; i < lines.length; i++) {
+							if (lines[i].trim().toLowerCase() === '// acode') {
+								filesWithACode.push({
+									path: filedir,
+									name: filename,
+									line: i + 1
+								});
+								break; // 找到标记后跳出，每个文件只记录一次
+							}
+						}
+					}
+				}
+			} catch (err) {
+				// 忽略无法读取的文件
+				continue;
+			}
+		}
+	} catch (err) {
+		console.error('Error reading directory:', err);
+	}
+	
+	return filesWithACode;
+}
+
+function createCodeSnippets(specFile, answers, updateSnippet, selectedFilePath) {
 	let snippet = updateSnippet;
 	let isHaveHeader = snippet === null ? false : (snippet['{headName}'] !== undefined);
 
 	if (snippet === null) {
-		const answersKeys = answers.completion_first + answers.completion_more + answers.title;
+		// ✅ 处理 completion_more（可能是数组或字符串）
+		const completionMoreStr = Array.isArray(answers.completion_more) 
+			? answers.completion_more.join('') 
+			: answers.completion_more;
+		
+		const answersKeys = answers.completion_first + completionMoreStr + answers.title;
 		const answersIdBuff = Buffer.from(answersKeys, 'utf-8');
 		const identifier = 'AutoSnip_' + answersIdBuff.toString('base64').replace(/\//g, '');
 
@@ -67,7 +139,7 @@ function createCodeSnippets(specFile, answers, updateSnippet) {
 			'{identifier}': identifier,
 			'{title}': answers.title,
 			'{completionKey}': answers.completion_first,
-			'{completion}': '@' + answers.completion_first + answers.completion_more + '@Moudle',
+			'{completion}': '@' + answers.completion_first + completionMoreStr + '@Moudle',
 			'{summary}': answers.summary,
 			'{language}': 'Xcode.SourceCodeLanguage.Objective-C',
 		};
@@ -78,31 +150,39 @@ function createCodeSnippets(specFile, answers, updateSnippet) {
 		isHaveHeader = answers.header;
 	}
 
-	const filePath = CMD_PATH;
+	// ✅ 如果指定了文件路径，直接使用；否则查找当前目录下的所有文件
 	let filePathArr = [];
+	
+	if (selectedFilePath) {
+		// 使用指定的文件
+		filePathArr = [selectedFilePath];
+		readStream(specFile, filePathArr, snippet, isHaveHeader);
+	} else {
+		// 原有逻辑：查找当前目录下的所有文件
+		const filePath = CMD_PATH;
+		fs.readdir(filePath, function (err, files) {
+			if (err) {
+				console.log(err);
+				return;
+			}
 
-	fs.readdir(filePath, function (err, files) {
-		if (err) {
-			console.log(err);
-			return;
-		}
-
-		files.forEach(function (filename) {
-			const filedir = path.join(filePath, filename);
-			try {
-				// 读取路径是否为文件
-				const stats = fs.lstatSync(filedir);
-				const isFile = stats.isFile();
-				if (isFile) {
-					filePathArr.push(filedir);
+			files.forEach(function (filename) {
+				const filedir = path.join(filePath, filename);
+				try {
+					// 读取路径是否为文件
+					const stats = fs.lstatSync(filedir);
+					const isFile = stats.isFile();
+					if (isFile) {
+						filePathArr.push(filedir);
+					}
+				} catch (err) {
+					console.error(err);
 				}
-			} catch (err) {
-				console.error(err);
-			}
-        });
+			});
 
-		readStream(specFile, filePathArr, snippet, isHaveHeader);
-    });
+			readStream(specFile, filePathArr, snippet, isHaveHeader);
+		});
+	}
 }
 
 function readStream(specFile, filePathArr, snippet, isHaveHeader) {
@@ -152,24 +232,52 @@ function readStream(specFile, filePathArr, snippet, isHaveHeader) {
 				const specSlashIndex = specFile.lastIndexOf('/');
 				const specFilePath = specFile.substring(0, specSlashIndex + 1);
 
-				findPath.findBPSpacPath(thePath, function (findFilePath, specName, readme) {
-					const specPureName = specName.split('.')[0];
-
-					findPath.findSubHeaderPath(findFilePath, specPureName).then(function (headerPath) {
+				// ✅ 使用 SPM 的 Package.swift 查找（替代 .boxspec）
+				findPath.findPackageSwiftPath(thePath).then(async function (packagePath) {
+					if (!packagePath) {
+						console.log('未找到 Package.swift 文件，请检查路径。');
 						snippet['{content}'] = codeList;
-						snippet['{specName}'] = specPureName;
-						snippet['{headName}'] = fileName;
-
-						if (headerPath) {
-							snippet['{specHeadPath}'] = encodeURI(headerPath.replace(specFilePath, ''));
-						}
+						saveFromFile(specFile, snippet);
+						return;
+					}
 
-						if (readme) {
-							const readmePath = path.join(findFilePath, readme).replace(specFilePath, '');
-							snippet['{readme}'] = encodeURI(readmePath);
-						}
+					// 解析 Package.swift 获取模块信息
+					const packageInfo = await findPath.parsePackageSwift(packagePath);
+					if (!packageInfo) {
+						snippet['{content}'] = codeList;
 						saveFromFile(specFile, snippet);
-					});
+						return;
+					}
+
+					// 根据当前文件路径确定模块名
+					const moduleName = determineModuleName(filePath, packageInfo);
+					const headerName = fileName.substring(0, fileName.length - 2); // 移除 .h
+
+					// ✅ 查找头文件（适配 SPM 的 include/ModuleName/ 结构）
+					const headerPath = await findPath.findSubHeaderPath(packageInfo.path, headerName, moduleName);
+
+					snippet['{content}'] = codeList;
+					snippet['{specName}'] = moduleName;
+					snippet['{headName}'] = fileName;
+
+					if (headerPath) {
+						snippet['{specHeadPath}'] = encodeURI(headerPath.replace(specFilePath, ''));
+					}
+
+					// 查找 README.md
+					try {
+						const readmePath = path.join(packageInfo.path, README_NAME);
+						await fs.promises.access(readmePath);
+						snippet['{readme}'] = encodeURI(readmePath.replace(specFilePath, ''));
+					} catch {
+						// README.md 不存在，跳过
+					}
+
+					saveFromFile(specFile, snippet);
+				}).catch(function (err) {
+					console.error('Error finding Package.swift:', err);
+					snippet['{content}'] = codeList;
+					saveFromFile(specFile, snippet);
 				});
 			} else {
 				snippet['{content}'] = codeList;
@@ -222,7 +330,8 @@ function saveFromFile(specFile, snippet) {
 				console.log(err);
 			}
 			cache.updateCache(specFile, content);
-			install.addCodeSnippets(specFile);
+			// ✅ 只写入刚创建的代码片段，而不是所有代码片段
+			install.addCodeSnippets(specFile, snippet);
 		}
 	}
 }
@@ -258,4 +367,5 @@ function escapeString(string) {
 
 exports.createCodeSnippets = createCodeSnippets;
 exports.updateCodeSnippets = updateCodeSnippets;
-exports.saveFromFile = saveFromFile;
+exports.saveFromFile = saveFromFile;
+exports.findFilesWithACode = findFilesWithACode;