Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Extract nodecg typings into a separate npm package #239

Closed
@hlxid

Description

@hlxid

Description

For all NodeCG related bundles that are written in TypeScript we need typings to e.g. create replicants or send messages without type errors.

Currently we get the typings from the official NodeCG package which includes them in the /types subdirectory.
This works fine but adding NodeCG as a dependency to all packages results in very bloated node_modules because it has many dependencies that are unused by us. Also these dependencies are often outdated.

There's already a issue on the NodeCG repository about this: nodecg/nodecg#552 meaning we propably will have a proper solution with NodeCG 2.0

As a temporary (and pretty simple) workaround to this problem I'm thinking about republishing the /types directory of NodeCG. NodeCG is MIT licensed so we are allowed to do that. This package would be a drop-in replacement for all bundles that import typings from the official package because they are the same but it wouldn't include the rest of nodecg and therefore would also have no dependencies at all.

However I'm not 100% sure yet if I want to do this and how I would name the package.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestminorQuick to implement

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions