Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V3.8.0 #302

Merged
merged 26 commits into from
Dec 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
740048a
Update to Node 22.8.0
thedist Dec 9, 2024
00b200e
v3.8.0 update to Node 22.8.0
thedist Dec 9, 2024
d54bc7b
Chore: Variable restructure
thedist Dec 16, 2024
226ba94
Fix: missing actions and action upgrade
thedist Dec 17, 2024
b5a7c60
Chore: lint
thedist Dec 17, 2024
b26b971
Chore: restructured some variables
thedist Dec 18, 2024
59a15f5
Fix: Removed duplicate action and fixed upgrade script
thedist Dec 19, 2024
b499bf8
Testint Jest workflow
thedist Dec 21, 2024
8d68bd1
Test updating lockfile
thedist Dec 21, 2024
232fdf5
testing string-width resolution
thedist Dec 21, 2024
d4204aa
Removed workflow testing
thedist Dec 21, 2024
03275e5
v3.8.0 patch notes
thedist Dec 22, 2024
1c247a1
Update to Node 22.8.0
thedist Dec 9, 2024
c7b0fbc
v3.8.0 update to Node 22.8.0
thedist Dec 9, 2024
3187d1a
Chore: Variable restructure
thedist Dec 16, 2024
8ca67b1
Fix: missing actions and action upgrade
thedist Dec 17, 2024
4fe9222
Chore: lint
thedist Dec 17, 2024
2f5ac13
Chore: restructured some variables
thedist Dec 18, 2024
19dd662
Fix: Removed duplicate action and fixed upgrade script
thedist Dec 19, 2024
5a3e863
Testint Jest workflow
thedist Dec 21, 2024
9df69f6
Test updating lockfile
thedist Dec 21, 2024
81bcb11
testing string-width resolution
thedist Dec 21, 2024
77aa50a
Removed workflow testing
thedist Dec 21, 2024
df9a59a
v3.8.0 patch notes
thedist Dec 22, 2024
98e5e95
Merge branch 'v3.8.0' of https://github.com/bitfocus/companion-module…
thedist Dec 22, 2024
31cbc47
Fix: updated runtime in companion.js
thedist Dec 22, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
"@typescript-eslint/camelcase": "off",
"@typescript-eslint/ban-ts-ignore": "off",
"@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/no-explicit-any": "off"
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-unused-expressions": "off"
}
},
{
Expand Down
7 changes: 1 addition & 6 deletions .github/workflows/node.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
strategy:
fail-fast: false
matrix:
node-version: [18.x]
node-version: [22.8.x]

steps:
- uses: actions/checkout@v4
Expand All @@ -26,11 +26,6 @@ jobs:
yarn install
env:
CI: true
- name: Test jest
run: |
yarn test
env:
CI: true
- name: Test tsc
run: |
yarn build
Expand Down
5 changes: 3 additions & 2 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"printWidth": 120,
"printWidth": 180,
"semi": false,
"singleQuote": true
"singleQuote": true,
"trailingComma": "none"
}
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ This module now supports Companions HTTP API, providing endpoints that can be us


# Recent Patches
**v3.8.0**
- Updated module to Node.JS 22.8.0 and rebuilt dependencies
- Refactored module structure
- Removed duplicate Position action

