# # Overview

Miniprogram-ci is a compilation module for the Weixin Mini Program / MiniGame project code extracted from the WeChat developer tool .

Developers can not open Weixin Mini Program developer tools, independent use of miniprogram-ci for Mini Program code upload, preview and other operations.

Miniprogram-ci supports uploading and previewing for Third Party Platform development from 1.0.28 and is invoked in the same way as normal development mode. View Details

# Key and IP whitelisting configuration

Before using miniprogram-ci, you should visit " WeChat Public Platform - Administration - Development Management - Development Settings - Weixin Mini Program Code Upload" to generate a Code Upload Key and configure IP whitelists The developer can choose to open the IP whitelist, only the IP in the whitelist can call the relevant interface. We recommend that all developers turn this option on by default to reduce the risk Code upload key has preview, upload code permissions, the key will not be stored in plain text on the WeChat public platform, once lost must be reset, please keep the developer

# function

Miniprogram-ci currently offers the following capabilities:

1. Upload code, corresponding to Weixin Mini Program developer tool upload
2. Preview code, corresponding to the Weixin Mini Program developer tool preview
3. Build npm, corresponding to the Weixin Mini Program developer tool: Menu - Tools - Build npm
4. Upload cloud development cloud function code, corresponding to the Weixin Mini Program developer tools upload cloud function capabilities
5. Upload cloud hosting code, corresponding to Weixin Mini Program developer tool upload cloud hosting capabilities
6. Upload cloud storage / static managed files for Weixin Mini Program Developer Tools - Cloud Development - Cloud storage and static managed document management
7. Proxy, configure the network request proxy mode of miniprogram-ci
8. Support for getting the most recently uploaded version of sourceMap
9. Support node script invocation and command line invocation

# Script calls

npm install miniprogram-ci --save

# Project Objectives

Project objects are the main inputs to this module and can be implemented on their own according to the definitions below

Definition of Project Object:

interface IProject {
  appid: string
  type: string
  projectPath: string
  privateKey: string
  attr(): Promise<IProjectAttr>
  stat(prefix: string, filePath: string): IStat | undefined
  getFile(prefix: string, filePath: string): Promise<Buffer>
  getFileList(prefix: string, extName: string): string[]
  updateFiles: () => void
}

You can also create the object by specifying the project path

const ci = require('miniprogram-ci')
// Note: When calling newci.Project, make sure that the project code is already complete to avoid a file missing error during compilation.
const project = new ci.Project({
  appid: 'wxsomeappid',
  type: 'miniProgram',
  projectPath: 'the/project/path',
  privateKeyPath: 'the/privatekey/path',
  ignores: ['node_modules/**/*'],
})

# upload

const ci = require('miniprogram-ci')
;(async () => {
  const project = new ci.Project({
    appid: 'wxsomeappid',
    type: 'miniProgram',
    projectPath: 'the/project/path',
    privateKeyPath: 'the/path/to/privatekey',
    ignores: ['node_modules/**/*'],
  })
  const uploadResult = await ci.upload({
    project,
    version: '1.1.1',
    desc: 'hello',
    setting: {
      es6: true,
    },
    onProgressUpdate: console.log,
  })
  console.log(uploadResult)
})()

# parameter

# return

# preview

const ci = require('miniprogram-ci')
;(async () => {
  const project = new ci.Project({
    appid: 'wxsomeappid',
    type: 'miniProgram',
    projectPath: 'the/project/path',
    privateKeyPath: 'the/path/to/privatekey',
    ignores: ['node_modules/**/*'],
  })
  const previewResult = await ci.preview({
    project,
    desc: 'hello', // 此备注将显示在“小程序助手”开发版列表中
    setting: {
      es6: true,
    },
    qrcodeFormat: 'image',
    qrcodeOutputDest: '/path/to/qrcode/file/destination.jpg',
    onProgressUpdate: console.log,
    // pagePath: 'pages/index/index', // 预览页面
    // searchQuery: 'a=1&b=2',  // 预览参数 [注意!]这里的`&`字符在命令行中应写成转义字符`\&`
  })
  console.log(previewResult)
})()

# parameter

# return

# Building npm

