processing / processing/p5.js-web-editor
Improved Autocomplete Hinter
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 8
Description
Increasing Access
This would make it easier to code in the p5.js editor, lessen the irritation of typos for beginners, as well as improving the quality of life for developers in general. This is because the current Autocomplete Hinter doesn't hint at variables, functions, or classes created by the user, and mostly just serves as (and this is a personal belief) a worse version of the p5.js documentation that clogs up the screen by covering code, and that doesn't show examples or explain how a function works.
Feature enhancement details
- Add autocomplete hints for variables, functions, and classes
- Add an option to access the documentation for interacting with code belonging to p5.js
- Add an option to jump to the variable, function, or class when interacting with code belonging to the sketch itself
- Maybe try something like ace.js's approach (here are some links talking about ace.js's autocomplete)
a. https://github.com/ajaxorg/ace/blob/e59ae67d1c348ea6cb6b2b112b4a504a09fabfba/src/autocomplete.js#L68
b. https://stackoverflow.com/questions/13545433/autocompletion-in-ace-editor - Here's the previous issue mentioning adding the Autocomplete Hinter and which resulted in the addition of the current hinter: https://github.com/processing/p5.js-web-editor/issues/99
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the current Autocomplete Hinter in the p5.js Editor and review the prior issue #99, then compare the proposed approach with the linked Ace.js autocomplete references. Done should include hints for sketch variables, functions, and classes, documentation access for p5.js code, and navigation to sketch-defined symbols.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- developer-experience, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100