Skip to content

Commit 761b292

Browse files
committed
chore: improved docs
1 parent 25bb031 commit 761b292

File tree

3 files changed

+28
-3
lines changed

3 files changed

+28
-3
lines changed

cli/Dockerfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
FROM node:latest
2+
3+
RUN npm i -g smelly-cli -y
4+
5+
CMD ["smelly-cli"]

cli/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,34 @@
77
Smelly is a command line tool application that helps javascript/typescript developers to keep their test
88
suite away from test smells.
99

10+
## Installation
11+
12+
### docker
13+
14+
```sh
15+
g clone https://github.com/marabesi/smelly-test.git
16+
cd smelly-test/cli
17+
docker build . -t smelly-cli
18+
```
19+
20+
Running the report
21+
22+
```sh
23+
docker run --rm smelly-cli
24+
```
25+
1026
## Command Line Interface
1127

1228
Single file
1329

1430
```sh
15-
npm run cli -- path/to/file/test.js typescript
31+
npx smelly-cli /smells/my-test.ts typescript
1632
```
1733

1834
Report
1935

2036
```sh
21-
npm run cli -- path/to/file/test.js typescript --report=html
37+
npx smelly-cli /smells/ javascript --report=html $(pwd)
2238
```
2339

2440
## Resources

detector/CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
- https://github.com/mochajs/mocha-examples/tree/main/packages/typescript
1+
- https://github.com/mochajs/mocha-examples/tree/main/packages/typescript
2+
3+
## resources
4+
5+
- https://stackoverflow.com/questions/77319559/properly-exporting-types-in-npm-package

0 commit comments

Comments
 (0)