dice-roller/rpg-dice-roller

Issues with module's types

Open

#247 opened on Apr 1, 2022

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)JavaScript (68 forks)auto 404
bughelp wanted

Repository metrics

Stars
 (279 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the bug Some of the type definitions seems to be faulty or incomplete.

To Reproduce Steps to reproduce the behaviour:

  1. Bootstrap a new typescript project with the defaults (npm i typescript --save-dev && npx tsc --init)
  2. Install the module via npm (npm install @dice-roller/rpg-dice-roller)
  3. Create an example file index.ts (see below)
  4. Set skipLibCheck to false in tsconfig.json
  5. Run tsc to build the project

Expected behaviour No type errors show up.

Code snippet

import { DiceRoll } from "@dice-roller/rpg-dice-roller"

const roller = new DiceRoll("6d6")

console.log(roller.toString())

Environment:

  • Node.js 17.3.0 on Windows 10 & Node.js 16.14.2 on Ubuntu 20.04.4 installed from nodesource
  • Module version 5.1.0, 5.0.0 has the same behaviour

Contributor guide

Research direction
Inspect the type definition files (likely in a 'types' folder or within the package) to identify missing exports or incorrect type annotations. Compare with the actual JavaScript exports.
Tech stack
typescriptjavascriptnodejs
Domain
developer experienceapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70