zloirock/core-js

[types] documenting features as typescript

Open

#1,064 opened on Mar 25, 2022

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (23,771 stars) (1,609 forks)batch import
docshelp wanted

Description

Hi!

Context: in the README's features, there are block codes used to shown what's included in a feature (ex: https://github.com/zloirock/core-js/blob/v3.21.1/README.md#new-collections-methods). These blocks look a lot like typescript type declarations, but aren't.

First: shouldn't these blocks be tagged as typescript instead of javascript (sed /```js/```ts/g), so we can have proper syntax coloration?

Second: as a stepping point to #568, we could make these blocks correct typescript, so TS users can copy/paste them safely in their codebase when importing the polyfills (especially proposals).

If that's interesting, I could probably start a PR on that!

Contributor guide

Tech stack
javascripttypescript
Domain
documentation
Issue type
documentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic JavaScriptTypeScript syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes updating the README.md file (https://github.com/zloirock/core js/blob/v3.21.1/README.md) to change code block language tags from `js` to `ts` for proper syntax highlighting, and to make the type declarations valid TypeScript so users can copy/paste them. This is a stepping stone towards issue #568. The work involves finding all relevant code blocks in the README, updating the fences, and ensuring the TypeScript type declarations are correct. There are no linked PRs or maintainer comments to consider.
[types] documenting features as typescript · zloirock/core-js#1064 | Good First Issue