首先babel是干什么的?Babel是一個廣泛使用的轉碼器,可以將ES6代碼轉為ES5代碼,從而在現有環境執行。
babel就是為了支持原有的舊的環境。
一、配置文件.babelrc
Babel的配置文件是.babelrc
,存放在項目的根目錄下。使用Babel的第一步,就是配置這個文件。
該文件用來設置轉碼規則和插件,基本格式如下。
{ "presets": [], "plugins": [] }
presets
字段設定轉碼規則,官方提供以下的規則集,你可以根據需要安裝。
# ES2015轉碼規則 $ npm install --save-dev babel-preset-es2015 # react轉碼規則 $ npm install --save-dev babel-preset-react # ES7不同階段語法提案的轉碼規則(共有4個階段),選裝一個 $ npm install --save-dev babel-preset-stage-0 $ npm install --save-dev babel-preset-stage-1 $ npm install --save-dev babel-preset-stage-2 $ npm install --save-dev babel-preset-stage-3
然后,將這些規則加入.babelrc
。
{ "presets": [ "es2015", "react", "stage-2" ], "plugins": [] }
注意,以下所有Babel工具和模塊的使用,都必須先寫好.babelrc
。
二、命令行轉碼babel-cli
Babel提供babel-cli
工具,用於命令行轉碼。
它的安裝命令如下。
$ npm install --global babel-cli
基本用法如下。
# 轉碼結果輸出到標准輸出 $ babel example.js # 轉碼結果寫入一個文件 # --out-file 或 -o 參數指定輸出文件 $ babel example.js --out-file compiled.js # 或者 $ babel example.js -o compiled.js # 整個目錄轉碼 # --out-dir 或 -d 參數指定輸出目錄 $ babel src --out-dir lib # 或者 $ babel src -d lib # -s 參數生成source map文件 $ babel src -d lib -s
上面代碼是在全局環境下,進行Babel轉碼。這意味着,如果項目要運行,全局環境必須有Babel,也就是說項目產生了對環境的依賴。另一方面,這樣做也無法支持不同項目使用不同版本的Babel。
一個解決辦法是將babel-cli
安裝在項目之中。
# 安裝 $ npm install --save-dev babel-cli
然后,改寫package.json
。
{ // ... "devDependencies": { "babel-cli": "^6.0.0" }, "scripts": { "build": "babel src -d lib" }, }
轉碼的時候,就執行下面的命令。
$ npm run build
三、babel-node
babel-cli
工具自帶一個babel-node
命令,提供一個支持ES6的REPL環境。它支持Node的REPL環境的所有功能,而且可以直接運行ES6代碼。
它不用單獨安裝,而是隨babel-cli
一起安裝。然后,執行babel-node
就進入PEPL環境。
$ babel-node > (x => x * 2)(1) 2
babel-node
命令可以直接運行ES6腳本。將上面的代碼放入腳本文件es6.js
,然后直接運行。
$ babel-node es6.js 2
babel-node
也可以安裝在項目中。
$ npm install --save-dev babel-cli
然后,改寫package.json
。
{ "scripts": { "script-name": "babel-node script.js" } }
上面代碼中,使用babel-node
替代node
,這樣script.js
本身就不用做任何轉碼處理。
四、babel-register
babel-register
模塊改寫require
命令,為它加上一個鈎子。此后,每當使用require
加載.js
、.jsx
、.es
和.es6
后綴名的文件,就會先用Babel進行轉碼。
$ npm install --save-dev babel-register
使用時,必須首先加載babel-register
。
require("babel-register"); require("./index.js");
然后,就不需要手動對index.js
轉碼了。
需要注意的是,babel-register
只會對require
命令加載的文件轉碼,而不會對當前文件轉碼。另外,由於它是實時轉碼,所以只適合在開發環境使用。
五、babel-core
如果某些代碼需要調用Babel的API進行轉碼,就要使用babel-core
模塊。
安裝命令如下。
$ npm install babel-core --save
然后,在項目中就可以調用babel-core
。
var babel = require('babel-core'); // 字符串轉碼 babel.transform('code();', options); // => { code, map, ast } // 文件轉碼(異步) babel.transformFile('filename.js', options, function(err, result) { result; // => { code, map, ast } }); // 文件轉碼(同步) babel.transformFileSync('filename.js', options); // => { code, map, ast } // Babel AST轉碼 babel.transformFromAst(ast, code, options); // => { code, map, ast }
配置對象options
,可以參看官方文檔http://babeljs.io/docs/usage/options/。
下面是一個例子。
var es6Code = 'let x = n => n + 1'; var es5Code = require('babel-core') .transform(es6Code, { presets: ['es2015'] }) .code; // '"use strict";\n\nvar x = function x(n) {\n return n + 1;\n};'
上面代碼中,transform
方法的第一個參數是一個字符串,表示需要轉換的ES6代碼,第二個參數是轉換的配置對象。
六、babel-polyfill
Babel默認只轉換新的JavaScript句法(syntax),而不轉換新的API,比如Iterator、Generator、Set、Maps、Proxy、Reflect、Symbol、Promise等全局對象,以及一些定義在全局對象上的方法(比如Object.assign
)都不會轉碼。
舉例來說,ES6在Array
對象上新增了Array.from
方法。Babel就不會轉碼這個方法。如果想讓這個方法運行,必須使用babel-polyfill
,為當前環境提供一個墊片。
安裝命令如下。
$ npm install --save babel-polyfill
然后,在腳本頭部,加入如下一行代碼。
import 'babel-polyfill'; // 或者 require('babel-polyfill');
Babel默認不轉碼的API非常多,詳細清單可以查看babel-plugin-transform-runtime
模塊的definitions.js文件。
七、瀏覽器環境
Babel也可以用於瀏覽器環境。但是,從Babel 6.0開始,不再直接提供瀏覽器版本,而是要用構建工具構建出來。如果你沒有或不想使用構建工具,可以通過安裝5.x版本的babel-core
模塊獲取。
$ npm install babel-core@old
運行上面的命令以后,就可以在當前目錄的node_modules/babel-core/
子目錄里面,找到babel
的瀏覽器版本browser.js
(未精簡)和browser.min.js
(已精簡)。
然后,將下面的代碼插入網頁。
<script src="node_modules/babel-core/browser.js"></script> <script type="text/babel"> // Your ES6 code </script>
上面代碼中,browser.js
是Babel提供的轉換器腳本,可以在瀏覽器運行。用戶的ES6腳本放在script
標簽之中,但是要注明type="text/babel"
。
另一種方法是使用babel-standalone模塊提供的瀏覽器版本,將其插入網頁。
<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-standalone/6.4.4/babel.min.js"></script> <script type="text/babel"> // Your ES6 code </script>
注意,網頁中實時將ES6代碼轉為ES5,對性能會有影響。生產環境需要加載已經轉碼完成的腳本。
下面是如何將代碼打包成瀏覽器可以使用的腳本,以Babel
配合Browserify
為例。首先,安裝babelify
模塊。
$ npm install --save-dev babelify babel-preset-es2015
然后,再用命令行轉換ES6腳本。
$ browserify script.js -o bundle.js \ -t [ babelify --presets [ es2015 react ] ]
上面代碼將ES6腳本script.js
,轉為bundle.js
,瀏覽器直接加載后者就可以了。
在package.json
設置下面的代碼,就不用每次命令行都輸入參數了。
{ "browserify": { "transform": [["babelify", { "presets": ["es2015"] }]] } }
八、在線轉換
Babel提供一個REPL在線編譯器,可以在線將ES6代碼轉為ES5代碼。轉換后的代碼,可以直接作為ES5代碼插入網頁運行。
九、與其他工具的配合
許多工具需要Babel進行前置轉碼,這里舉兩個例子:ESLint和Mocha。
ESLint 用於靜態檢查代碼的語法和風格,安裝命令如下。
$ npm install --save-dev eslint babel-eslint
然后,在項目根目錄下,新建一個配置文件.eslint
,在其中加入parser
字段。
{ "parser": "babel-eslint", "rules": { ... } }
再在package.json
之中,加入相應的scripts
腳本。
{ "name": "my-module", "scripts": { "lint": "eslint my-files.js" }, "devDependencies": { "babel-eslint": "...", "eslint": "..." } }
Mocha 則是一個測試框架,如果需要執行使用ES6語法的測試腳本,可以修改package.json
的scripts.test
。
"scripts": { "test": "mocha --ui qunit --compilers js:babel-core/register" }
上面命令中,--compilers
參數指定腳本的轉碼器,規定后綴名為js
的文件,都需要使用babel-core/register
先轉碼。
一、配置文件.babelrc
Babel的配置文件是.babelrc
,存放在項目的根目錄下。使用Babel的第一步,就是配置這個文件。
該文件用來設置轉碼規則和插件,基本格式如下。
{ "presets": [], "plugins": [] }
presets
字段設定轉碼規則,官方提供以下的規則集,你可以根據需要安裝。
# ES2015轉碼規則 $ npm install --save-dev babel-preset-es2015 # react轉碼規則 $ npm install --save-dev babel-preset-react # ES7不同階段語法提案的轉碼規則(共有4個階段),選裝一個 $ npm install --save-dev babel-preset-stage-0 $ npm install --save-dev babel-preset-stage-1 $ npm install --save-dev babel-preset-stage-2 $ npm install --save-dev babel-preset-stage-3
然后,將這些規則加入.babelrc
。
{ "presets": [ "es2015", "react", "stage-2" ], "plugins": [] }
注意,以下所有Babel工具和模塊的使用,都必須先寫好.babelrc
。
二、命令行轉碼babel-cli
Babel提供babel-cli
工具,用於命令行轉碼。
它的安裝命令如下。
$ npm install --global babel-cli
基本用法如下。
# 轉碼結果輸出到標准輸出 $ babel example.js # 轉碼結果寫入一個文件 # --out-file 或 -o 參數指定輸出文件 $ babel example.js --out-file compiled.js # 或者 $ babel example.js -o compiled.js # 整個目錄轉碼 # --out-dir 或 -d 參數指定輸出目錄 $ babel src --out-dir lib # 或者 $ babel src -d lib # -s 參數生成source map文件 $ babel src -d lib -s
上面代碼是在全局環境下,進行Babel轉碼。這意味着,如果項目要運行,全局環境必須有Babel,也就是說項目產生了對環境的依賴。另一方面,這樣做也無法支持不同項目使用不同版本的Babel。
一個解決辦法是將babel-cli
安裝在項目之中。
# 安裝 $ npm install --save-dev babel-cli
然后,改寫package.json
。
{ // ... "devDependencies": { "babel-cli": "^6.0.0" }, "scripts": { "build": "babel src -d lib" }, }
轉碼的時候,就執行下面的命令。
$ npm run build
三、babel-node
babel-cli
工具自帶一個babel-node
命令,提供一個支持ES6的REPL環境。它支持Node的REPL環境的所有功能,而且可以直接運行ES6代碼。
它不用單獨安裝,而是隨babel-cli
一起安裝。然后,執行babel-node
就進入PEPL環境。
$ babel-node > (x => x * 2)(1) 2
babel-node
命令可以直接運行ES6腳本。將上面的代碼放入腳本文件es6.js
,然后直接運行。
$ babel-node es6.js 2
babel-node
也可以安裝在項目中。
$ npm install --save-dev babel-cli
然后,改寫package.json
。
{ "scripts": { "script-name": "babel-node script.js" } }
上面代碼中,使用babel-node
替代node
,這樣script.js
本身就不用做任何轉碼處理。
四、babel-register
babel-register
模塊改寫require
命令,為它加上一個鈎子。此后,每當使用require
加載.js
、.jsx
、.es
和.es6
后綴名的文件,就會先用Babel進行轉碼。
$ npm install --save-dev babel-register
使用時,必須首先加載babel-register
。
require("babel-register"); require("./index.js");
然后,就不需要手動對index.js
轉碼了。
需要注意的是,babel-register
只會對require
命令加載的文件轉碼,而不會對當前文件轉碼。另外,由於它是實時轉碼,所以只適合在開發環境使用。
五、babel-core
如果某些代碼需要調用Babel的API進行轉碼,就要使用babel-core
模塊。
安裝命令如下。
$ npm install babel-core --save
然后,在項目中就可以調用babel-core
。
var babel = require('babel-core'); // 字符串轉碼 babel.transform('code();', options); // => { code, map, ast } // 文件轉碼(異步) babel.transformFile('filename.js', options, function(err, result) { result; // => { code, map, ast } }); // 文件轉碼(同步) babel.transformFileSync('filename.js', options); // => { code, map, ast } // Babel AST轉碼 babel.transformFromAst(ast, code, options); // => { code, map, ast }
配置對象options
,可以參看官方文檔http://babeljs.io/docs/usage/options/。
下面是一個例子。
var es6Code = 'let x = n => n + 1'; var es5Code = require('babel-core') .transform(es6Code, { presets: ['es2015'] }) .code; // '"use strict";\n\nvar x = function x(n) {\n return n + 1;\n};'
上面代碼中,transform
方法的第一個參數是一個字符串,表示需要轉換的ES6代碼,第二個參數是轉換的配置對象。
六、babel-polyfill
Babel默認只轉換新的JavaScript句法(syntax),而不轉換新的API,比如Iterator、Generator、Set、Maps、Proxy、Reflect、Symbol、Promise等全局對象,以及一些定義在全局對象上的方法(比如Object.assign
)都不會轉碼。
舉例來說,ES6在Array
對象上新增了Array.from
方法。Babel就不會轉碼這個方法。如果想讓這個方法運行,必須使用babel-polyfill
,為當前環境提供一個墊片。
安裝命令如下。
$ npm install --save babel-polyfill
然后,在腳本頭部,加入如下一行代碼。
import 'babel-polyfill'; // 或者 require('babel-polyfill');
Babel默認不轉碼的API非常多,詳細清單可以查看babel-plugin-transform-runtime
模塊的definitions.js文件。
七、瀏覽器環境
Babel也可以用於瀏覽器環境。但是,從Babel 6.0開始,不再直接提供瀏覽器版本,而是要用構建工具構建出來。如果你沒有或不想使用構建工具,可以通過安裝5.x版本的babel-core
模塊獲取。
$ npm install babel-core@old
運行上面的命令以后,就可以在當前目錄的node_modules/babel-core/
子目錄里面,找到babel
的瀏覽器版本browser.js
(未精簡)和browser.min.js
(已精簡)。
然后,將下面的代碼插入網頁。
<script src="node_modules/babel-core/browser.js"></script> <script type="text/babel"> // Your ES6 code </script>
上面代碼中,browser.js
是Babel提供的轉換器腳本,可以在瀏覽器運行。用戶的ES6腳本放在script
標簽之中,但是要注明type="text/babel"
。
另一種方法是使用babel-standalone模塊提供的瀏覽器版本,將其插入網頁。
<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-standalone/6.4.4/babel.min.js"></script> <script type="text/babel"> // Your ES6 code </script>
注意,網頁中實時將ES6代碼轉為ES5,對性能會有影響。生產環境需要加載已經轉碼完成的腳本。
下面是如何將代碼打包成瀏覽器可以使用的腳本,以Babel
配合Browserify
為例。首先,安裝babelify
模塊。
$ npm install --save-dev babelify babel-preset-es2015
然后,再用命令行轉換ES6腳本。
$ browserify script.js -o bundle.js \ -t [ babelify --presets [ es2015 react ] ]
上面代碼將ES6腳本script.js
,轉為bundle.js
,瀏覽器直接加載后者就可以了。
在package.json
設置下面的代碼,就不用每次命令行都輸入參數了。
{ "browserify": { "transform": [["babelify", { "presets": ["es2015"] }]] } }
八、在線轉換
Babel提供一個REPL在線編譯器,可以在線將ES6代碼轉為ES5代碼。轉換后的代碼,可以直接作為ES5代碼插入網頁運行。
九、與其他工具的配合
許多工具需要Babel進行前置轉碼,這里舉兩個例子:ESLint和Mocha。
ESLint 用於靜態檢查代碼的語法和風格,安裝命令如下。
$ npm install --save-dev eslint babel-eslint
然后,在項目根目錄下,新建一個配置文件.eslint
,在其中加入parser
字段。
{ "parser": "babel-eslint", "rules": { ... } }
再在package.json
之中,加入相應的scripts
腳本。
{ "name": "my-module", "scripts": { "lint": "eslint my-files.js" }, "devDependencies": { "babel-eslint": "...", "eslint": "..." } }
Mocha 則是一個測試框架,如果需要執行使用ES6語法的測試腳本,可以修改package.json
的scripts.test
。
"scripts": { "test": "mocha --ui qunit --compilers js:babel-core/register" }
上面命令中,--compilers
參數指定腳本的轉碼器,規定后綴名為js
的文件,都需要使用babel-core/register
先轉碼。