Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
wallaby-webpack
Advanced tools
wallaby-webpack - npm Package Compare versions
Comparing version 0.0.7 to 0.0.8
@@ -281,4 +281,5 @@ 'use strict'; | ||
| static _getLoaderContent() { | ||
| // webpack prelude (taken from browserify, slightly modified to include webpack specific module.id and module.loaded) | ||
| var prelude = '(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module \'"+o+"\'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{},id:o,loaded:false};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r);l.loaded=true}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})'; | ||
| // webpack prelude, taken from browserify, | ||
| // slightly modified to include webpack specific module.id, module.loaded and require.e (require.ensure) | ||
| var prelude = '(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module \'"+o+"\'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{},id:o,loaded:false};var rq=function(e){var n=t[o][1][e];return s(n?n:e)};rq.e=function(a1,a2){a2.call(null,rq)};t[o][0].call(l.exports,rq,l,l.exports,e,t,n,r);l.loaded=true}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o<r.length;o++)s(r[o]);return s})'; | ||
| return 'window.__moduleBundler = {};' | ||
@@ -285,0 +286,0 @@ + 'window.__moduleBundler.cache = {};' |
| { | ||
| "name": "wallaby-webpack", | ||
| "version": "0.0.7", | ||
| "version": "0.0.8", | ||
| "description": "Webpack postprocessor for wallaby.js", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
158
README.md
@@ -5,158 +5,2 @@ # wallaby-webpack | ||
| ## Installation | ||
| ``` sh | ||
| npm install wallaby-webpack --save-dev | ||
| ``` | ||
| ## Usage | ||
| ``` javascript | ||
| // Wallaby.js configuration | ||
| var wallabyWebpack = require('wallaby-webpack'); | ||
| var wallabyPostprocessor = wallabyWebpack({ | ||
| // webpack options, such as | ||
| // module: { | ||
| // loaders: [ | ||
| // { | ||
| // test: /\.js$/, | ||
| // exclude: /node_modules/, | ||
| // loader: 'babel-loader' | ||
| // } | ||
| // ] | ||
| // }, | ||
| // externals: { jquery: "jQuery" } | ||
| } | ||
| ); | ||
| module.exports = function () { | ||
| return { | ||
| // set `load: false` to all of source files and tests processed by webpack | ||
| // (except external files), | ||
| // as they should not be loaded in browser, | ||
| // their wrapped versions will be loaded instead | ||
| files: [ | ||
| // {pattern: 'lib/jquery.js', instrument: false}, | ||
| {pattern: 'src/*.js', load: false} | ||
| ], | ||
| tests: [ | ||
| {pattern: 'test/*Spec.js', load: false} | ||
| ], | ||
| postprocessor: wallabyPostprocessor, | ||
| bootstrap: function () { | ||
| // required to trigger tests loading | ||
| window.__moduleBundler.loadTests(); | ||
| } | ||
| }; | ||
| }; | ||
| ``` | ||
| You may also consider re-using your existing webpack config by requiring it in wallaby config and adjusting the way you need. | ||
| ``` javascript | ||
| var webpackConfig = require('./webpack.config'); | ||
| // Adjust the config as required | ||
| // webpackConfig.plugins.push(...); | ||
| var wallabyPostprocessor = wallabyWebpack(webpackConfig); | ||
| ``` | ||
| ## Notes | ||
| ### Webpack options | ||
| To make your tests run as fast as possible, only specify options that you need for your tests to run to avoid doing anything that would make each test run slower. When possible, consider using [IgnorePlugin](http://webpack.github.io/docs/list-of-plugins.html#ignoreplugin) for dependencies that you don't test, for example for styles or templates that are not used in your tests. | ||
| You don't need to specify any output options because wallaby-webpack doesn't use concatenated bundle. While concatenating files is beneficial for a production environment, in a testing environment it is different. | ||
| Serving a large bundle every time when one of many files (that the bundle consists of) changes, is wasteful. | ||
| So instead, each compiled module code is passed to wallaby, wallaby caches it in memory (and when required, writes | ||
| it to disk) and serves each requested module file separately to properly leverage browser caching. | ||
| #### Source maps and `devtool` option | ||
| Please note, that some webpack loaders, such as `babel-loader` require you to use `devtool` option in order to generate a source map, that is required in wallaby.js for the correct error stack mappings. Wallaby supported `devtool` values are: `source-map`, `hidden-source-map`, `cheap-module-source-map`. | ||
| **For better performance, consider not using webpack loaders in wallaby configuration, specifically those that require `devtool` and source maps, and use wallaby.js preprocessors or compilers instead as described below.** | ||
| #### Loaders vs preprocessors/compilers | ||
| For your tests you don't have to use the module bundler loaders and where possible may use wallaby.js [preprocessors](https://github.com/wallabyjs/public#preprocessors-setting) or []([compiler](https://github.com/wallabyjs/public#compilers-setting)) instead. | ||
| For example, if you are using ES6/JSX, instead of using `babel-loader` in the webpack configuration, you may specify wallaby.js preprocessor: | ||
| ``` javascript | ||
| files: [ | ||
| {pattern: 'src/*.js', load: false} | ||
| ], | ||
| tests: [ | ||
| {pattern: 'test/*Spec.js', load: false} | ||
| ], | ||
| preprocessors: { | ||
| '**/*.js': file => require('babel').transform(file.content, {sourceMap: true}) | ||
| }, | ||
| postprocessor: wallabyPostprocessor | ||
| ``` | ||
| or a compiler (recommended in case if you are using or planning to use ES7 features, with [proper `stage` value](https://babeljs.io/docs/usage/experimental/) passed to the compiler options): | ||
| ``` javascript | ||
| files: [ | ||
| {pattern: 'src/*.js', load: false} | ||
| ], | ||
| tests: [ | ||
| {pattern: 'test/*Spec.js', load: false} | ||
| ], | ||
| compilers: { | ||
| '**/*.js': wallaby.compilers.babel({ babel: require('babel') /* , stage: 0 */ }), | ||
| } | ||
| postprocessor: wallabyPostprocessor | ||
| ``` | ||
| In this case, don't forget to remove `devtool` and not used loaders if you are using external webpack config as wallaby webpack config, for example: | ||
| ``` javascript | ||
| var webpackConfig = require('./webpack.config'); | ||
| // removing babel-loader, we will use babel compiler instead, it's more performant | ||
| webpackConfig.module.loaders = webpackConfig.module.loaders.filter(function(l){ | ||
| return l.loader !== 'babel-loader'; | ||
| }); | ||
| delete webpackConfig.devtool; | ||
| var wallabyPostprocessor = wallabyWebpack(webpackConfig); | ||
| ``` | ||
| ### Files and tests | ||
| All source files and tests (except external files/libs) must have `load: false` set, because wallaby will load wrapped versions of these files on `window.__moduleBundler.loadTests()` call in `bootstrap` function. Node modules should not be listed in the `files` list, they are loaded automatically. | ||
| Source files order doesn't matter, so patterns can be used instead of listing all the files. | ||
| Code inside each file is wrapped in such a way that when the file is loaded in browser, it doesn't execute | ||
| the code immediately. Instead, it just adds some function, that executes the file code, to test loader's cache. Tests and dependent files are loaded from wallaby `bootstrap` function, by calling `__moduleBundler.loadTests()`, and then executed. | ||
| ### Module resolution issues | ||
| If you are observing `ModuleNotFoundError`, required module folders are referenced in a relative manner and didn't make it into the wallaby file cache, that wallaby is using to run your tests. | ||
| For example, if you are using `bower_components` and may have something like this in you config: | ||
| ```javascript | ||
| resolve: { | ||
| modulesDirectories: ['bower_components'] | ||
| } | ||
| ``` | ||
| In this case, even though I would not recommend it, you may to add `{ pattern: 'bower_components/**/*.*', instrument: false, load: false }` to your files list, so that `bower_components` contents makes it into the wallaby cache and wallaby will be able to resolve modules from it. | ||
| The **more efficient approach** that I would recommend is to specify an absolute path in your wallaby configuration for webpack for **your external modules (not your source files)** instead: | ||
| ```javascript | ||
| resolve: { | ||
| modulesDirectories: [require('path').join(__dirname, 'bower_components')] | ||
| } | ||
| ``` | ||
| This way you don't need to specify `bower_components` in your files list and wallaby will not have to copy it over to its cache. | ||
| The same applies to `resolve.fallback`, `resolve.root` and `resolveLoader` webpack configuration settings. | ||
| **Please note that you don't need to do a similar thing for `node_modules`, as wallaby-webapck automatically adds local project `node_modules` folder to the the fallback list**. Unlike `node_modules`, `bower_components` and any other custom module folders can be used with different names/paths, so wallaby doesn't try to automatically add them based on the name convention. Also, you should not use the approach for your source files, because they need to be instrumented and served from the wallaby cache, not from the local project folder. | ||
| The plugin documentation lives at http://wallabyjs.com/docs/integration/webpack.html |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Lines of code
- increased by0.7%
286
Worsened metrics
- Total package byte prevSize
- decreased by-32.69%
14591
- Number of lines in readme file
- decreased by-96.3%
6
No dependency changes