作用:將 ES6+ 版本的代碼轉換為 ES5代碼,以便能夠運行在當前環境和舊版瀏覽器環境中。
這就意味著,可以用 ES6 編寫代碼,而不用擔心當前環境是否支持的問題。
一、配置 .babelrc
使用 Babel的第一步,就是配置 .babelrc
這個文件,該文件存放在項目根目錄下,用來設置轉碼規則和插件,基本格式如下:
{
"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-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
安裝在項目之中。
# install
$ 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-node
> (x => x * 2)(1)
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 --saves
然后,在項目中就可以調用 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也可以用于瀏覽器環境。但是,從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](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"]}]]
}
}
八、與其他工具配合
這里舉兩個例子: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
先轉碼。