Skip to content

Terminal-wide banner with test name before each Mocha test

Notifications You must be signed in to change notification settings

bahmutov/mocha-banner

Repository files navigation

mocha-banner

Terminal-wide banner with test name before each Mocha test

NPM

Build status semantic-release js-standard-style renovate-app badge

Install

Requires Node version 6 or above.

npm install --save-dev mocha-banner

Use

// include somewhere at the beginning
require('mocha-banner').register()

Before each test you will get a nice banner

----------------------------------------
         my-app / first test
----------------------------------------
    ✓ first test

You can also enable banner only in some suites. Instead of putting register() outside of any any spec, place it inside

describe('will have banner', () => {
  require('mocha-banner').register()
  it('has banner', () => {})
  it('has banner', () => {})
})
describe('no banner', () => {
  it('will not have banner', () => {})
})

Uses terminal-banner under the hood.

Small print

Author: Gleb Bahmutov <[email protected]> © 2018

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2018 Gleb Bahmutov <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.