https://github.com/lixl39505/weapp-gulp-service
weapp precompile workflow
https://github.com/lixl39505/weapp-gulp-service
cli compiler gulp4 miniprogram
Last synced: 6 months ago
JSON representation
weapp precompile workflow
- Host: GitHub
- URL: https://github.com/lixl39505/weapp-gulp-service
- Owner: lixl39505
- License: other
- Created: 2021-07-12T04:18:41.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-11-05T03:56:21.000Z (7 months ago)
- Last Synced: 2025-12-10T02:55:24.978Z (6 months ago)
- Topics: cli, compiler, gulp4, miniprogram
- Language: JavaScript
- Homepage:
- Size: 507 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## 简介
weapp-gulp-service 是一款基于 gulp 实现的微信小程序预编译开发工具，可以有效提升原生小程序的开发效率。主要功能如下所示：
语法增强：
1. 支持 less；
2. 支持 px 自动转 rpx；
3. 支持本地图片转 base64；
4. 支持路径别名 alias；
5. 支持设置环境变量（类似 vue-cli 的 .env 文件）；
6. 支持 json5 语法；
7. 扩展 app.json，支持表达力更好的路由写法；
8. 支持.vue 单文件开发（兼容大部分 v-指令）；
工具特性：
1. 0 配置使用；
1. 支持增量编译；
1. 支持自定义 task；
1. 支持插件扩展（类似 Vue.use）；
1. 支持自动构建 npm（需开启 wxDevtool cli 服务）；
1. 支持命令行上传代码（需集成 `miniprogram-ci`）；
## 安装/运行
全局安装并使用：
```bash
npm i weapp-gulp-service -g
# 项目根目录执行
wgs --config /user/workspace/xx/weapp.config.js
```
也可以局部安装并使用：
```bash
npm i weapp-gulp-service -D
# 项目根目录执行
npx wgs
```
项目 Demo 参见 [weapp-project](https://github.com/pixelsLee/weapp-gulp-service/tree/main/templates/weapp-project) （可直接作为开发模版）。
## 详细说明
见 [docs](./docs/md) 目录。
## Command API
开发模式：
```bash
# 编译 + watch
wgs [options]
# 或者
wgs serve [options]
```
打包模式：
```bash
# 仅编译
wgs build [options]
```
构建 npm
```bash
# 生成 miniprogram_npm 目录
wgs build:npm [options]
```
代码上传:
```bash
# 先编译再上传
wgs upload -v 1.0.1 [desc]
```
ps: 各命令选项可通过 `--help` 查看
### 小程序 ci/cli 集成说明
_自动构建 npm_ 与*上传代码*两个功能前置依赖小程序官方服务——[wxdevtool-cli](https://developers.weixin.qq.com/miniprogram/dev/devtools/cli.html) 或者 [miniprogram-ci](https://developers.weixin.qq.com/miniprogram/dev/devtools/ci.html)。
如果使用 wxdevtool-cli（以下简称 cli 模式），需设置环境变量：
```bash
# macOS
WX_CLI=<安装路径>/Contents/MacOS/cli
# Windows
WX_CLI=<安装路径>/cli.bat
```
如果使用 miniprogram-ci（以下简称 ci 模式），需设置环境变量：
```bash
WE_APP_PRIVATE_KEY_PATH=<私匙路径>/private.xxxx.key
```
并安装全局依赖 miniprogram-ci；
```bash
npm i miniprogram-ci -g
```
两种方式二选一即可。如果二者同时设置，则 ci 模式优先。