/Gulp

Primary LanguageJavaScript

網頁切版直播班 Gulp 範例

使用該專案 Gulp 時，就可以不用使用其他編譯工具編譯 SCSS 或是 JavaScript 囉。

指令列表

  • gulp - 執行開發模式(會開啟模擬瀏覽器並監聽相關檔案)
    • 若沒有自動開啟瀏覽器則可手動在瀏覽器上輸入 http://localhost:8080/ 即可。
    • 假使監聽功能無效的話，可以檢查一下是否修改到資料夾的名稱等。
  • gulp build - 執行編譯模式(不會開啟瀏覽器)
  • gulp clean - 清除 dist 資料夾
  • gulp deploy - 將 dist 資料夾部署至 GitHub Pages
    • 若無法部署到 GitHub Pages 的話，可以確定一下是否已經初始化專案等。

請務必確保已經在本機上輸入過 npm install -g gulp，否則電腦會不認識 gulp 指令哦。

說明

除了 Boostrap CSS 與 Boostrap JavaScript 需要掛 CDN 之外，本身已經內建打包 jQuery 3.5.1。

若有需要調整相關路徑參數可在 envOptions.js 中調整，但建議不要隨意調整導致 Gulp 無法正常運行。

假使對於 Gulp 不熟悉會建議不要任意調整 gulpfile.js 底下的資料任一檔案，避免出現無法正常運作之問題。

資料夾結構

  • App # 原始碼
    • assets # 靜態資源放置處
      • images # 圖片放置處
      • js # JavaScript 放置處
      • style # 樣式放置處
    • index.html # 首頁 HTML
    • layout.ejs # Layout ejs
  • gulpfile.js # Gulp 原始碼
    • envOptions.js # Gulp 路徑變數
    • index.js # Gulp 核心原始碼

注意事項

assets 底下的資料夾名稱建議不要任意修改，例如：stlye 改成 styles 又或者是 scss 等非原始資料夾名稱。

最主要原因是 Gulp 預設是監聽 style、js、 images 這幾個資料夾路徑底下的檔案，因此若任意修改名稱將可能導致 Gulp 的監聽功能失效或其他不可預期之問題發生。

若本身已經對於 Gulp 有一定掌握度則可進入 gulpfile.js/envOptions.js 修改相關路徑即可。

Gulp 的自動更新行為是必須持續開著終端機的，因此若關閉終端機則會失去監聽與自動更新效果，因此在開專案時，請不要關閉運行中的終端機。

支援的監聽

目前支援 HTML、ejs、JavaScript、Images、SCSS 監聽並自動重新刷新。

圖片新增時也會自動刷新。

因此是不用使用 Live Sass Compiler 的 Watch SCSS 功能或是 Prepros 等工具來編譯 SCSS。

除此之外 Gulp 本身有支援模擬伺服器，因此不用再次使用一些模擬伺服器的套件，例如：Preview on Web Server 套件等。

部署 gh-pagse 流程說明

部署前請務必先將該 Gulp 原始碼上傳到 GitHub Repositories 也就是初始化 GitHub，因此通常第一步驟會輸入以下指令

git init # 若已經初始化過就可以不用輸入
git add .
git commit -m 'first commit'
git remote add origin [GitHub Repositories Url]
git push -u origin master // 僅限第一次輸入，往後只需要輸入 git push

當將 Gulp 原始碼初次部署到 GitHub 之後就可以輸入 gulp build 進入生產模式，當生產完畢之後接下來只需要輸入 gulp deploy 即可完成 GitHub Pages 部署。

其他可能的狀況

Q：Mac 環境下輸入 npm install -g gulp 時出現「Permission denied」等字眼。

A：由於 Mac 在環境上的安裝是會比較嚴格的，當出現「Permission denied」時，可以在指令前面加上 sudo (sudo npm install -g gulp)

Q: Window 環境下輸入 gulp 卻出現「因為這個系統上已停用指令碼執行，所以無法載入...」

A: 後來的 Window 在終端機的權限使用上會預設是禁止使用一些指令的，因此可以參考 這一篇 文章解決。

Q: 輸入 gulp deploy 卻出現「TypeError: Cannot read property 0 of null」。

A: 這是一個很神奇的問題，在原套件的 issues 也有提供相關討論，因此可以參考 這一篇 文章解決。

Q: Gulp SCSS 或是 JS 撰寫完畢並儲存檔案後 Gulp 不會重新編譯。

A: 這邊的原因有可能是修改了預設 Gulp 監聽的路徑資料夾，預設是監聽 style、js、 images 這幾個資料夾路徑底下的檔案，因此若任意修改名稱將可能導致 Gulp 的監聽功能失效或其他不可預期之問題發生，除此之外該專案 Gulp 是監聽 .scss 檔案對於 .css 並沒有監聽自動更新的效果。

Q: 其他可能的問題且無法部署到 GitHub Pages。

A: 這邊問題有許多種，因此在排除上可能會比較麻煩，需要多一點耐心。

  • 可能沒有針對 GitHub 專案做第一次的初始化部署。
  • 電腦可能沒有安裝 Git(可以執行一下 git --version 確保有出現版本號)。
  • 忘記執行 npm install
  • 對於終端機的 Git 操作不熟悉(可以考慮使用 GitHub Desktop 來操作會較為方便)。
  • 出現「not a git repository」(主要是缺少了 git init 將目前專案初始化 Git)

Q: 執行 gulp 之後瀏覽器沒有自動開啟。

A: 關於這一點每一台電腦的瀏覽器權限都不同，因此若沒有自動開啟的話，｀可以手動將 http://localhost:8080/ 貼入到自己手動開的瀏覽器也可以哦。

Q: 輸入 gulp deploy 之後出現 「Message: Command filed: git pull」提示訊息

A: 這邊請麻煩刪除隱藏的資料夾「.publish」再重新 gulp deploy 就可以囉。

這種狀況通常發生在操作流程上可能不正確導致錯誤，因此打開「.publish」的時候會看到未編譯後的 Gulp 原始碼，正確來講該資料夾底下只會有編譯後的原始碼，如果刪除「.publish」之後狀況還是沒改善，那麼建議刪除「dist」資料夾並重新輸入 gulp build → gulp deploy 即可。

Q: 以上問題都無法解決

A: 建議可以查看一下自己的相關版本，以下是專案開發者的運行環境

  • Node v12.18.2
    • 實際測試 Node 12~14 都是可以運行的
    • 查看自己版本指令：node -v
  • Gulp
    • CLI version: 2.3.0
    • Local version: 4.0.2
    • 查看自己版本指令：gulp -v
  • git version 2.23.0
    • 查看自己版本指令：git ---version

學習資源

若對於 Gulp 有一定興趣的話，以下這邊提供學習資源