Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better JSDoc types #7969

Open
wants to merge 60 commits into
base: master
Choose a base branch
from
Open

Better JSDoc types #7969

wants to merge 60 commits into from

Conversation

mybearworld
Copy link
Contributor

Resolves #6488
Closes ScratchAddons/website-v2#337
Part of #6721

Changes

Improved the JSDoc types and grammar, and also added the JSDoc types to every addon.

Reason for changes

Better DX.

Tests

Tested in VSCode - browser testing isn't really applicable here

mybearworld and others added 30 commits October 1, 2023 10:04
@mybearworld
Better JSDoc types
4b9f841
@mybearworld @actions-user
Format code
9ffe82f
@mybearworld
"React's internal key" -> "Reacts internal key"
472db50
@mybearworld
Merge branch 'jsdoc' of https://github.com/mybearworld/fork-scratchad…
e000bb0 
…dons into jsdoc
@mybearworld
Use shorter type syntax
d58ffa8
@mybearworld @actions-user
Format code
c25ce05
@mybearworld
"Reacts internal key" -> "React's internal key"
8579db3 
(...)
@mybearworld
Merge branch 'jsdoc' of https://github.com/mybearworld/fork-scratchad…
668bd61 
…dons into jsdoc
@mybearworld
library's directory -> \libraries\`` directory
4b84a95
@mybearworld
Change getEnabledAddons()
16f05e4
@mybearworld
Do some more formatting
c49b007
@mybearworld
Get rid of dash
f377b27
@mybearworld
Capitalize
283f5a3
@mybearworld
Do Popup.js
17b6ca6
@mybearworld
Remove @extend
88e4c8a
@mybearworld
Merge branch 'ScratchAddons:master' into jsdoc
2817918
@mybearworld
Update for new addons
103b0c7
@mybearworld @actions-user
Format code
604f678
@mybearworld
Use name "addonAPI" instead of "types"
a19c5cf
@mybearworld
Merge branch 'jsdoc' of https://github.com/mybearworld/fork-ScratchAd…
f79b8dd 
…dons into jsdoc
@mybearworld
Also add type to user-id
d1243b9
@mybearworld
Merge branch 'master' into jsdoc
e9e8940
@mybearworld
Add types to dark-www/profile.js
70c6235
@mybearworld
Remove unnecessary prettier-ignore
3a821a0
@mybearworld
Put type AddonAPI in global scope
755382e
@mybearworld @actions-user
Format code
b206d54
@mybearworld
Add JSDoc comment to AddonAPI in env.d.ts
9d6678b
@mybearworld
Merge branch 'jsdoc' of https://github.com/mybearworld/fork-ScratchAd…
dd5620f 
…dons into jsdoc
@mybearworld
Mark placeholders in msg function as optional
5810924
@mybearworld
Revert "Put type AddonAPI in global scope"
bb11d8c 
This reverts commit 755382e.
mybearworld and others added 23 commits June 6, 2024 19:47
@mybearworld
Merge branch 'master' into jsdoc
faf78b0
@mybearworld
Merge branch 'master' into jsdoc
73cdbec
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
7e39abb 
… into jsdoc
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
e5ce094 
… into jsdoc
@mybearworld
Add comment to new addons
caae120
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
80ee8c2 
… into jsdoc
@mybearworld
Mark placeholder in message function as optional
99a01c5
@mybearworld
Mark more functions as private
a36ec80
@mybearworld
Make @Private tags be on their own lines
d4390bc
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
67a2562 
… into jsdoc
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
6a87979 
… into jsdoc
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
bbd70b4 
… into jsdoc
@mybearworld
Add comment to forum-user-agent
808e44d
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
1ab0cce 
… into jsdoc
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
7ce9519 
… into jsdoc
@mybearworld
Add comment to player-thumb
021385d
@mybearworld
Replace now redundant UserscriptUtilities references
6253d7a
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
3ef89dc 
… into jsdoc
@mybearworld @actions-user
Format code
157cabe
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
d4c2983 
… into jsdoc
@mybearworld
Delete redirect-mobile-forums/userscript.js as it is unused
27da353
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
07a0654 
… into jsdoc
@mybearworld
Merge branch 'master' of https://github.com/ScratchAddons/ScratchAddons…
d80244c 
… into jsdoc
@mybearworld mybearworld mentioned this pull request Dec 1, 2024
Closed
@Samq64 Samq64 added scope: documentation Related to documentation and help resources type: enhancement New feature for the project scope: development Related to developing, documentation, DevEx, etc. labels Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@WorldLanguages WorldLanguages Awaiting requested review from WorldLanguages WorldLanguages is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
scope: development Related to developing, documentation, DevEx, etc. scope: documentation Related to documentation and help resources type: enhancement New feature for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JSDoc types for userscript function parameters
2 participants
@mybearworld @Samq64