Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahmutov/its-name
Given (Mocha) test object, walks it up to give you list of context names
https://github.com/bahmutov/its-name
mocha test utility
Last synced: about 1 month ago
JSON representation
Given (Mocha) test object, walks it up to give you list of context names
- Host: GitHub
- URL: https://github.com/bahmutov/its-name
- Owner: bahmutov
- Created: 2017-08-18T18:40:09.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-08-18T19:03:22.000Z (about 7 years ago)
- Last Synced: 2024-09-14T12:18:19.700Z (about 2 months ago)
- Topics: mocha, test, utility
- Language: JavaScript
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# its-name
> Given (Mocha) test object, walks it up to give you list of context names
[![NPM][npm-icon] ][npm-url]
[![Build status][ci-image] ][ci-url]
[![semantic-release][semantic-image] ][semantic-url]
[![js-standard-style][standard-image]][standard-url]
## Install
Requires [Node](https://nodejs.org/en/) version 6 or above.
```sh
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.
```js
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.
```js
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 <[email protected]> © 2017
* [@bahmutov](https://twitter.com/bahmutov)
* [glebbahmutov.com](https://glebbahmutov.com)
* [blog](https://glebbahmutov.com/blog)
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](https://github.com/bahmutov/its-name/issues) on Github
## MIT License
Copyright (c) 2017 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.
[npm-icon]: https://nodei.co/npm/its-name.svg?downloads=true
[npm-url]: https://npmjs.org/package/its-name
[ci-image]: https://travis-ci.org/bahmutov/its-name.svg?branch=master
[ci-url]: https://travis-ci.org/bahmutov/its-name
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/