Laravel Elixir 提供了簡潔流暢的 API,讓你能夠為你的 Laravel 應用程式定義基本的 Gulp 任務。Elixir 支援許多常見的 CSS 與 JavaScrtip 預處理器,甚至包含了測試工具。
如果你曾經對於使用 Gulp 及編譯資源感到困惑,那麼你絕對會愛上 Laravel Elixir!
在開始使用 Elixir 之前,你必須先確定你的開發環境上有安裝 Node.js。
node -v
預設情況下,Laravel Homestead 會包含你所需的一切;當然,如果你沒有使用 Vagrant,那麼你可以瀏覽 Node 的下載頁進行安裝。別擔心,安裝是很簡單又快速的!
接著你需要全域安裝 Gulp 的 NPM 安裝包,像是這樣:
npm install --global gulp
最後的步驟就是安裝 Elixir!伴隨著新安裝的 Laravel,你會發現根目錄有個名為 package.json
的檔案。想像它就如同你的 composer.json
檔案,只是它定義的是 Node 的依賴,而不是 PHP。你可以使用以下的指令進行安裝依賴的動作:
npm install
現在你已經安裝好 Elixir,未來任何時候你都能進行編譯及合併檔案!
elixir(function(mix) {
mix.less("app.less");
});
在上述例子中,Elixir 會假設你的 Less 檔案儲存在 resources/assets/less
裡。
elixir(function(mix) {
mix.sass("app.scss");
});
在上述例子中,Elixir 會假設你的 Sass 檔案儲存在 resources/assets/sass
裡。
elixir(function(mix) {
mix.coffee();
});
在上述例子中,Elixir 會假設你的 CoffeeScript 檔案儲存在 resources/assets/coffee
裡。
elixir(function(mix) {
mix.less()
.coffee();
});
elixir(function(mix) {
mix.phpUnit();
});
elixir(function(mix) {
mix.phpSpec();
});
elixir(function(mix) {
mix.styles([
"normalize.css",
"main.css"
]);
});
傳遞給此方法的檔案路徑均相對於 resources/css
目錄。
elixir(function(mix) {
mix.styles([
"normalize.css",
"main.css"
], 'public/build/css/everything.css');
});
elixir(function(mix) {
mix.styles([
"normalize.css",
"main.css"
], 'public/build/css/everything.css', 'public/css');
});
styles
與 scrtips
方法可以透過傳入第三個參數來決定來源檔案的相對目錄。
elixir(function(mix) {
mix.stylesIn("public/css");
});
elixir(function(mix) {
mix.scripts([
"jquery.js",
"app.js"
]);
});
同樣的,傳遞給此方法的檔案路徑均相對於 resources/js
目錄
elixir(function(mix) {
mix.scriptsIn("public/js/some/directory");
});
elixir(function(mix) {
mix.scripts(['jquery.js', 'main.js'], 'public/js/main.js')
.scripts(['forum.js', 'threads.js'], 'public/js/forum.js');
});
elixir(function(mix) {
mix.version("css/all.css");
});
這個動作會為你的檔案名稱加上獨特的雜湊值,以防止檔案被快取。舉例來說,產生出來的檔案名稱可能像這樣:all-16d570a7.css
。
接著在你的視圖中,你能夠使用 elixir()
函式來正確載入名稱被雜湊後的檔案。舉例如下:
<link rel="stylesheet" href="{{ elixir("css/all.css") }}">
程式的作用下,elixir()
函式會將參數內的原始檔名轉換成被雜湊後的檔名並載入。是否有如釋重擔的感覺呢?
elixir(function(mix) {
mix.copy('vendor/foo/bar.css', 'public/css/bar.css');
});
elixir(function(mix) {
mix.copy('vendor/package/views', 'resources/views');
});
當然,你能夠串連 Elixir 大部份的方法來建立一連串的任務:
elixir(function(mix) {
mix.less("app.less")
.coffee()
.phpUnit()
.version("css/bootstrap.css");
});
現在你已經告訴 Elixir 要執行的任務,接著只需要在命令列執行 Gulp。
gulp
gulp watch
gulp tdd
提示: 所有的任務都會使用開發環境進行,所以壓縮功能不會被執行。如果要使用上線環境,可以使用
gulp --production
。
你甚至能夠建立自己的 Gulp 任務至 Elixir 裡。想像一下,你想加入一個有趣的任務,使用終端機後會打印出一些訊息。看起來可能會如下:
var gulp = require("gulp");
var shell = require("gulp-shell");
var elixir = require("laravel-elixir");
elixir.extend("message", function(message) {
gulp.task("say", function() {
gulp.src("").pipe(shell("say " + message));
});
return this.queueTask("say");
});
請注意我們 擴增( extend )
Elixir 的 API 時所使用的第一個參數,稍後我們需要在 Gulpfile 中使用它,以及建立 Gulp 任務所使用的回呼函式。
如果你想要讓你的自訂任務能被監控,只要在監控器註冊就行了。
this.registerWatcher("message", "**/*.php");
這行程式的意思是指,當符合正規表示式的檔案一經修改,就會觸發 message
任務。
很好!接著你可以將這行程式寫在 Gulpfile 的頂端,或者將它放到自訂任務的檔案裡。如果你選擇後者,那麼你必須將它載入至你的 Gulpfile,例如:
require("./custom-tasks")
大功告成!最後你只需要將他們結合。
elixir(function(mix) {
mix.message("Tea, Earl Grey, Hot");
});
加入之後,每當你觸發 Gulp,Picard 就會要求一些茶。