使用gulp構建微信小程式開發工作流

shelia發表於2020-03-23

本篇文章主要闡述瞭如何使用gulp來構建微信小程式原生開發的工作流。

前言

web開發基本上都是基於webpack或者其他的構建工具來進行開發，大大節約了開發者的時間。目前的微信小程式開發也有很多開源的框架可供選擇，但是如果使用原生開發模式，雖然可以完美使用小程式原生的新特性和功能，但是工作流角度上卻十分簡陋。

19年末的時候公司要開發一個新的小程式，組裡面的大佬同事提議使用gulp來構建下原生開發模式的工作流。一是為了擺脫簡陋的工作流模式以節約開發時間，二是也是把技術用到刀刃上。在大佬的指導開發下，這個工作便進行了。總體來說這個工作並不難，增益可能也沒有那麼大，但是還是收穫了很多。

專案地址：gulp-mp

工作流改進

我們把開發目錄設定在src，輸出目錄設定在dist，定義開發與輸出路徑。

檔案複製

微信小程式的page目錄通常包含wxml,json,wxss和js檔案，與原生開發模式不同的是我們使用sass前處理器來寫樣式，其他的檔案保持原樣不同。因此，對於wxml,json,js檔案來說，僅僅需要copy就行。因為在專案中已經配置了eslint+prettier來進行語法檢查和程式碼美化，因此不需要在工作流的js程式碼進行規範檢查。如果沒有配置，可以安裝gulp-eslint執行eslint規範檢查。

const srcPath = "./src/**";
const distPath = "./dist/";
const wxmlFiles = [`${srcPath}/*.wxml`];
const jsFiles = [`${srcPath}/*.js`, `!${srcPath}/env/*.js`];
const jsonFiles = [`${srcPath}/*.json`];

// copy wxml
const wxml = () => {
  return gulp
    .src(wxmlFiles, { since: gulp.lastRun(wxml) })
    .pipe(gulp.dest(distPath));
};
gulp.task(wxml);

// 其他copy流類似
...
複製程式碼

sass處理

上面我們提到使用sass預處理來編寫樣式，在輸出的時候我們需要把scss樣式轉換成wxss，wxss就是普通的css樣式。這裡，我們使用gulp-sass外掛轉換scss樣式。但是，需要注意的是在scss檔案中，我們可能會import相關樣式，可能是公共樣式也可能是varibale和minxin。

經過測試發現，當import公共樣式，會把這個公共樣式打包進當前頁面。我們知道小程式的包是有大小限制的，如果在引入公共樣式的時候還打包到當前頁面，無疑是消耗掉了不必要的記憶體。所以，針對公共樣式的import處理為，不交給sass處理，保留import並把字尾的.scss改成.wxss。

當import的是變數和mixin時，我們需要保留對其的sass處理，因此新建獨立的目錄存放以便識別。在這一場景下，變數和mixin的檔案不再遞迴處理。

//存放variable和mixin的sass檔案在被引用時直接匯入，不引入dist目錄中
const DIRECTIMPORT = ["/scss/", "/font/"];
const sassFiles = [`${srcPath}/*.{scss, wxss}`];

