PrismarineJS / PrismarineJS/node-minecraft-data

Lack of strongly typed typescript support

Open
#453 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
127
Forks
76
Avg merge
7m
Merged PRs (30d)
3

Description

title says it, was trying to make a simple program using node-minecraft-protocol when I realised there wasn't any strong type saftey for packets
typings/index-template.d.ts only contains some typings

Currently working on script to automatically parse the JSON from minecraft-data and convert them into typescript types https://github.com/T768D/node-minecraft-data-with-types/tree/master/types/pc

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with typings/index-template.d.ts and inspect the minecraft-data JSON consumed by the proposed generator in the linked types repository. Compare the generated TypeScript types with the packet usage in node-minecraft-protocol. Done means packet typings provide strong type safety across the supported data without requiring manual updates.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.