Skip to content

Commit 4863442

Browse files
committed
Make compatible with obs-websocket v5
1 parent 8f57d1d commit 4863442

24 files changed

+12230
-6812
lines changed

.eslintignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dist
2+
samples
3+
# until re-enabled later
4+
scripts/build-types-v2.ts

.eslintrc.cjs

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
/** @type {import('eslint').Linter.Config} */
22
module.exports = {
3-
"extends": [
4-
"xo",
5-
"xo-typescript"
3+
extends: [
4+
'xo',
5+
'xo-typescript',
66
],
77
parserOptions: {
8-
project: './tsconfig.eslint.json'
9-
}
10-
}
8+
project: './tsconfig.eslint.json',
9+
extraFileExtensions: ['.cjs'],
10+
},
11+
overrides: [
12+
{
13+
files: ['test/**/*.{js,ts}'],
14+
extends: [
15+
'plugin:ava/recommended',
16+
],
17+
},
18+
],
19+
};

.github/workflows/build.yml

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ on:
1111

1212
jobs:
1313
build:
14-
14+
name: Node ${{ matrix.node-version }}
1515
runs-on: ubuntu-latest
1616

1717
strategy:
@@ -25,12 +25,7 @@ jobs:
2525
uses: actions/setup-node@v2
2626
with:
2727
node-version: ${{ matrix.node-version }}
28-
- uses: actions/cache@v2
29-
with:
30-
path: ~/.npm
31-
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
32-
restore-keys: |
33-
${{ runner.os }}-node-
28+
cache: 'npm'
3429
- run: npm ci
3530
- run: npm run build
3631
env:

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ OBSWebSocket.JS allows Javascript-based connections to the Open Broadcaster plug
1212
<p align="center">
1313
<a href="https://travis-ci.com/haganbmj/obs-websocket-js"><img src="https://img.shields.io/travis/haganbmj/obs-websocket-js/master.svg?style=flat"></a>
1414
<a href="https://coveralls.io/github/haganbmj/obs-websocket-js?branch=master"><img src="https://coveralls.io/repos/github/haganbmj/obs-websocket-js/badge.svg?branch=master"></a>
15-
<a href="https://libraries.io/bower/obs-websocket-js"><img src="https://img.shields.io/bower/v/obs-websocket-js.svg?style=flat"></a>
1615
<a href="https://www.npmjs.com/package/obs-websocket-js"><img src="https://img.shields.io/npm/v/obs-websocket-js.svg?style=flat"></a>
1716
<a href="https://www.npmjs.com/package/obs-websocket-js"><img src="https://img.shields.io/npm/dt/obs-websocket-js.svg"></a>
1817
<img src="https://img.shields.io/npm/l/obs-websocket-js.svg">
@@ -35,16 +34,13 @@ You are currently reading the documentation for upcoming v5. [For v4 documentati
3534

3635
```sh
3736
# with npm
38-
npm install obs-websocket-js --save
37+
npm install obs-websocket-js
3938

4039
# with yarn
4140
yarn add obs-websocket-js
42-
43-
# with bower
44-
bower install obs-websocket-js --save
4541
```
4642

47-
Typescript definitions are included in this package, and are automatically generated to match the latest `obs-websocket` release.
43+
Typescript definitions are included in this package, and are made to match the latest `obs-websocket` release.
4844

4945
## Usage
5046
#### Instantiation

0 commit comments

Comments
 (0)