const wxss = () => {
  return gulp
    .src([...sassFiles, ...DIRECTIMPORT.map(item => `!${srcPath}/${item}/*`)], {
      since: gulp.lastRun(wxss)
    })
    .pipe(plumber({ errorHandler: onError }))
    .pipe(
      tap(file => {
        const filePath = path.dirname(file.path);
        //console.log("filepath", filePath);
        file.contents = new Buffer(
            // 匹配@import
          String(file.contents).replace(
            /@import\s+['|"](.+)['|"];/g,
            ($1, $2) => {
              console.log("$1", $1);
              console.log("$2", $2);
              //如果不是變數或者mixin則註釋掉
              return DIRECTIMPORT.some(item => {
                return $2.indexOf(item) > -1;
              })
                ? $1
                : `/** ${$1} **/`;
            }
          )
        );
      })
    )
    .pipe(sass())
    .pipe(postcss([autoprefixer(["iOS >= 8", "Android >= 4.1"])]))
    .pipe(
      replace(/(\/\*\*\s{0,})(@.+)(\s{0,}\*\*\/)/g, ($1, $2, $3) => {
        //console.log("$1", $1);
        //console.log("$2", $2);
        //console.log("$3", $3);
        //去掉註釋並修改scss字尾為wxss
        return $3.replace(/\.scss/g, ".wxss");
      })
    )
    .pipe(rename({ extname: ".wxss" }))
    .pipe(gulp.dest(distPath));
};
gulp.task(wxss);
複製程式碼

壓縮圖片檔案

安裝gulp-imagemin外掛壓縮圖片。之前通過npm安裝在使用的時候這個外掛總是報錯，後來發現是沒有正確安裝，瞎倒騰切換到cnpm或者yarn發現可以安裝成功了。

const imageFiles = [
  `${srcPath}/images/*.{png,jpg,gif,ico}`,
  `${srcPath}/images/**/*.{png,jpg,gif,ico}`
];
const img = () => {
  return gulp
    .src(imageFiles, { since: gulp.lastRun(img) })
    .pipe(imagemin())
    .pipe(gulp.dest(distPath));
};
gulp.task(img);
複製程式碼

區分開發環境

正常開發過程中，開發，測試和釋出環境通常會有不同的API介面和其他設定。在每次切換的時候手動去更改內部程式碼是一件很麻煩的事情，也容易遺忘，根據不同的命令自動載入相應的開發環境設定才是我們想要的效果。在src/env/*目錄下，配置了三個環境的變數：dev.js，test.js，prod.js。

const envJs = env => {
  return () => {
    return gulp
      .src(`./src/env/${env}.js`)
      .pipe(rename("env.js"))
      .pipe(gulp.dest(distPath));
  };
};
gulp.task(envJs);
複製程式碼

清除dist目錄

在重新編譯的時候我們都需要清除dist目錄的資源，以免導致混亂

/* 清除dist目錄 */
gulp.task("clean", done => {
  del.sync(["dist/**"]);
  done();
});
複製程式碼

自動建立目錄

使用命令新建page目錄和component目錄，只要把模版檔案拷貝並重新命名即可。

const newfile = done => {
  yargs
    .example("gulp newfile  -p mypage", "建立mypage的page目錄")
    .example("gulp newfile  -c mycomponent", "建立mycomponent的component目錄")
    .example(
      "gulp newfile  -s srcfile -p mypage",
      "以srcfile為模版建立mypage的page目錄"
    )
    .option({
      s: {
        alias: "src",
        describe: "模板",
        type: "string",
        default: "template"
      },
      p: {
        alias: "page",
        describe: "page名稱",
        type: "string"
      },
      c: {
        alias: "component",
        describe: "component名稱",
        type: "string"
      }
    })
    .fail(msg => {
      done();
      console.error("建立失敗");
      console.log(msg);
      console.log("help");
      yargs.parse(["--msg"]);
    })
    .help("msg");

  const args = yargs.argv;
  //console.log("args", args);
  const source = args.s;
  const filePaths = {
    p: "pages",
    c: "components"
  };

  let name,
    type,
    hasParam = false;
  for (let key in filePaths) {
    if (args[key]) {
      hasParam = true;
      name = args[key];
      type = filePaths[key];
    }
  }
  if (!hasParam) {
    done();
    yargs.parse(["--msg"]);
  }
  const defaultPath =
    source === "template"
      ? `src/${source}/${type}/*`
      : `src/${type}/${source}/*`;
  return gulp.src(defaultPath).pipe(gulp.dest(`src/${type}/${name}/`));
};
gulp.task(newfile);
複製程式碼