初始化项目

Min 提供内置的组件库项目脚手架模板,帮助用户快速创建一个新的小程序组件库项目

  1. $ min init [name]

初始化步骤

请将 Min 指令运行在你最熟悉的 命令行终端 工具上

  • 进入准备创建新项目的工作目录下
  1. $ cd YOUR_CURRNT_WORK_DIR/
  • 输入指令和新的项目名称,your_weapp_project 是项目名称
  1. $ min init your_weapp_project
  • 此时进入初始化项目的命令行交互式问答,开发者请按照命令行上的交互式问题来完成具体操作

    • 请设置项目目录
  1. YOUR_CURRNT_WORK_DIR/your_weapp_project # 请确认或更换其他目录
  • 请选择项目类型,此时请选择 新建组件库
  1. - 新建小程序
  2. - 新建组件库
  • 是否继续高级设置
  1. - y 进入自定义配置流程
  2. - n 跳过流程并使用默认配置
  • 完成以上步骤,Min 将创建并生成组件库项目到 YOUR_CURRNT_WORK_DIR/your_weapp_project 目录下

  • 此时,Min 会提示创建一个新的组件,开始进入新建组件的选项界面,开发者请按照命令行上的交互式问题来完成具体操作

    • 请设置新组件的英文名称
  1. toast # toast 为演示名称,开发者请输入实际的组件英文名称
  • 请设置新组件的中文标题
  1. 提示 # 提示 为演示标题,开发者请输入实际的组件中文标题
  • 完成以上步骤,Min 工具将进入自动化生成构建阶段

    • 创建并生成 组件package 到 YOUR_CURRNT_WORK_DIR/your_weapp_project/packages/wxc-toast 目录下
    • 创建并生成组件示例页面 到 YOUR_CURRNT_WORK_DIR/your_weapp_project/pages/toast 目录下
    • 自动安装 NPM 包依赖
    • 自动编译 src 源码到 dist 目录下
    • 提示初始化完成
  • 此时新的小程序项目已创建完成:请在 "微信开发者工具" 中新建一个小程序项目,项目目录指向新建工程里的 dist/ 文件夹

目录结构

以下是 Min 设计的目录结构,用户可以通过以上流程初始化一个新的 Min组件库项目,也可以通过 Min组件库示例 快速入门

  1. ├── dist 微信开发者工具指定的目录(该目录由 Min dev 指令自动编译生成,请不要直接修改该目录下的文件)
  2. ├── node_modules
  3. ├── packages 代码编写的目录(该目录为使用 Min 后的开发目录,用于管理各个 组件package 的主目录)
  4. | ├── wxc-toast 组件的 package 目录
  5. | | ├── src
  6. | | | ├── index.wxc 组件的源码编写文件(组件入口文件必须为index.wxc
  7. | | ├── package.json 组件的 package 配置
  8. | | └── README.md 组件的 README 文档
  9. ├── src 代码编写的目录(该目录为使用 Min 后的开发目录)
  10. | ├── pages Min 页面目录(属于完整页面)
  11. | | ├── toast toast 组件示例示例 目录
  12. | | | ├── demos 组件示例编写目录(该目录为组件示例代码,每个示例代表一个组件的使用场景介绍)
  13. | | | | ├── demo-default.wxc 默认示例
  14. | | | | └── demo-other.wxc 其他示例
  15. | | | └── index.wxp index 页面(该页面用于承载组件的 Demo 示例、API 文档 changelog 日志)
  16. | └── app.wxa 小程序配置项(全局数据、样式等;经build后,会在dist目录下生成app.jsapp.jsonapp.wxss文件)
  17. ├── min.config.json Min 配置文件
  18. └── package.json 项目的package配置