Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide TypeScript config for minimum common API #31

Open
ytxmobile98 opened this issue Nov 4, 2022 · 0 comments
Open

Provide TypeScript config for minimum common API #31

ytxmobile98 opened this issue Nov 4, 2022 · 0 comments

Comments

@ytxmobile98
Copy link

ytxmobile98 commented Nov 4, 2022

My company is looking for integrating WinterCG common minimum API into TypeScript config, in order to provide type checking, error highlighting, autocomplete, etc.

1. TypeScript base config

Developers may be able to write something like this in tsconfig.json:

{
  "extends": "@tsconfig/wintercg/tsconfig.json"
}

This tsconfig should at least support the common minimum APIs which are listed in https://blog.cloudflare.com/introducing-the-wintercg/ and https://common-min-api.proposal.wintercg.org/.

Install the wintercg tsconfig:

npm install --save-dev @tsconfig/wintercg
yarn add --dev @tsconfig/wintercg

2. lib

Provide WinterCG common minimum API access in the lib configuration. For example: lib can be set to WinterCG.

Screenshot from 2022-11-04 16-59-36

@ytxmobile98 ytxmobile98 changed the title [Proposal] Provide TypeScript config for minimum common API Provide TypeScript config for minimum common API Nov 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant