Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Add completion info previews to autocomplete suggestions

オープン
#4,174 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 3 日以内に返信

@yashgoyal0110 がすでに取り組んでいます。

2026年6月30日 から。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
javascript
領域
frontend

調査の方向性

実装ファイルやテストは指定されていません。まず、エディターの CodeMirror autocomplete 統合をたどり、Info Pane が選択された候補をどのように処理するかを読みます。選択した補完によって提案されたキーボード操作付きのドキュメントプレビューが開き、Escape で閉じられ、Enter で挿入を壊さずに参照先を新しいタブで開けるようになれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Awaiting Maintainer Approval Feature Request
Increasing Access

this feature would make the p5.js api more discoverable for beginners and learners by providing contextual documentation directly within the editor. users could quickly understand what a function does without needing to leave the editor and search the reference site, reducing context switching.

Feature request details

currently, autocomplete suggestions display function names and signatures, but provide little information about what the selected item actually does. users often need to open the p5.js reference in a separate tab to understand unfamiliar functions.

i propose adding completion info previews to autocomplete suggestions.

proposed workflow:

  1. start typing and autocomplete suggestions appear.
  2. navigate suggestions using the keyboard.
  3. when a suggestion is selected, pressing the right arrow key opens a documentation preview.
  4. esc closes the preview.
  5. or pressing enter opens the reference in new tab.
  6. tab or enter inserts the selected completion as usual.

why this approach

  • encourages beginners to learn the api while writing code.
  • reduces the need to switch between the editor and reference site.
  • builds on existing keyboard navigation patterns.
  • whole long documentation maybe intimidating for beginners.

design mockups:

Image Image Image

additional notes

codemirror allows to show completion info through an "Info Pane" that displays extra details when a suggestion is selected.

主要言語
JavaScript
スター
1.7k
フォーク
1.7k
平均マージ
3日 18時間
マージ済み PR(30日)
7

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

processing/p5.js-web-editor のほかの issue

processing/p5.js-web-editor の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。