Build npm](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html) functionality against [developer tools.

const ci = require('miniprogram-ci')
;(async () => {
  const project = new ci.Project({
    appid: 'wxsomeappid',
    type: 'miniProgram',
    projectPath: 'the/project/path',
    privateKeyPath: 'the/path/to/privatekey',
    ignores: ['node_modules/**/*'],
  })
  // 在有需要的时候构建npm
  const warning = await ci.packNpm(project, {
    ignores: ['pack_npm_ignore_list'],
    reporter: (infos) => { console.log(infos) }
  })
  console.warn(warning)
  // 可对warning进行格式化
  /*
    warning.map((it, index) => {
            return `${index + 1}. ${it.msg}
    \t> code: ${it.code}
    \t@ ${it.jsPath}:${it.startLine}-${it.endLine}`
          }).join('---------------\n')
  */
  // 完成构建npm之后，可用ci.preview或者ci.upload
})()

# Pull the most recently uploaded version of sourceMap

const ci = require('miniprogram-ci')
;(async () => {
  const project = new ci.Project({
    appid: 'wxsomeappid',
    type: 'miniProgram',
    projectPath: 'the/project/path',
    privateKeyPath: 'the/path/to/privatekey',
    ignores: ['node_modules/**/*'],
  })
  await ci.getDevSourceMap({
    project,
    robot: 1,
    sourceMapSavePath: './sm.zip'
  })
})()

# parameter

# Build npm for custom node_modules location

Sometimes thenode_modulesthat need to be built might not be within the Weixin Mini Program project, so a new interface is provided to support this requirement. For example, there are the following project structures

├── lib # lib目录存放要被构建的 node_modules
│   ├── node_modules
│   │   └── is-object
│   └── package.json
└── miniprogram-project # 这里是小程序项目路径
    ├── miniprogram # 我们希望最终把 miniprogram_npm 构建在 miniprogram/ 目录之下
    │   ├── app.js
    │   ├── app.json
    │   ├── app.wxss
    │   ├── pages
    │   │   ├── index
    │   │   └── logs
    │   └── sitemap.json
    └── project.config.json

So you can call it this way.

let packResult = await ci.packNpmManually({
  packageJsonPath: './lib/package.json',
  miniprogramNpmDistDir: './miniprogram-project/miniprogram/',
})

console.log('pack done, packResult:', packResult)
// Output pack done, packResult: {miniProgramPackNum: 0, otherNpmPackNum: 1, warnList: []}

The final project obtained

.
├── lib
│   ├── node_modules
│   │   └── is-object
│   └── package.json
└── miniprogram-project
    ├── miniprogram
    │   ├── app.js
    │   ├── app.json
    │   ├── app.wxss
    │   ├── miniprogram_npm # <--- 这就是构建出来的由 lib/node_modules 里 miniprogram_npm 了
    │   ├── pages
    │   └── sitemap.json
    └── project.config.json

# Upload cloud development cloud functions

The cloud function upload capability for](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html) cloud development ](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html) ](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/capabilities.html#%E4%BA%91%E5%87%BD%E6%95%B0) Developer Tools].

const ci = require('miniprogram-ci')
;(async () => {
  const project = new ci.Project({
    appid: 'wxsomeappid',
    type: 'miniProgram',
    projectPath: 'the/project/path',
    privateKeyPath: 'the/path/to/privatekey',
    ignores: ['node_modules/**/*'],
  })

  const result = await ci.cloud.uploadFunction({
    project,
    env: '云环境 ID',
    name: '云函数名称',
    path: '云函数代码目录',
    remoteNpmInstall: true, // 是否云端安装依赖
  })
  console.warn(result)
})()

RemoteNpmInstallAdditional note: true Cloud installation dependency, will not upload localnode_modules, falseFull volume uploads, including uploadingnode_modules.

# Upload cloud to develop static websites / cloud storage

Corresponding developer tools Cloud development Static website hosting](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/staticstorage/introduction.html) and upload capabilities in cloud storage](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/storage.html) .

Need to install the alpha version:npm install --save miniprogram-ci @ alpha

const ci = require('miniprogram-ci')
;(async () => {
  const project = new ci.Project({
    appid: 'wxsomeappid',
    type: 'miniProgram',
    projectPath: 'the/project/path',
    privateKeyPath: 'the/path/to/privatekey',
    ignores: ['node_modules/**/*'],
  })
  // 静态网站
  const resultStatic = await ci.cloud.uploadStaticStorage({
    project,
    env: '云环境 ID',
    path: '本地文件目录',
    remotePath: '要上传到的远端文件目录',
  })
  // 云存储
  const resultStorage = await ci.cloud.uploadStorage({
    project,
    env: '云环境 ID',
    path: '本地文件目录',
    remotePath: '要上传到的远端文件目录',
  })
  console.warn(resultStatic, resultStorage)
})()

# New cloud development cloud-hosted version

