fa-addons-utils
v1.1.3
Published
该开源代码库是一个 FastAdmin 插件研发工具，旨在提供以下功能，使插件代码库能够完全独立交给 Git 管理，并能够一键同步插件到目标服务器。
Downloads
25
Readme
FastAdmin 插件研发工具
该开源代码库是一个 FastAdmin 插件研发工具，旨在提供以下功能，使插件代码库能够完全独立交给 Git 管理，并能够一键同步插件到目标服务器。
功能特点
- 通过
fa preview命令将指定的插件代码同步到 FastAdmin，并自动禁用旧插件，更新新插件。支持实时同步功能 (-w参数)。 - 通过
fa publish命令，读取配置好的 SSH 服务器信息，连接成功后，自动推送代码到目标服务器的 FastAdmin。
安装
npm install -g fa-addons-utils使用方法
1. 开发模式，自动同步插件到本地FastAdmin
使用以下命令将指定的插件代码同步到 FastAdmin，并更新插件：
fa preview [-w]参数说明：
[-w]：可选参数，实时同步功能。启用该参数后，插件代码将实时同步到 FastAdmin。
该命令会将插件代码同步到 FastAdmin 的插件目录，并自动禁用旧插件，更新新插件。
2. 推送代码到目标服务器
使用以下命令将代码推送到目标服务器的 FastAdmin：
fa publish该命令会读取事先配置好的 SSH 服务器信息，并连接到目标服务器。连接成功后，自动将代码推送到目标服务器的 FastAdmin。
3. 配置文件 fa init
在使用 fa publish 命令之前，需要配置 SSH 服务器信息。执行fa init，则系统会自动在项目根目录下创建一个名为 fa.config.json 的文件，内容如下：
{
"name": "goview",
"version": "1.0",
"addons_src": "./addons",
"ssh": {
"host": "",
"port": "22",
"username": "root",
"password": "",
"privatePath": ""
},
"dev_fastadmin_path": "本地fastadmin的根目录",
"publish_fastadmin_path": "服务器fastadmin的根目录"
}4. 其他
- 创建demo
fa create --name Demo1- 查看帮助
fa -h请将上述字段替换为实际的服务器信息。注意：为了安全起见，建议使用 SSH 密钥认证方式。
注意事项
- 在使用插件研发工具之前，请确保已经正确安装和配置了 FastAdmin。
- 在使用
fa preview命令之前，请确保已经将插件代码添加到 Git 仓库中，并完成了相应的提交。 - 在使用
fa publish命令之前，请确保已经配置好了目标服务器的 SSH 信息，并确保能够成功连接到目标服务器。
反馈与贡献
如果您发现任何问题或有改进建议，请随时提出。您可以通过提交 Issue 或 Pull Request 的方式参与贡献。
感谢您使用 FastAdmin 插件研发工具！希望能为您的开发工作带来便利和效率提升。
TODO
- [ ] 简体开发目录fastadmin，能够自动收集插件需要的文件目录``
- [ ] 兼容‘删除’操作，自动删除目录不存在的文件
- [ ] 通过glob模块，增加配置 include,exclude 来过滤文件
Changelog
All notable changes to this project will be documented in this file. See standard-version for commit guidelines.
1.1.2 (2023-09-07)
其他
- README.MD: 更新 README.MD 文件，添加 FastAdmin 插件研发工具的功能特点和使用方法 (b88e767)
1.1.1 (2023-09-05)
1.1.0 (2023-09-05)
特性
- fix any bug (b30fd33)