package.json

{
	"name": "obs-stream-sync",
	"version": "0.4.0",
	"description": "A Node.js app that reads QR codes off livestreams, and sets delays accordingly.",
	"main": "dist/src/index.js",
	"//": "'bin' is used with pkg",
	"bin": "dist/src/index.js",
	"author": "some1chan",
	"license": "MIT",
	"private": "true",
	"scripts": {
		"//00": "",
		"//01": "This project is commitizen friendly!",
		"//02": "Use `pnpm cz` for formatting your commits.",
		"//03": "",
		"commit": "cz",
		"//04": "Run the test for this project.",
		"test": "ava",
		"test:watch": "ava --watch",
		"//05": "",
		"//06": "Build helpers, including commands to build an executable.",
		"//07": "To make an executable, run `pnpm build` first, then run `pnpm build:pkg`",
		"//08": "",
		"build": "tsc --build",
		"build:watch": "tsc --build --watch",
		"build:pkg-dev": "pnpm exec pkg -o ./obs-stream-sync -t node18-win-x64 package.json",
		"build:pkg": "pnpm exec pkg -C GZip -o ./dist/obs-stream-sync package.json",
		"//09": "",
		"//10": "Run the application after running the build command.",
		"//11": "Alternatively, use `pnpm dev` instead.",
		"//12": "",
		"start": "node dist/src/index.js",
		"//13": "",
		"//14": "The preferred way to develop and run the application,",
		"//15": "if the application isn't made into an executable.",
		"//16": "`dev:start` is included for testing with terminal interactivity.",
		"//17": "",
		"dev": "cross-env NODE_ENV=development tsnd --trace-warnings --respawn --transpile-only -- ./src/index.ts",
		"dev:start": "nodemon -I dist/src/index.js"
	},
	"ava": {
		"extensions": [
			"ts"
		],
		"environmentVariables": {
			"TS_NODE_LOG_ERROR": "false"
		},
		"require": [
			"ts-node/register"
		]
	},
	"pkg": {
		"assets": [
			"assets/**/*",
			"package.json"
		],
		"targets": [
			"node18-win-x64",
			"node18-linuxstatic-x64",
			"node18-macos-x64"
		]
	},
	"devDependenciesComments": {
		"@changesets/cli": "Pushing out versioning",
		"@types/common-tags": "Types for proper TypeScript integration",
		"@types/node": "Node.js types so built-in packages from Node.js won't complain",
		"ava": "Handles testing",
		"commitizen": "Commit formatting with `pnpm cz`",
		"cross-env": "Sets NODE_ENV on all platforms correctly on `pnpm dev`",
		"nodemon": "Used for debugging weird behavior with interactive CLI",
		"pkg": "Creates an executable",
		"ts-node": "Testing with .ts files for ava",
		"ts-node-dev": "Used for `pnpm dev` for testing",
		"typescript": "Explicit types in scripts"
	},
	"devDependencies": {
		"@changesets/cli": "^2.26.2",
		"@types/common-tags": "^1.8.1",
		"@types/node": "^18.17.4",
		"ava": "^5.3.1",
		"commitizen": "^4.3.0",
		"cross-env": "^7.0.3",
		"cz-conventional-changelog": "^3.3.0",
		"nodemon": "^2.0.22",
		"pkg": "^5.8.1",
		"ts-node": "^10.9.1",
		"ts-node-dev": "^2.0.0",
		"typescript": "^5.1.6"
	},
	"dependenciesComments": {
		"ansi-colors": "Fancy colors in the terminal",
		"common-tags": "For writing strings that won't go over the 80 character limit, like this string here",
		"compare-versions": "Version checking for OBS Websocket",
		"configparser": "configparser from Python, used for config.ini",
		"dayjs": "Screenshot string parsing",
		"enquirer": "Interactive command-line input",
		"jimp": "Image processor",
		"jsqr": "QR Code reader",
		"mathjs": "Math expressions when inputting math expressions",
		"obs-websocket-js": "Connects and controls OBS"
	},
	"dependencies": {
		"ansi-colors": "^4.1.3",
		"common-tags": "^1.8.2",
		"compare-versions": "6.0.0-rc.1",
		"configparser": "^0.3.10",
		"dayjs": "^1.11.9",
		"enquirer": "^2.4.1",
		"jimp": "^0.17.10",
		"jsqr": "^1.4.0",
		"mathjs": "^11.9.1",
		"obs-websocket-js": "^5.0.3"
	},
	"engines": {
		"//0": ">17 required for interactivity",
		"node": ">17",
		"//1": "Repo is currently v8, (non-p)npm won't work.",
		"pnpm": ">=8"
	},
	"config": {
		"commitizen": {
			"path": "./node_modules/cz-conventional-changelog"
		}
	}
}