icon-to-font 1.0.0

package/utils/usage-generator.ts

@@ -0,0 +1,77 @@
+/**
+ * 使用说明生成器模块
+ * @description 生成不同项目类型的使用说明
+ */
+
+import { DirectoryStructure } from './directory-structure';
+
+/**
+ * 项目类型枚举
+ */
+export enum ProjectType {
+  /** Vue 项目 */
+  VUE = 'vue',
+  /** React 项目 */
+  REACT = 'react',
+  /** uni-app 项目 */
+  UNIAPP = 'uniapp',
+  /** 其他项目类型 */
+  OTHER = 'other'
+}
+
+/**
+ * 生成使用说明
+ * @param {ProjectType | string} projectType - 项目类型
+ * @param {DirectoryStructure} directoryStructure - 目录结构
+ * @returns {string} 使用说明文本
+ * @example
+ * ```typescript
+ * const usage = generateUsage('vue', directoryStructure);
+ * console.log(usage); // 输出 Vue 项目的使用说明
+ * ```
+ */
+export function generateUsage(
+  projectType: ProjectType | string,
+  directoryStructure: DirectoryStructure
+): string {
+  const type = projectType as ProjectType;
+  let usage = '';
+  
+  // 添加目录信息
+  if (type === ProjectType.UNIAPP || type === ProjectType.VUE) {
+    usage += `📁 组件目录: ${directoryStructure.componentDir}\n`;
+    usage += `📁 资源目录: ${directoryStructure.assetsDir}\n`;
+  } else {
+    usage += `📁 输出目录: ${directoryStructure.componentDir}\n`;
+  }
+  
+  usage += '\n📚 使用说明:\n';
+  
+  switch (type) {
+    case ProjectType.UNIAPP:
+      usage += '1. 在你的 uni-app 项目中导入生成的组件: import ItfIcon from \'@/components/ItfIcon.vue\'\n';
+      usage += '2. 使用 <ItfIcon name="icon-name" /> 来使用图标\n';
+      usage += '3. 可以通过 size 和 color 属性来自定义图标大小和颜色\n';
+      break;
+      
+    case ProjectType.VUE:
+      usage += '1. 在你的 Vue 项目中导入生成的组件: import ItfIcon from \'@/components/ItfIcon.vue\'\n';
+      usage += '2. 使用 <ItfIcon name="icon-name" /> 来使用图标\n';
+      usage += '3. 可以通过 size 和 color 属性来自定义图标大小和颜色\n';
+      break;
+      
+    case ProjectType.REACT:
+      usage += '1. 在你的 React 项目中导入生成的组件\n';
+      usage += '2. 使用 <ItfIcon name="icon-name" /> 来使用图标\n';
+      usage += '3. 可以通过 size 和 color 属性来自定义图标大小和颜色\n';
+      break;
+      
+    default:
+      usage += '1. 在你的项目中导入生成的组件\n';
+      usage += '2. 使用 <ItfIcon name="icon-name" /> 来使用图标\n';
+      usage += '3. 可以通过 size 和 color 属性来自定义图标大小和颜色\n';
+      break;
+  }
+  
+  return usage;
+}