@@ -5,9 +5,9 @@ Other package managers may work but are not officially supported for development
5
5
6
6
To set up the repository, run:
7
7
8
- ``` bash
9
- yarn
10
- yarn build
8
+ ``` sh
9
+ $ yarn
10
+ $ yarn build
11
11
```
12
12
13
13
This will install all the required dependencies and build output files to ` dist/ ` .
@@ -22,7 +22,7 @@ modify the contents of the `src/lib/` and `examples/` directories.
22
22
23
23
All files in the ` examples/ ` directory are not modified by the generator and can be freely edited or added to.
24
24
25
- ``` bash
25
+ ``` ts
26
26
// add an example to examples/<your-example>.ts
27
27
28
28
#! / usr / bin / env - S npm run tsn - T
@@ -41,38 +41,38 @@ If you’d like to use the repository from source, you can either install from g
41
41
42
42
To install via git:
43
43
44
- ``` bash
45
- npm install git+ssh://
[email protected] :muxinc/mux-node-sdk.git
44
+ ``` sh
45
+ $ npm install git+ssh://
[email protected] :muxinc/mux-node-sdk.git
46
46
```
47
47
48
48
Alternatively, to link a local copy of the repo:
49
49
50
- ``` bash
50
+ ``` sh
51
51
# Clone
52
- git clone https://www.github.com/muxinc/mux-node-sdk
53
- cd mux-node-sdk
52
+ $ git clone https://www.github.com/muxinc/mux-node-sdk
53
+ $ cd mux-node-sdk
54
54
55
55
# With yarn
56
- yarn link
57
- cd ../my-package
58
- yarn link @mux/mux-node
56
+ $ yarn link
57
+ $ cd ../my-package
58
+ $ yarn link @mux/mux-node
59
59
60
60
# With pnpm
61
- pnpm link --global
62
- cd ../my-package
63
- pnpm link -—global @mux/mux-node
61
+ $ pnpm link --global
62
+ $ cd ../my-package
63
+ $ pnpm link -—global @mux/mux-node
64
64
```
65
65
66
66
## Running tests
67
67
68
68
Most tests require you to [ set up a mock server] ( https://github.com/stoplightio/prism ) against the OpenAPI spec to run the tests.
69
69
70
- ``` bash
71
- npx prism mock path/to/your/openapi.yml
70
+ ``` sh
71
+ $ npx prism mock path/to/your/openapi.yml
72
72
```
73
73
74
- ``` bash
75
- yarn run test
74
+ ``` sh
75
+ $ yarn run test
76
76
```
77
77
78
78
## Linting and formatting
@@ -82,14 +82,14 @@ This repository uses [prettier](https://www.npmjs.com/package/prettier) and
82
82
83
83
To lint:
84
84
85
- ``` bash
86
- yarn lint
85
+ ``` sh
86
+ $ yarn lint
87
87
```
88
88
89
89
To format and fix all lint issues automatically:
90
90
91
- ``` bash
92
- yarn fix
91
+ ``` sh
92
+ $ yarn fix
93
93
```
94
94
95
95
## Publishing and releases
0 commit comments