guardian/dotcom-rendering

Remove `index.d.ts`

Open

#7,638 opened on Apr 26, 2023

View on GitHubContributor guide
 (3 comments) (1 reaction) (1 assignee)TypeScript (35 forks)auto 404
Pick me upTeam Candidate: WebXgood first issue

Repository metrics

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

Description

Why?

Declaration files create ambient types, which appear in a global namespace across the project. We think it's preferable to avoid adding types to a global scope, and instead prefer to import them as needed.

How?

Migrate the types in the index.d.ts1 file into normal .ts files, and import them as needed:

Footnotes

  1. https://github.com/guardian/dotcom-rendering/blob/4ea272b55efa01ba88f0f5ff60f6bc9d14198147/dotcom-rendering/index.d.ts ↩

Contributor guide

Research direction
Identify all types in index.d.ts and move them into separate .ts files, then import them where needed.
Tech stack
typescript
Domain
frontend
Issue type
Refactor
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.
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75