Add static typing to all properties #57

New Issue

Closed

opened 2024-04-25 00:29:33 +00:00 by HotNoggin · 9 comments

HotNoggin commented 2024-04-25 00:29:33 +00:00 (Migrated from github.com)

Copy Link

What happened?

I've just enabled enforcing static typing in my project, because I do like to see errors when I miss typing my variables. However, most of the variables in this plugin are completely untyped, so I was left with tens of errors to "fix".

It is a bit tricky to track down the root of these errors since they do come from an addon, so they appear with gdscript:// with a strange ID instead of a traceable res:// path.

I added static typing to every single variable and changed all of the paths to use this format: @onready var name: Type = $Path/To/Node as Type . It was a bit tedious, and since I do plan to use this addon and future versions in future projects, I would love if the addon could have strict static typing enforced already. plugin.gd seemed to be the biggest culprit with all of its paths and variables. The things that should be typed are:

• Variable and constant declarations, as var name: Type (and as Type if necessary)
• Function return values and parameters, as func name(parameter: Type) -> Type:

Aside from static typing, unsafe property access should also be fixed (Like setting the position of a Node which might be a Node2D but you don't know if it is).

If you do plan to do this, you can check if it's been done correctly by enabling these settings:

Thanks for reaching the bottom and please ease the suffering of us static typers. :)

Version

1.3.1

Godot Version

4.2.1

Exact steps to reproduce this error

Simply enable these settings and you'll get the same errors each time you reload the project:

GDScript

The whole repo

Godot output

PAIN

Additional information

cough cough

It's dusty down here.

Checks

• I tried reinstalling the addon or tried to fix it myself with other methods.
• I tried restarting Discord and Godot completely.
• I did read the documentation https://vaporvee.com/docs/discord-rpc-godot/

### What happened? I've just enabled enforcing static typing in my project, because I do like to see errors when I miss typing my variables. However, most of the variables in this plugin are completely untyped, so I was left with tens of errors to "fix".   It is a bit tricky to track down the root of these errors since they do come from an addon, so they appear with `gdscript://` with a strange ID instead of a traceable `res://` path. I added static typing to every single variable and changed all of the paths to use this format: `@onready var name: Type = $Path/To/Node as Type` . It was a bit tedious, and since I do plan to use this addon and future versions in future projects, I would love if the addon could have strict static typing enforced already. `plugin.gd` seemed to be the biggest culprit with all of its paths and variables. The things that should be typed are: - Variable and constant declarations, as `var name: Type` (and `as Type` if necessary) - Function return values and parameters, as `func name(parameter: Type) -> Type:` Aside from static typing, unsafe property access should also be fixed (Like setting the `position` of a `Node` which might be a `Node2D` but you don't know if it is). If you do plan to do this, you can check if it's been done correctly by enabling these settings:  Thanks for reaching the bottom and please ease the suffering of us static typers. :) ### Version 1.3.1 ### Godot Version 4.2.1 ### Exact steps to reproduce this error Simply enable these settings and you'll get the same errors each time you reload the project:  ### GDScript ```gdscript The whole repo ``` ### Godot output ```shell PAIN ``` ### Additional information *cough cough* It's dusty down here. ### Checks - [x] I tried reinstalling the addon or tried to fix it myself with other methods. - [X] I tried restarting Discord and Godot completely. - [X] I did read the documentation https://vaporvee.com/docs/discord-rpc-godot/

vaporvee commented 2024-04-25 11:54:30 +00:00

Copy Link

Huh i thought i already did do that but will fix that soon! thanks for reporting :)

Huh i thought i already did do that but will fix that soon! thanks for reporting :)

🎉 3

vaporvee commented 2024-07-29 20:33:00 +00:00

Copy Link

"Soon" i said... Will make some time to fix all gh issues and some more next week. I promise

"Soon" i said... Will make some time to fix all gh issues and some more next week. I promise

HotNoggin commented 2024-08-03 16:47:48 +00:00 (Migrated from github.com)

Copy Link

No problemo!

No problemo!

vaporvee commented 2024-08-08 19:58:13 +00:00

Copy Link

okay i think i fixed it but i didn't get by far as many errors as you. I made everything static i may send you the update early to test it. Also thank you for showing me these settings these are very helpful! I like to type static too but forget it often..

okay i think i fixed it but i didn't get by far as many errors as you. I made everything static i may send you the update early to test it. Also thank you for showing me these settings these are very helpful! I like to type static too but forget it often..

vaporvee commented 2024-08-08 20:22:55 +00:00

Copy Link

ADDON-Discord-RPC-Godot.zip
try it whenever you have time for it

[ADDON-Discord-RPC-Godot.zip](https://github.com/user-attachments/files/16553077/ADDON-Discord-RPC-Godot.zip) try it whenever you have time for it

HotNoggin commented 2024-08-09 15:03:16 +00:00 (Migrated from github.com)

Copy Link

While the RPC is working 100%, the errors still seem to be there. It looks like there are only a few stray untyped variables left.

While the RPC is working 100%, the errors still seem to be there. It looks like there are only a few stray untyped variables left. 

HotNoggin commented 2024-08-09 15:07:53 +00:00 (Migrated from github.com)

Copy Link

Checking the changes in github, and it looks to be a script in Debug.tscn:

The red is my version, which was static-typing-error-free.

Checking the changes in github, and it looks to be a script in Debug.tscn:  The red is my version, which was static-typing-error-free.

vaporvee commented 2024-08-09 15:33:01 +00:00

Copy Link

weird i dont get these errors somehow but will fix them

weird i dont get these errors somehow but will fix them

vaporvee commented 2025-03-26 16:01:23 +00:00

Copy Link

will be in future updates

will be in future updates

🎉 1

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

diklor/main

discord-social-sdk

legacy

4.0.X

1.3.1-reupload

1.3.1

1.3.0

1.2.0

1.1.0

1.0.1

1.0.0

3.2

3.1

3.0

2.4

2.3

2.2

2.1

2.0

1.5

1.4

1.3

1.2

1.1

1.0

Labels

Clear labels

bug

Something isn't working

building

Everything about building the plugin

can be for another update

not very useful for current update milestone

can't reproduce

discord's fault

documentation

Improvements or additions to documentation

duplicate

This issue or pull request already exists

EditorPresence

EXPERIMENTAL

enhancement

New feature or request

good first issue

Good for newcomers

important

invalid

This doesn't seem right

no response

question

Further information is requested

Todo for myself

wontfix

This will not be worked on

No Label

bug

Milestone

No items

No Milestone

Assignees

Clear assignees

vaporvee

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: vaporvee/discord-rpc-godot#57

No description provided.