guardian / guardian/support-dotcom-components

Sharing types with other repositories

Open
#367 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
1
Forks
2
Avg merge
3d 10h
Merged PRs (30d)
24

Description

We've been using `automat-client` in DCR. Over time it appears there's been a drift between the 'canonical' types here (in `support-dotcom-components`) and the types there (in `automat-client`) - for example the [`Targeting`](https://github.com/guardian/automat-client/blob/master/types.ts) type in `Metadata` (used for the ReaderRevenueEpic in DCR) doesn't include the required `hasOptedOutOfArticleCount` property, which means we have had to add a workaround in DCR where `automat-client` is consumed.

We felt that, rather than maintaining the types in two places, the types here in `support-dotcom-components` should be shared via a mechanism like an NPM package, and ingested by the other repositories.

Does this sound sensible?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.