Omi原理-環境搭建

當耐特發表於2019-03-04

環境搭建

Omi框架使用 Webpack + ES6 的方式去開發;使用karma+jasmine來作為Omi的測試工具。

Karma介紹

Karma是一個基於Node.js的JavaScript測試執行過程管理工具(Test Runner)。該工具可用於測試所有主流Web瀏覽器,也可整合到CI(Continuous integration)工具,也可和其他程式碼編輯器一起使用。這個測試工具的一個強大特性就是,它可以監控(Watch)檔案的變化,然後自行執行。但是整合到travis ci要把singleRun設定成true,讓其只執行一遍。

Jasmine介紹

Jasmine 是一款 JavaScript BDD(行為驅動開發)測試框架,它不依賴於其他任何 JavaScript 元件。它有乾淨清晰的語法,讓您可以很簡單的寫出測試程式碼。

開發依賴包

在package.json中,有如下配置:

  "devDependencies": {
    "babel-core": "^6.0.20",
    "babel-loader": "^6.0.1",
    "babel-preset-es2015": "^6.0.15",
    "node-libs-browser": "^0.5.3",
    "webpack": "^1.14.0",
    "jasmine-core": "^2.5.2",
    "karma": "^1.3.0",
    "karma-chrome-launcher": "^2.0.0",
    "karma-jasmine": "^1.1.0",
    "karma-webpack": "^1.8.1"
  }複製程式碼
  • ES6+相關依賴有babel-core、babel-loader和babel-preset-es2015

在webpack.config.js中配置js檔案使用babel-loader編譯。

loaders: [
    {
        loader: `babel-loader`,
        test: /.js$/,
        query: {
            presets: `es2015`,
        }
    }
]複製程式碼
  • webpack相關依賴有node-libs-browser和webpack
  • 其餘都是單元測試相關依賴

      注意,這裡使用了karma-webpack。因為使用Omi框架支援ES6+和ES5,使用karma-webpack是為了在單元測試裡面使用ES6+的import和Class等語法。複製程式碼

在karma.conf.js中配置webpack:

    webpack: webpackConfig,
    webpackMiddleware:{
      noInfo:false
    },
    plugins: [
        `karma-webpack`,
        `karma-jasmine`,
        `karma-chrome-launcher`
    ]複製程式碼

具體配置看test目錄下的karma.conf.jswebpack.test.config.js便可。

注意,karma.conf.js需要設定

// if true, Karma captures browsers, runs the tests and exits
singleRun: true,複製程式碼

不然,travis ci指令碼執行的時候不會中斷導致執行超時異常。

npm 指令碼

  "scripts": {
    "build": "webpack -w",
    "test": "karma start test/karma.conf.js",
    "hello": "webpack -w",
    "todo": "webpack -w"
  }複製程式碼

其中:

  • npm run build : 生成dist目錄的omi.js檔案
  • npm run test : 執行單元測試
  • npm run hello : 編譯hello的demo
  • npm run todo : 編譯todo的demo

在webpack.config.js中,會根據 process.env.npm_lifecycle_event去設定不同的入口檔案。所以同樣是執行webpack -w,執行結果可以不一樣。

來看下build的相關webpack配置:

if(ENV === `build`){
    config = {
        entry: {
            omi: `./src/index.js`
        },
        output: {
            path: `dist/`,
            library:`Omi`,
            libraryTarget: `umd`,
            filename:  `[name].js`
        },複製程式碼

這裡把libraryTarget設定成了umd,webpack會幫助我們build出umd的Omi。

如果是打包demo(npm run hello 和 npm run todo)的話,會進入下面的條件判斷:

else {
    config.entry = `./example/` + ENV + `/main.js`;
    config.output.path = `./example/` + ENV + `/`;
}複製程式碼

會去example下對應的目錄查詢main.js作為webpack入口檔案。

這裡可以看到,我們不僅用webpack build出Omi框架,也使用webpack build所有demo。
詳細配置參考webpack.config.js的配置。

參考文件

招募計劃

Omi原理-環境搭建