shouldjs/should.js

Typings for custom assertions

Open

#174 opened on May 2, 2018

View on GitHub
 (2 comments) (0 reactions) (1 assignee)JavaScript (131 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (1,906 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi.

Node.js version?

8.11.1

Should.js version?

13.2.1

How to reproduce it?

When using shouldjs with Typescript and extending the should Assertions with a custom function: Lets say:

Assertion.add('asset', function() {
     this.params = { operator: 'to be asset' }

     this.obj.should.have.property('id').which.is.a.Number()
     this.obj.should.have.property('path')
})

Compiling Typescript will throw an error when using the should(obj).asset() function because it doesn't exist on the type Assertion. Simplest solution would by adding the following to the Assertion interface to allow dynamic properties:

[key: string]: any;

Contributor guide

Research direction
Locate the TypeScript declaration file for should.js (e.g., should.d.ts). Find the Assertion interface and add an index signature `[key: string]: any` to allow custom assertion methods. Verify by creating a custom assertion using `Assertion.add` and ensure TypeScript compilation succeeds.
Tech stack
javascripttypescript
Domain
testing
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60