Flutter插件pp_tool的介绍与使用

pp_tool介绍

每个人都会有自己的一套技术体系和工程模版，在开发下一个项目的时候希望能够快速地生成和配置好基础的项目工程。就类似于新建一个项目工程时可以选择空项目工程，也可以选择模版工程。

我们是不是也可以通过一个命令，自动生成自己的工程模版？

例如在命令终端中输入：

ptool create -f my_flutter_project
ptool create -f my_app -o ppsw

考虑扩展

ptool create -i my_ios_project
ptool create -h my_harmoney_project
ptool create -a my_android_project
ptool create -w my_web_project

构建自定义模版说明

1. 使用VSCode或其他工具创建一个空的项目，名称必须叫flutter_app，包名必须是com.example.flutter_app
2. 在flutter_app项目中加入你的代码
3. 压缩项目工程为flutter_app.zip
4. 配置到环境变量中

命令说明

mymac@PPM2-MacBook-Air Samples % pp help
arguments: [help]
pp_tool help:
  Usage:
  ptool create -f <project_name> [-o <organization_name>]
  -f <project_name>: The name of the Flutter project to create.
  -o <organization_name>: The organization name for the project. Defaults to 'example'.

  ptool -v : Show the version of the tool

• 快速使用你自定义的项目工程模版，自动创建你的Flutter项目工程

ptool create -f my_flutter_project

• 也可以指定你的组织机构

ptool create -f my_flutter_project -o ppsw

使用说明

下载激活使用

打开终端（macOS/Linux）或命令提示符（Windows），然后运行以下命令来全局安装 pp_tool：

dart pub global activate pp_tool

这将从 pub.dev 下载并安装 pp_tool，并将其添加到你的 Dart 全局工具中。返回结果：

mymac@192 ~ % dart pub global activate pp_tool
Package pp_tool is currently active at version 1.0.2.
Downloading packages... .
> pp_tool 1.0.3 (was 1.0.2)
Building package executables...
Built pp_tool:pp_tool.
Installed executable ptool.
Activated pp_tool 1.0.3.

如果命令无法正常使用，可以通过以下命令进行验证：

mymac@192 ~ % dart pub global
Missing subcommand for "dart pub global".

Usage: dart pub global [arguments...]
-h, --help    Print this usage information.

Available subcommands:
  activate     Make a package's executables globally available.
  deactivate   Remove a previously activated package.
  list         List globally activated packages.
  run          Run an executable from a globally activated package.

验证已激活的包：

mymac@192 ~ % dart pub global list
intl_utils 2.8.7
pp_tool 1.0.3

保存地址：

/Users/***/.pub-cache/bin/ptool
/Users/***/.pub-cache/bin/global_packages/pp_tool

将模板路径存放到环境变量

将模板路径存放到环境变量，确保你的自定义命令能够自动读取该路径。

在操作系统中设置环境变量：

Windows：在系统设置中，设置一个名为 FLUTTER_TEMPLATE_PATH 的环境变量，值为模板的绝对路径。

macOS/Linux：在 ~/.bashrc 或 ~/.zshrc 中添加以下行：

export FLUTTER_TEMPLATE_PATH="/Users/mymac/dev/templates/flutter_app.zip"

我添加的环境变量是：

export PATH=/Users/mymac/dev/flutter/bin:$PATH
export PATH="$PATH":"$HOME/.pub-cache/bin"
export PUB_HOSTED_URL=https://pub.flutter-io.cn
export FLUTTER_STORAGE_BASE_URL=https://storage.flutter-io.cn
export FLUTTER_TEMPLATE_PATH="/Users/mymac/dev/templates/flutter_app.zip"

如果你不在中国，可以去掉：

export PUB_HOSTED_URL=https://pub.flutter-io.cn
export FLUTTER_STORAGE_BASE_URL=https://storage.flutter-io.cn

然后运行 source ~/.bashrc 或 source ~/.zshrc，或者重新启动终端命令，以使更改生效。

source ~/.zshrc

运行命令

ptool create -f hello_app -o ppsw

查看结果

mymac@PPM2-MacBook-Air Samples % ptool create -f hello_app -o ppsw
arguments: [create, -f, hello_app, -o, ppsw]
Organization: ppsw
Project: hello_app
hello_app flutter project generating...
Template source file: /Users/mymac/dev/templates/flutter_app.zip
Target directory path: /Users/mymac/Desktop/AppDev/Flutter/Samples
Flutter project "hello_app" created successfully at /Users/mymac/Desktop/AppDev/Flutter/Samples/hello_app
Done!

完整示例Demo

1. 创建自定义模板

1. 创建一个空的 Flutter 项目，命名为 flutter_app，包名为 com.example.flutter_app
2. 在 flutter_app 中添加你需要的基础代码
3. 压缩项目为 flutter_app.zip

# 创建空项目
mkdir flutter_app
cd flutter_app
flutter create .

# 修改包名
sed -i '' 's/com.example.flutter_app/com.example.my_template/g' lib/main.dart

# 添加代码示例
echo "print('Hello from custom template!');" >> lib/main.dart

# 压缩为zip文件
zip -r flutter_app.zip .

2. 设置环境变量

在 ~/.zshrc 文件中添加：

export FLUTTER_TEMPLATE_PATH="/path/to/your/flutter_app.zip"

执行：

source ~/.zshrc

3. 使用pp_tool生成项目

ptool create -f new_project -o com.example.newproject

4. 查看生成结果

生成的项目会出现在指定目录下：

Flutter project "new_project" created successfully at /path/to/new_project