1.0.0 • Published 7 years ago

its-name v1.0.0

Weekly downloads
41,782
License
MIT
Repository
github
Last release
7 years ago

its-name

Given (Mocha) test object, walks it up to give you list of context names

NPM

Build status semantic-release js-standard-style

Install

Requires Node version 6 or above.

npm install --save its-name

Use

If you have a test instance, for example when running Mocha you can find the list of names starting from the top level describe down to the test's own name. From inside test just pass this instance.

const itsName = require('its-name')
describe('its-name', () => {
  describe('nested describe', () => {
    context('inner context', () => {
      it('finds all names', function () {
        const names = itsName(this)
        // ["its-name", "nested-describe", "inner context", "finds all names"]
      })
    })
  })
})

Note: if the test instance is an arrow function - its context will NOT be the test object, instead it will be the parent closure.

const itsName = require('its-name')
it('works', function () {
  itsName(this)
  // ["works"]
})
it('does not work', () => {
  itsName(this)
  // throws an error
})

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2017

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) 2017 Gleb Bahmutov <gleb.bahmutov@gmail.com>

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.