Skip to content

Commit f9e528d

Browse files
authored
Create TOOLS.md
1 parent 036f808 commit f9e528d

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

TOOLS.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# List of tools used throughout the project
2+
3+
### npm
4+
Used for dependency management
5+
6+
#### Common commands
7+
8+
`NEOCTRL_ARGS="-e 4.0" npm test`
9+
10+
`NEOCTRL_ARGS="-e 4.0" npm run start-neo4j`
11+
12+
`NEOCTRL_ARGS="-e 4.0" npm run stop-neo4j`
13+
14+
### gulp
15+
Used for build system
16+
17+
The following commands run tests directly from the source tree compared to `npm test` which runs them in a sandboxed environment.
18+
19+
`NEOCTRL_ARGS="-e 4.0" gulp test-nodejs-unit`
20+
21+
`NEOCTRL_ARGS="-e 4.0" gulp test-nodejs-integration`
22+
23+
`NEOCTRL_ARGS="-e 4.0" gulp test-nodejs-stub`
24+
25+
### jasmine
26+
Used as the testing and assertion framework
27+
28+
`jasmine --filter="#unit Test"` for more fine grained test filtering. This only applies to node environment tests.
29+
30+
### karma
31+
Used for running tests in real browsers
32+
33+
`gulp test-browser`
34+
35+
### istanbul & nyc
36+
Used for code coverage
37+
38+
`nyc jasmine --filter="#unit"` cover unit tests
39+
40+
### eslint
41+
For linting
42+
43+
### prettier-eslint
44+
For code styling
45+
46+
### husky
47+
For github pre-commit hooks for code styling
48+

0 commit comments

Comments
 (0)