Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

feature: /json-to-jsdoc

未关闭
#1 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
css, html, javascript
领域
frontend

调研方向

未指定文件、测试或入口点。首先定位独立工具的 JavaScript 转换代码和 HTML textarea UI,然后将实现与所请求的中间类型、enum 处理、字母顺序以及 CSS 变量进行比较;完成的标准是列出的 JSON 和 enum 示例能够生成预期的 JSDoc 输出。

由索引模型根据 Issue 内容生成。

描述

good first issue hacktoberfest

The Big Idea

I'd like to host a standalone online tool like https://transform.tools/json-to-jsdoc, but that will break down intermediary types, and also handle enums.

  • JavaScript conversion function (no frameworks or libraries)
    • JSON.stringify(input, null, 2) to prettify JSON
    • Traverses JSON to produce JSDoc
    • Checkbox for "treat arrays as enums"
    • Order types alphabetically
    • "" is type String
    • "a|b|c" creates a typedef MyTypeStatusEnum ?
  • HTML Textareas
    • CSS with variables (see MVP.css)

Example Output: JSON

/** @typedef {object} json
 * @property {object} about
 * @property {string} about.legalBusinessName
 * @property {string} about.website
 * @property {string} about.industry
 * @property {string} about.countryOfOperation
 * @property {string} about.description
 * @property {string} about.operations
 */

should instead be

/** 
 * @typedef MyType
 * @prop {MyTypeAbout} about
 */

/**
  * @typedef MyTypeAbout
  * @prop {String} legalBusinessName
  * @prop {String} website
  * @prop {String} industry
  * @prop {String} countryOfOperation
  * @prop {String} description
  * @prop {String} operations
  */

Example Output: Enums

Maybe any props that are all caps and assigned an array could be considered enums?

/**
 * @typedef {"IsPep"|"IsNotPep"} PepOption
 */
Mercury.POLITICALLY_EXPOSED_OPTIONS = ["IsPep", "IsNotPep"];
主要语言
JavaScript
星标
0
派生
0
PR 合并指标
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。