**v3.7.1**
- Fixed typo in stream 4 and 5 variable definitions
- Better handling of vMix's undocumented XML processing instructions added to the XML API
Expand Down
2 changes: 1 addition & 1 deletion companion/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
],
"legacyIds": [],
"runtime": {
"type": "node18",
"type": "node22",
"api": "nodejs-ipc",
"apiVersion": "0.0.0",
"entrypoint": "..\\dist\\index.js"
Expand Down
18 changes: 0 additions & 18 deletions docs/HTTP_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,24 +45,6 @@ Only 1, or none, of:
| title | "" | Input Short Title, or Title |


<br>

## Get Timers
Returns an array of current timers
<br>GET /instance/LABEL/timers

### Required Query Parameters
None

### Optional Query Parameters
| Param | Default | Description |
| ----------- | --------- | ----------- |
| default | "" | Value to be returned for times/laps in-progess |
| format | mm:ss.ms | Time format, hh:mm:ss, hh:mm:ss.ms, mm:ss, mm:ss.ms, mm:ss.sss, or auto |
| lap_progress | current | Show current lap time for "current" lap, "all" laps, or "none" |
| times | 1 | Minimum number of times/laps to return |


<br>

## Get Transitions
Expand Down
5 changes: 5 additions & 0 deletions docs/PATCH_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Patch Notes

**v3.8.0**
- Updated module to Node.JS 22.8.0 and rebuilt dependencies
- Refactored module structure
- Removed duplicate Position action

**v3.7.1**
- Fixed typo in stream 4 and 5 variable definitions
- Better handling of vMix's undocumented XML processing instructions added to the XML API
Expand Down
23 changes: 23 additions & 0 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { generateEslintConfig } from '@companion-module/tools/eslint/config.mjs'

const baseConfig = await generateEslintConfig({
enableTypescript: true,
ignores: ['**/tests/*']
})

const customConfig = [
...baseConfig,

{
rules: {
'@typescript-eslint/no-unsafe-enum-comparison': 'off',
// misconfiguration of ts or something?
'n/no-missing-import': 'off',
// 'm/no-unpublished-import': 'off',
'@typescript-eslint/no-unused-expressions': 'off',
'@typescript-eslint/no-floating-promises': 'off'
}
}
]

export default customConfig
2 changes: 1 addition & 1 deletion jest.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module.exports = {
preset: 'ts-jest',
testEnvironment: 'node'
};
}
52 changes: 28 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "studiocoast-vmix",
"version": "3.7.0",
"version": "3.8.0",
"main": "dist/index.js",
"scripts": {
"dev": "yarn build:watch",
"build": "rimraf dist && yarn build:main",
"build:main": "tsc -p tsconfig.build.json",
"build:watch": "tsc -p tsconfig.build.json --watch",
"build:test": "tsc -p tsconfig.build.json --noEmit",
"lint": "eslint . --ext .ts --fix",
"lint:test": "eslint . --ext .ts",
"lint": "eslint --fix",
"lint:test": "eslint",
"test": "jest"
},
"repository": {
Expand All @@ -26,33 +26,37 @@
"git add"
]
},
"eslintIgnore": [
"/tests/*.test.ts"
],
"license": "MIT",
"engines": {
"node": "^22.8"
},
"dependencies": {
"@companion-module/base": "~1.8.0",
"@companion-module/base": "~1.11.1",
"companion-module-utils": "^0.4.0",
"lodash": "~4.17.21",
"xml2js": "~0.5.0"
"xml2js": "~0.6.2"
},
"devDependencies": {
"@companion-module/tools": "~1.4.1",
"@types/jest": "^29.5.12",
"@types/lodash": "~4.14.190",
"@types/node": "~18.13.0",
"@types/xml2js": "~0.4.11",
"@typescript-eslint/eslint-plugin": "~5.51.0",
"@typescript-eslint/parser": "~5.51.0",
"eslint": "~8.33.0",
"eslint-config-prettier": "~8.6.0",
"eslint-plugin-prettier": "~4.2.1",
"husky": "~8.0.3",
"@companion-module/tools": "^2.1.0",
"@eslint/eslintrc": "^3.2.0",
"@eslint/js": "^9.15.0",
"@types/jest": "29.5.14",
"@types/lodash": "4.17.13",
"@types/node": "22.9.0",
"@types/xml2js": "0.4.14",
"@typescript-eslint/eslint-plugin": "^8.14.0",
"@typescript-eslint/parser": "^8.14.0",
"eslint": "^9.10.0",
"eslint-config-prettier": "9.1.0",
"eslint-plugin-prettier": "5.2.1",
"globals": "^15.12.0",
"husky": "9.1.6",
"jest": "^29.7.0",
"lint-staged": "~13.1.1",
"prettier": "~2.8.4",
"rimraf": "~3.0.2",
"ts-jest": "^29.1.2",
"typescript": "~4.9.5"
"lint-staged": "15.2.10",
"prettier": "3.3.3",
"rimraf": "6.0.1",
"ts-jest": "29.2.5",
"typescript": "5.6.3",
"typescript-eslint": "^8.14.0"
}
}
Loading
Loading