You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-29Lines changed: 16 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,31 @@ Argus test runner
5
5
6
6
Watches your files and executes automated tests for them when they change.
7
7
8
+
## Note
9
+
These are the docs for **2.0.0** version. For **1.4.1** version documentation see [here](../1.4.1/README.md).
10
+
8
11
## Requirements
9
-
*[Node.js](https://nodejs.org/en/)v6.* or greater
10
-
* npm 3 or greater
12
+
*[Node.js](https://nodejs.org/en/)v8.* or greater
13
+
* npm 5 or greater
11
14
12
15
## Installation
13
16
14
17
### Global installation
15
18
1.```npm install -g argus-test-runner```
16
-
30. Navigate to your project root and type ```argus``` to start watching
19
+
15. Navigate to your project root
20
+
20. Create a configuration file named `argus.config.js` (see [configuration examples](#configuration-file-examples))
21
+
30. Type ```argus``` to start watching
17
22
50. Type ```argus -h``` for usage information
18
23
19
24
### Local installation
20
25
1. If you already have a package.json in your project, you can also install argus-test-runner locally
21
26
20. Navigate to your project root and type ```npm install --save-dev argus-test-runner```
27
+
25. Create a configuration file named `argus.config.js` (see [configuration examples](#configuration-file-examples))
22
28
30. Start Argus with ```./node_modules/.bin/argus```
23
29
40. You can also add an npm script for convenience in your package.json:
24
30
```json
25
31
"devDependencies": {
26
-
"argus-test-runner": "^1.1.1"
32
+
"argus-test-runner": "^2.0.0"
27
33
},
28
34
"scripts": {
29
35
"argus": "argus"
@@ -35,21 +41,7 @@ To stop watching files just press ```Ctrl + C```
35
41
36
42
## Configuration
37
43
38
-
### Default configuration (**deprecated**)
39
-
Default configuration is set up so that:
40
-
* [PHPUnit](https://phpunit.de/) tests are run (using ```vendor/bin/phpunit```)
41
-
* your project must keep it's tests in one of these four locations:
42
-
1. tests/unit/
43
-
20. test/unit/
44
-
30. tests/
45
-
40. test/
46
-
* test file names must end with ```*Test.php```
47
-
* directory structure inside your project test directory must mirror project root directory for tests to be found
48
-
49
-
**Default configuration is deprecated**, from version **2.0.0** and up you **will** have to specify a config file.
50
-
51
-
### Custom configuration
52
-
You can define your own custom configuration by creating a configuration file. By default, ```argus``` looks for the configuration file named ```argus.config.js``` in the directory in which it is run, but you can specify a different location via ```-c``` console parameter, for example ```argus -c ../my.custom.argus.config.js```.
44
+
You must configure argus-test-runner by creating a configuration file. By default, ```argus``` looks for the configuration file named ```argus.config.js``` in the directory in which it is run, but you can specify a different location via ```-c``` console parameter, for example ```argus -c ../my.custom.argus.config.js```.
53
45
Configuration files are written in *Javascript*.
54
46
55
47
### Configuration file examples:
@@ -66,8 +58,7 @@ module.exports = {
66
58
// Test directory mirrors your source directory structure
0 commit comments