前端構建工具gulp入門教程
本文假設你之前沒有用過任何任務腳本(task runner)和命令行工具,一步步教你上手Gulp。不要怕,它其實很簡單,我會分為五步向你介紹gulp並幫助你完成一些驚人的事情。那就直接開始吧。
第一步:安裝Node
首先,最基本也最重要的是,我們需要搭建node環境。訪問http://nodejs.org,然後點擊大大的綠色的install
按鈕,下載完成後直接運行程序,就一切準備就緒。npm會隨著安裝包一起安裝,稍後會用到它。
第二步:使用命令行
也許現在你還不是很了解什麽是命令行——OSX中的終端(Terminal),windows中的命令提示符(Command Prompt),但很快你就會知道。它看起來沒那麽簡單,但一旦掌握了它的竅門,就可以很方便的執行很多命令行程序,比如Sass,Yeoman和Git等,這些都是非常有用的工具。
如果你很熟悉命令行,直接跳到步驟四。
為了確保Node已經正確安裝,我們執行幾個簡單的命令。
node -v
回車(Enter),如果正確安裝的話,你會看到所安裝的Node的版本號,接下來看看npm。
npm -v
這同樣能得到npm的版本號。
如果這兩行命令沒有得到返回,可能node就沒有安裝正確,嘗試重啟下命令行工具,如果還不行的話,只能回到第一步進行重裝。
第三步:定位到項目
現在,我們已經大致了解了命令行並且知道如何簡單使用它,接下來只需要兩個簡單的命令就能定位到文件目錄並看看目錄裏都有些什麽文件。
- cd,定位到目錄
- ls,列出文件列表
建議多敲敲這兩個命令,了解文件系統並知道文件都在哪裏。
習慣使用了這兩個命令後,就要進入我們的項目目錄,這個目錄各不相同,舉個例子,這是我進入我項目目錄的命令:
cd /Applications/XAMPP/xamppfiles/htdocs/my-project
成功進入項目目錄後,我們開始安裝gulp。
第四步:安裝gulp
我們已經知道如何使用命令行,現在嘗試點新的東西,認識npm然後安裝gulp。
NPM是基於命令行的node包管理工具,它可以將node的程序模塊安裝到項目中,在它的官網中可以查看和搜索所有可用的程序模塊。
在命令行中輸入
sudo npm install -g gulp
- sudo是以管理員身份執行命令,一般會要求輸入電腦密碼
-
npm是安裝node模塊的工具,執行install命令
-
-g表示在全局環境安裝,以便任何項目都能使用它
- 最後,gulp是將要安裝的node模塊的名字
運行時註意查看命令行有沒有錯誤信息,安裝完成後,你可以使用下面的命令查看gulp的版本號以確保gulp已經被正確安裝。
gulp -v
接下來,我們需要將gulp安裝到項目本地
npm install —-save-dev gulp
這裏,我們使用—-save-dev
來更新package.json文件,更新devDependencies
值,以表明項目需要依賴gulp。
Dependencies
可以向其他參與項目的人指明項目在開發環境和生產環境中的node模塊依懶關系,想要更加深入的了解它可以看看package.json文檔。
第五步:新建Gulpfile文件,運行gulp
安裝好gulp後我們需要告訴它要為我們執行哪些任務,首先,我們自己需要弄清楚項目需要哪些任務。
- 檢查Javascript
- 編譯Sass(或Less之類的)文件
- 合並Javascript
- 壓縮並重命名合並後的Javascript
安裝依賴
npm install gulp-jshint gulp-sass gulp-concat gulp-uglify gulp-rename --save-dev
提醒下,如果以上命令提示權限錯誤,需要添加
sudo
再次嘗試。
新建gulpfile文件
現在,組件都安裝完畢,我們需要新建gulpfile文件以指定gulp需要為我們完成什麽任務。
gulp只有五個方法: task
,run
,watch
,src
,和dest
,在項目根目錄新建一個js文件並命名為gulpfile.js,把下面的代碼粘貼進去:
gulpfile.js
1 // 引入 gulp 2 var gulp = require(‘gulp‘); 3 4 // 引入組件 5 var jshint = require(‘gulp-jshint‘); 6 var sass = require(‘gulp-sass‘); 7 var concat = require(‘gulp-concat‘); 8 var uglify = require(‘gulp-uglify‘); 9 var rename = require(‘gulp-rename‘); 10 11 // 檢查腳本 12 gulp.task(‘lint‘, function() { 13 gulp.src(‘./js/*.js‘) 14 .pipe(jshint()) 15 .pipe(jshint.reporter(‘default‘)); 16 }); 17 18 // 編譯Sass 19 gulp.task(‘sass‘, function() { 20 gulp.src(‘./scss/*.scss‘) 21 .pipe(sass()) 22 .pipe(gulp.dest(‘./css‘)); 23 }); 24 25 // 合並,壓縮文件 26 gulp.task(‘scripts‘, function() { 27 gulp.src(‘./js/*.js‘) 28 .pipe(concat(‘all.js‘)) 29 .pipe(gulp.dest(‘./dist‘)) 30 .pipe(rename(‘all.min.js‘)) 31 .pipe(uglify()) 32 .pipe(gulp.dest(‘./dist‘)); 33 }); 34 35 // 默認任務 36 gulp.task(‘default‘, function(){ 37 gulp.run(‘lint‘, ‘sass‘, ‘scripts‘); 38 39 // 監聽文件變化 40 gulp.watch(‘./js/*.js‘, function(){ 41 gulp.run(‘lint‘, ‘sass‘, ‘scripts‘); 42 }); 43 });
現在,分段解釋下這段代碼。
引入組件
1 var gulp = require(‘gulp‘); 2 3 var jshint = require(‘gulp-jshint‘); 4 var sass = require(‘gulp-sass‘); 5 var concat = require(‘gulp-concat‘); 6 var uglify = require(‘gulp-uglify‘); 7 var rename = require(‘gulp-rename‘);
這一步,我們引入了核心的gulp和其他依賴組件,接下來,分開創建lint, sass, scripts 和 default這四個不同的任務。
Lint任務
1 gulp.task(‘lint‘, function() { 2 gulp.src(‘./js/*.js‘) 3 .pipe(jshint()) 4 .pipe(jshint.reporter(‘default‘)); 5 });
Link任務會檢查js/
目錄下得js文件有沒有報錯或警告。
Sass任務
1 gulp.task(‘sass‘, function() { 2 gulp.src(‘./scss/*.scss‘) 3 .pipe(sass()) 4 .pipe(gulp.dest(‘./css‘)); 5 });
Sass任務會編譯scss/
目錄下的scss文件,並把編譯完成的css文件保存到/css
目錄中。
Scripts 任務
1 gulp.task(‘scripts‘, function() { 2 gulp.src(‘./js/*.js‘) 3 .pipe(concat(‘all.js‘)) 4 .pipe(gulp.dest(‘./dist‘)) 5 .pipe(rename(‘all.min.js‘)) 6 .pipe(uglify()) 7 .pipe(gulp.dest(‘./dist‘)); 8 });
scripts任務會合並js/
目錄下得所有得js文件並輸出到dist/
目錄,然後gulp會重命名、壓縮合並的文件,也輸出到dist/
目錄。
default任務
1 gulp.task(‘default‘, function(){ 2 gulp.run(‘lint‘, ‘sass‘, ‘scripts‘); 3 gulp.watch(‘./js/*.js‘, function(){ 4 gulp.run(‘lint‘, ‘sass‘, ‘scripts‘); 5 }); 6 });
這時,我們創建了一個基於其他任務的default任務。使用.run()
方法關聯和運行我們上面定義的任務,使用.watch()
方法去監聽指定目錄的文件變化,當有文件變化時,會運行回調定義的其他任務。
現在,回到命令行,可以直接運行gulp任務了。
gulp
這將執行定義的default任務,換言之,這和以下的命令式同一個意思
gulp default
當然,我們可以運行在gulpfile.js中定義的任意任務,比如,現在運行sass任務:
gulp sass
(Kimi: 哇塞,酷比了哎~)
結束語
現在已經做到了設置gulp任務然後運行他們,現在再回顧下之前學習的。
- 學習了安裝Node環境
- 學習了簡單使用命令行
- 學習了用命令行進入項目目錄
- 學習了使用npm和安裝gulp
- 學習了如何運行gulp任務
另外,有一些參考資源供進一步學習:
- npm上得gulp組件
- gulp的Github主頁
- 官方package.json文檔
本文譯自http://travismaynard.com/writing/getting-started-with-gulp
前端構建工具gulp入門教程