Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snaptopixel/testify
https://github.com/snaptopixel/testify
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/snaptopixel/testify
- Owner: snaptopixel
- Created: 2019-03-26T19:54:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:22:02.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T21:40:11.334Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 782 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# testify
An opinionated configuration and tool for testing browser-based Typescript projects with Mocha.
💡 Builds upon many of the ideas from [@tomazzaman](https://github.com/tomazzaman)'s excellent article “[How to get fast unit tests with(out) Webpack](https://medium.com/@TomazZaman/how-to-get-fast-unit-tests-with-out-webpack-793c408a076f)”
### What it does
Initializes and configures a testing environment with the following:
- [ts-node](https://github.com/TypeStrong/ts-node) for writing tests and transpiling `.ts` imports
- [mocha](https://github.com/mochajs/mocha) for running tests
- [sinon](https://github.com/sinonjs/sinon) for mocking/stubbing functions
- [chai](https://github.com/chaijs/chai) for assertions w/
- [sinon-chai](https://github.com/domenic/sinon-chai)
- [chai-dom](https://github.com/nathanboktae/chai-dom)
- [jsdom](https://github.com/jsdom/jsdom) for a browser-esque environment
#### ✨ Bonus features
- 😏 No webpack
- 🚀 Tracks test files and dependencies in watch mode and re-runs tests
### Using it in your projects
#### Install with yarn or npm
```bash
yarn add @snaptopixel/testify
```
#### Configure with cosmiconfig
Testify can be configured via:
- `testify` object in `package.json`
- `.testifyrc` file in yaml or json format
- `testify.config.js` file
Supported properties:
- **files** - minimatch glob pattern for test files, ie: `src/**/*.spec.ts`
- **src** - minimatch glob pattern for source files, ie: `src/**/*.ts`
- **require** - array of file paths to include, useful for [customizing the test environment](#customizing-the-test-environment)
- **alias** - map of path/file aliases for requiring files,ie: `"@": "src"`
#### Add run script(s) to `package.json`
```json
"test": "testify"
```
#### Watch mode
Pass `-w` to run tests in watch mode
```bash
npm run test -- -w
```
Or add it as a package.json script
```json
"test.watch": "testify -w"
```
#### Filtering tests
Tests can be filtered via regex when using the command line:
```bash
npm run test -- -f user
```
#### Coverage reporting
Install [nyc](https://github.com/istanbuljs/nyc) and invoke it before `testify`. Check nyc's README for configuration options
```js
"test": "nyc testify"
```
### The test environment
`chai` `describe` `it` `expect` `assert` and `sinon` are available globally in tests and `require` files
### Customizing the test environment
Required files will be executed in the node environment once jsdom mocha have been initialized.
This is useful if your scripts depend on global variables, for example:
```js
// In required js/ts file
window.SomeGlobal = {
someMethod: sinon.spy()
}
// In test file
describe('globals', () => {
it('can access global', () => {
window.SomeGlobal.someMethod('hey')
expect(window.SomeGlobal.someMethod).calledWith('hey')
})
})
```
You can also customize `chai` and others using the globals:
```js
chai.use(require('chai-jquery'));
```
### Type checking
Note that testify will not type check your files. For the sake of simplicity and speed ts-node runs in "transpile only" mode.
It's recommended to type check your project via `tsc --noEmit` as part of your ci and/or development process.