zloirock/core-js

[types] documenting features as typescript

Open

#1,064 建立於 2022年3月25日

在 GitHub 查看
 (8 留言) (0 反應) (0 負責人)JavaScript (23,771 star) (1,609 fork)batch import
docshelp wanted

描述

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!

貢獻者指南

技術棧
javascripttypescript
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic JavaScriptTypeScript syntax
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
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.