https://github.com/jubianchi/atoum.js

The modern, simple and intuitive PHP 5.3+ unit testing framework, now for JS
https://github.com/jubianchi/atoum.js

Last synced: 3 months ago
JSON representation

The modern, simple and intuitive PHP 5.3+ unit testing framework, now for JS

• Host: GitHub
• URL: https://github.com/jubianchi/atoum.js
• Owner: jubianchi
• Created: 2013-04-01T10:44:52.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2018-08-30T12:27:43.000Z (over 6 years ago)
• Last Synced: 2024-10-10T14:17:41.133Z (3 months ago)
• Language: JavaScript
• Homepage: http://jubianchi.fr/atoum.js
• Size: 2.9 MB
• Stars: 16
• Watchers: 4
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# atoum.js

[![Build Status](https://travis-ci.org/jubianchi/atoum.js.png?branch=master)](https://travis-ci.org/jubianchi/atoum.js)

[![Dependency Status](https://www.versioneye.com/user/projects/51beb211143e1a000200496c/badge.png)](https://www.versioneye.com/user/projects/51beb211143e1a000200496c)

The modern, simple and intuitive PHP 5.3+ unit testing framework, now for JS

## How to install

```sh

$ git clone https://github.com/jubianchi/atoum.js.git

$ cd atoum.js

$ npm install

```

## How to use

```sh

$ bin/atoum -h

Options:

  --help, -h           Display this help message                [boolean]

  --directory, -d      Test directory                           [string]   [default: []]

  --file, -f           Test file                                [string]   [default: []]

  --xunit              Enable xUnit report                      [boolean]  [default: false]

  --xunit-output       Path to xUnit report file                [string]   [default: "xunit.xml"]

  --coverage           Enable code coverage report              [boolean]  [default: false]

  --coverage-dir       Path to sources to instrument            [string]   [default: "lib"]

  --inline             Use inline engine instead of concurrent  [boolean]

```

### Example

```sh

# This will run all tests in the given directory

$ bin/atoum -d path/to/tests/directory

```

## How to write tests

Here is an [example test](https://github.com/jubianchi/atoum.js/blob/master/tests/asserters/error.js).

[Other examples](https://github.com/jubianchi/atoum.js/tree/master/tests) with multiple test cases.

## Hacking atoum.js

```sh

# This will run the atoum.js' test suite

$ make test

```