Cloud hosting New version capability for](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html) Cloud development ](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/basis/getting-started.html) ](https://developers.weixin.qq.com/miniprogram/dev/wxcloud/guide/container/) Cloud hosting] [[TAG-1-NED]] Cloud hosting [[T@@

Need to install the alpha version:npm install --save miniprogram-ci @ alpha

const ci = require('miniprogram-ci')
;(async () => {
  const project = new ci.Project({
    appid: 'wxsomeappid',
    type: 'miniProgram',
    projectPath: 'the/project/path',
    privateKeyPath: 'the/path/to/privatekey',
    ignores: ['node_modules/**/*'],
  })
  const result = await ci.cloud.uploadContainer({
    project,
    env: '云环境 ID',
    version: {
      uploadType: 'package', // 上传方式
      flowRatio: 0, // 流量比例
      cpu: 0.25, // CPU 核心数
      mem: 0.5, // 内存大小
      minNum: 0, // 最小副本数
      maxNum: 1, // 最大副本数
      policyType: 'cpu', // 扩缩容条件
      policyThreshold: 60, // 扩缩容阈值
      containerPort: 80, // 容器监听端口
      serverName: 'server', // 服务名称
      versionRemark: 'ci', // 版本备注
      envParams: '{}', // 环境变量
      buildDir: '', // 构建目录
      dockerfilePath: '' // Dockerfile 路径
    },
    containerRoot: 'the/path/to/container' // 需要上传的版本文件目录
  })
  console.warn(result)
})()

# Proxy

Miniprogram-ci uses the get-proxy module to automatically get the proxy address. If you do not apply theci.proxy (]]method or the--proxy]]parameter to specify a proxy, miniprogram-ci will fetch the https proxy address in the following order

1. Get theHTTPS_PROXY in the context variable
2. Gets thehttps_proxy in the context variable
3. Get theHTTP_PROXY in the context variable
4. Get thehttp_proxy in the context variable
5. Get thehttps-proxy for npm configuration
6. Get thehttp-proxy for npm configuration
7. Gets theproxy for the npm configuration
8. Addservicewechat.comno_proxy`, miniprogram-ciNo network requests will be sent through proxies

const ci = require('miniprogram-ci')
ci.proxy('YOUR_PROXY_URL')

# Command line calls

npm install -g miniprogram-ci

#help
miniprogram-ci --help

#preview
miniprogram-ci \
  preview \
  --pp ./demo-proj/ \
  --pkp ./private.YOUR_APPID.key \
  --appid YOUR_APPID \
  --uv PACKAGE_VERSION \
  -r 1 \
  --enable-es6 true \
  --proxy YOUR_PROXY \
  --qrcode-format image \
  --qrcode-output-dest '/tmp/x.jpg' \

#upload

miniprogram-ci \
  upload \
  --pp ./demo-proj/ \
  --pkp ./private.YOUR_APPID.key \
  --appid YOUR_APPID \
  --uv PACKAGE_VERSION \
  -r 1 \
  --enable-es6 true \

#pack-npm
miniprogram-ci \
  pack-npm \
  --pp ./YOUR_PROJECT/ \
  --pkp ./private.YOUR_APPID.key \
  --appid YOUR_APPID \


#pack-npm-manually
miniprogram-ci \
pack-npm-manually \
--pack-npm-manually-package-json-path PACKAGE_JSON_PATH \
--pack-npm-manually-miniprogram-npm-dist-dir DISTPATH

#cloudbase upload cloudfunction
miniprogram-ci cloud functions upload \
  --pp ./YOUR_PROJECT/ \
  --appid YOUR_APPID \
  --pkp ./private.YOUR_APPID.key \
  --env YOUR_CLOUD_ENV_ID \   
  --name YOUR_CLOUD_FUNCTION_NAME \
  --path ./YOUR_CLOUD_FUNCTION_FOLDER_PATH/ \
  --remote-npm-install true

#proxy
export HTTPS_PROXY = YOUR_PROXY_URL # 可以在shell脚本里声明临时proxy

miniprogram-ci \
  upload \
  --pp ./demo-proj/ \
  --pkp ./private.YOUR_APPID.key \
  --appid YOUR_APPID \
  --uv PACKAGE_VERSION \
  -r 1 \
  --enable-es6 true \
  --proxy YOUR_PROXY_URL # 也可以使用这个参数声明proxy

#get dev source map
  miniprogram-ci \
  get-dev-source-map \
  --pp ./demo-proj/ \
  --pkp ./private.YOUR_APPID.key \
  --appid YOUR_APPID \
  -r 1 \ # 获取具体哪个robot最近上传的版本的sourceMap
  --source-map-save-path ./sourcemap.zip #保存路径，推荐zip结尾，最后得到的是一个zip包

# Compile settings

About Weixin Mini Program Developer Tools Code Compilation Options

# Third Party Platform Development

Miniprogram-cisupports the upload and preview of Third Party Platform development from1.0.28in the same way as in normal development mode. When using the Third Party Platform development pattern, note that:

• Make sure that the correctext.json exists in the project
• The key file is the key file for Third Party Platform bound development Weixin Mini ProgramAppID
• The IP whitelist is the development of Third Party Platform bindings Weixin Mini ProgramAppID
• Calling the incomingAppIDis Third Party Platform bound to develop Weixin Mini Programappid For the Third Party Platform development model, please refer to here