This guide details all the configuration options available for the browser version of Blanket.js
- data-cover-adapter
- data-cover-customVariable
- data-cover-flags
- data-cover-loader
- data-cover-modulepattern
- data-cover-never
- data-cover-only
- data-cover-reporter
- data-cover-reporter-options
- data-cover-testReadyCallback
- data-cover-timeout
- data-cover-ecmaVersion
Use this option to configure a custom adapter for Blanket. Examples include adapters for Jasmine or Mocha. An adapter can be any code intended to run in concert with Blanket. Adapters do not have any special execution scope or access to Blanket, but they are required to override the default QUnit bindings.
The value for this setting must be a string representing a valid url path to the adapter JavaScript file.
Syntax: data-cover-adapter="<path/to/adapter>"
Example: data-cover-adapter="src/adapters/mocha-blanket.js
Result: The mocha-blanket adapter, located in src/adapters, will be loaded when the main Blanket script is executed.
This option can be used to override the default coverage variable name (_$blanket). Often this isn't required, but there may be use cases where you'd like it to match the variable name of another coverage package (i.e. _$jscoverage) or avoid collisions with local variables in your code.
NOTE: There are no checks done to ensure that the variable you provide is valid. It is your responsibility to ensure that a valid, conflict-free variable name is provided.
Syntax: data-cover-customVariable=""
Example: data-cover-customVariable="myCoverageVariable"
Result: Blanket will use myCoverageVariable as the coverage variable. After covered files are executed you can retrieve coverage information by querying the myCoverageVariable variable.
The data-cover-flags option is used to set a variety of boolean settings. It is a string value, and if an option is included in the string it will be set to true.
The syntax for data-cover-flag values is data-cover-flags="<whitespace separated list of flags>", i.e. data-cover-flags="ignoreError debug".
a. autoStart
b. branchTracking
c. commonJS
d. debug
e. engineOnly
f. existingRequireJS
g. ignoreCors
h. ignoreError
This option is used to force Blanket to continue processing even if an error occurs during instrumentation. This allows users to manage error handling in their preferred manner.
i. instrumentCache
j. sourceURL
This option is used to indicate which files you want included for coverage. The value can be a string, regular expression, array, or function. If you're including it in a data attribute, you must use the following format:
regular expression: data-cover-only="//"
example: data-cover-only="//sourcefile[0-9]{2}.js$/i"
result: the file sourcefile89.js would be covered.
array: data-cover-only="[<comma separated list of strings, regular expressions, arryas or functions>]"
example: data-cover-only="[src/,modules/]"
result: files contains src/ and modules/ in their files paths will be covered.
function: data-cover-only="#" example: data-cover-only="#function(str){ return str.length < 5; }" result: any files whose path is less than 5 characters will be covered.
This option is used to indicate which files you want excluded from coverage. If a file matches this setting it will be excluded, even if it matches a pattern from data-cover-only. The value can be a string, regular expression, array, or function.
If you're including it in a data attribute, you must use the following format:
regular expression: data-cover-never="//"
example: data-cover-never="//sourcefile[0-9]{2}.js$/i"
result: the file sourcefile89.js would be excluded from coverage.
array: data-cover-never="[<comma separated list of strings, regular expressions, arryas or functions>]"
example: data-cover-never="[src/,modules/]"
result: files contains src/ and modules/ in their files paths will be excluded from coverage.
function: data-cover-never="#" example: data-cover-never="#function(str){ return str.length < 5; }" result: any files whose path is less than 5 characters will be excluded from coverage.
This option is used to set a custom reporter for Blanket. The value can be a string (valid file path to reporter file), or a function (accepting the coverage result as an argument).
string: data-cover-reporter="<path/to/custom/reporter>" example: data-cover-reporter="mocha_blanket_reporter.js" result: The reporter defined in mocha_blanket_reporter will be attached as the reporter for Blanket coverage results.
function: blanket.options('data-cover-reporter',); example: blanket.options('data-cover-reporter',function myReporter(cov){ alert(cov); }); result: The full coverage object will be outputted via an alert dialog.
These options only affect the output of the reporters, and do not affect coverage or metrics in any way.
Example for node:
"data-cover-reporter-options": {
"relativepath": true
}
a. shortname: Set to true to only report filenames without any path
b. relativepath: Set to true to report files relative to the root of the project
c. basepath: Set to a string to remove part of the absolute path that is reported
This option is used to tell Blanket which ECMAScript version should use during instrumentation. Current supported versions are: 3, 5 and 6 (default version is 5). Remember that the environment where coverage takes place, should support this ECMAScript version too.
Syntax: data-cover-ecmaVersion="ECMAScript Version"
Example: data-cover-ecmaVersion="6"
Result: ECMAScript Version 6(2015) will be supported when the Blanket instrumentation process is executed.