skripthub / skripthubdocstool

A tool to help Skript Addon Developers autogenerate their documentation.

Website: https://skripthub.net

This is the issue tracking repo for Skript Hub.

skripthubdocstool's Issues

[Skript 2.7+] Add support for Structure API

Add support for the new Structure API.

Implementation details here: SkriptLang/Skript#4108

This also involves adding support to Skript Hub itself.

Wrong ClassInfo name

Ive noticed this for years and keep forgetting to report it:

"entitydatas"
This is the codename for a class info, is it possible to have the docs tool pull from the lang file instead?
In this case it should be "entity types"
As seen on the vanilla docs:

Thank you for reading.

Skript 2.8.1

[23:06:49 INFO]: /gendocs
[23:06:50 WARN]: [Skript Hub Docs Tool] Plugin SkriptHubDocsTool v1.5 generated an exception while executing task 15
java.lang.NoSuchFieldError: c
        at net.skripthub.docstool.documentation.BuildDocs.getAddon(BuildDocs.kt:287) ~[skripthubdocstool-1.5.jar:?]
        at net.skripthub.docstool.documentation.BuildDocs.run(BuildDocs.kt:48) ~[skripthubdocstool-1.5.jar:?]
        at org.bukkit.craftbukkit.v1_20_R2.scheduler.CraftTask.run(CraftTask.java:101) ~[purpur-1.20.2.jar:git-Purpur-2095]
        at org.bukkit.craftbukkit.v1_20_R2.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:57) ~[purpur-1.20.2.jar:git-Purpur-2095]
        at com.destroystokyo.paper.ServerSchedulerReportingWrapper.run(ServerSchedulerReportingWrapper.java:22) ~[purpur-1.20.2.jar:?]
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136) ~[?:?]
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635) ~[?:?]
        at java.lang.Thread.run(Thread.java:833) ~[?:?]
>

[Skript 2.6+] Support new Parse Mark system

As part of this PR: SkriptLang/Skript#4177

Skript has added new changes to the parse mark system that need to be supported within the docs tool.

Example issue: https://skripthub.net/docs/?id=6833

[Bug] Errors when running "gendocs" command

Hey.

So today I tried to run the "gendocs" command, and this is what I get:
(I know the error says the plugin's version is 1.3, but Im running the 1.4 version on the releases tab)

[13:13:07 INFO]: [Skript Hub Docs Tool] Generating Docs
[13:13:07 INFO]: /gendocs
[13:13:07 WARN]: java.lang.NullPointerException: Cannot invoke "Object.getClass()" because "o" is null
[13:13:07 WARN]: 	at java.base/jdk.internal.reflect.UnsafeFieldAccessorImpl.ensureObj(UnsafeFieldAccessorImpl.java:57)
[13:13:07 WARN]: 	at java.base/jdk.internal.reflect.UnsafeObjectFieldAccessorImpl.get(UnsafeObjectFieldAccessorImpl.java:36)
[13:13:07 WARN]: 	at java.base/java.lang.reflect.Field.get(Field.java:425)
[13:13:07 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.GenerateSyntax$Companion.getEntiresFromSkriptEventInfo(GenerateSyntax.kt:256)
[13:13:07 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.GenerateSyntax$Companion.generateSyntaxFromEvent(GenerateSyntax.kt:70)
[13:13:07 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.BuildDocs.run(BuildDocs.kt:53)
[13:13:07 WARN]: 	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftTask.run(CraftTask.java:101)
[13:13:07 WARN]: 	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:57)
[13:13:07 WARN]: 	at com.destroystokyo.paper.ServerSchedulerReportingWrapper.run(ServerSchedulerReportingWrapper.java:22)
[13:13:07 WARN]: 	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
[13:13:07 WARN]: 	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
[13:13:07 WARN]: 	at java.base/java.lang.Thread.run(Thread.java:833)
[13:13:07 WARN]: java.lang.NullPointerException: Cannot invoke "Object.getClass()" because "o" is null
[13:13:08 WARN]: 	at java.base/jdk.internal.reflect.UnsafeFieldAccessorImpl.ensureObj(UnsafeFieldAccessorImpl.java:57)
[13:13:08 WARN]: 	at java.base/jdk.internal.reflect.UnsafeObjectFieldAccessorImpl.get(UnsafeObjectFieldAccessorImpl.java:36)
[13:13:08 WARN]: 	at java.base/java.lang.reflect.Field.get(Field.java:425)
[13:13:08 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.GenerateSyntax$Companion.getEntiresFromSkriptElementInfo(GenerateSyntax.kt:206)
[13:13:08 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.GenerateSyntax$Companion.generateSyntaxFromSyntaxElementInfo(GenerateSyntax.kt:102)
[13:13:08 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.BuildDocs.run(BuildDocs.kt:65)
[13:13:08 WARN]: 	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftTask.run(CraftTask.java:101)
[13:13:08 WARN]: 	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:57)
[13:13:08 WARN]: 	at com.destroystokyo.paper.ServerSchedulerReportingWrapper.run(ServerSchedulerReportingWrapper.java:22)
[13:13:08 WARN]: 	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
[13:13:08 WARN]: 	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
[13:13:08 WARN]: 	at java.base/java.lang.Thread.run(Thread.java:833)
[13:13:08 WARN]: java.lang.NullPointerException: Cannot invoke "Object.getClass()" because "o" is null
[13:13:08 WARN]: 	at java.base/jdk.internal.reflect.UnsafeFieldAccessorImpl.ensureObj(UnsafeFieldAccessorImpl.java:57)
[13:13:08 WARN]: 	at java.base/jdk.internal.reflect.UnsafeObjectFieldAccessorImpl.get(UnsafeObjectFieldAccessorImpl.java:36)
[13:13:08 WARN]: 	at java.base/java.lang.reflect.Field.get(Field.java:425)
[13:13:08 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.GenerateSyntax$Companion.getEntiresFromSkriptElementInfo(GenerateSyntax.kt:206)
[13:13:08 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.GenerateSyntax$Companion.generateSyntaxFromSyntaxElementInfo(GenerateSyntax.kt:102)
[13:13:08 WARN]: 	at skripthubdocstool-1.4.jar//net.skripthub.docstool.documentation.BuildDocs.run(BuildDocs.kt:73)
[13:13:08 WARN]: 	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftTask.run(CraftTask.java:101)
[13:13:08 WARN]: 	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:57)
[13:13:08 WARN]: 	at com.destroystokyo.paper.ServerSchedulerReportingWrapper.run(ServerSchedulerReportingWrapper.java:22)
[13:13:08 WARN]: 	at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136)
[13:13:08 WARN]: 	at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)
[13:13:08 WARN]: 	at java.base/java.lang.Thread.run(Thread.java:833)
[13:13:08 WARN]: [Skript Hub Docs Tool] Plugin SkriptHubDocsTool v1.3 generated an exception while executing task 10
java.lang.NoClassDefFoundError: ch/njol/skript/lang/Loop
	at java.lang.Class.getDeclaredFields0(Native Method) ~[?:?]
	at java.lang.Class.privateGetDeclaredFields(Class.java:3297) ~[?:?]
	at java.lang.Class.getDeclaredFields(Class.java:2371) ~[?:?]
	at net.skripthub.docstool.documentation.GenerateSyntax$Companion.getEntiresFromSkriptElementInfo(GenerateSyntax.kt:200) ~[skripthubdocstool-1.4.jar:?]
	at net.skripthub.docstool.documentation.GenerateSyntax$Companion.generateSyntaxFromSyntaxElementInfo(GenerateSyntax.kt:102) ~[skripthubdocstool-1.4.jar:?]
	at net.skripthub.docstool.documentation.GenerateSyntax$Companion.generateSyntaxFromExpression(GenerateSyntax.kt:108) ~[skripthubdocstool-1.4.jar:?]
	at net.skripthub.docstool.documentation.BuildDocs.run$lambda-0(BuildDocs.kt:88) ~[skripthubdocstool-1.4.jar:?]
	at java.util.ArrayList$Itr.forEachRemaining(ArrayList.java:1003) ~[?:?]
	at net.skripthub.docstool.documentation.BuildDocs.run(BuildDocs.kt:84) ~[skripthubdocstool-1.4.jar:?]
	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftTask.run(CraftTask.java:101) ~[paper-1.19.jar:git-Paper-51]
	at org.bukkit.craftbukkit.v1_19_R1.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:57) ~[paper-1.19.jar:git-Paper-51]
	at com.destroystokyo.paper.ServerSchedulerReportingWrapper.run(ServerSchedulerReportingWrapper.java:22) ~[paper-1.19.jar:?]
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136) ~[?:?]
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635) ~[?:?]
	at java.lang.Thread.run(Thread.java:833) ~[?:?]
Caused by: java.lang.ClassNotFoundException: ch.njol.skript.lang.Loop
	at org.bukkit.plugin.java.PluginClassLoader.loadClass0(PluginClassLoader.java:151) ~[paper-api-1.19-R0.1-SNAPSHOT.jar:?]
	at org.bukkit.plugin.java.PluginClassLoader.loadClass(PluginClassLoader.java:103) ~[paper-api-1.19-R0.1-SNAPSHOT.jar:?]
	at java.lang.ClassLoader.loadClass(ClassLoader.java:520) ~[?:?]
	... 15 more

Syntaxes getting passed to wrong addon

I hope I word this correctly, but we did have a convo about this a while back.

I've noticed some things from SkBee are being marked as Skript syntaxes, ex:
https://skripthub.net/docs/?id=7777
This one for example is in fact an SkBee type, not a Skript type

For some odd reason a few things are showing up in Skript's docs and not SkBee's docs.

/gendocs causes java.lang.NoSuchFieldError: elementClass

/gendocs doesn't work with my environment.
This is the stack trace.
It implies the field SyntaxElementInfo#elementClass doesn't exist.

> gendocs
[01:13:30 INFO]: [Skript Hub Docs Tool] Generating Docs
[01:13:30 INFO]: /gendocs
[01:13:31 WARN]: [Skript Hub Docs Tool] Plugin SkriptHubDocsTool v1.6 generated an exception while executing task 13
java.lang.NoSuchFieldError: elementClass
        at net.skripthub.docstool.documentation.GenerateSyntax$Companion.getEntriesFromSkriptEventInfo(GenerateSyntax.kt:318) ~[skripthubdocstool-1.6.jar:?]
        at net.skripthub.docstool.documentation.GenerateSyntax$Companion.generateSyntaxFromEvent(GenerateSyntax.kt:72) ~[skripthubdocstool-1.6.jar:?]
        at net.skripthub.docstool.documentation.BuildDocs.run(BuildDocs.kt:52) ~[skripthubdocstool-1.6.jar:?]
        at org.bukkit.craftbukkit.v1_20_R3.scheduler.CraftTask.run(CraftTask.java:101) ~[purpur-1.20.4.jar:git-Purpur-2124]
        at org.bukkit.craftbukkit.v1_20_R3.scheduler.CraftAsyncTask.run(CraftAsyncTask.java:57) ~[purpur-1.20.4.jar:git-Purpur-2124]
        at com.destroystokyo.paper.ServerSchedulerReportingWrapper.run(ServerSchedulerReportingWrapper.java:22) ~[purpur-1.20.4.jar:?]
        at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1136) ~[?:?]
        at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635) ~[?:?]
        at java.lang.Thread.run(Thread.java:842) ~[?:?]

/skript info:

> skript info
[01:14:06 INFO]: [Skript] Skript's aliases can be found here: https://github.com/SkriptLang/skript-aliases
[01:14:06 INFO]: [Skript] Skript's documentation can be found here: https://docs.skriptlang.org/
[01:14:06 INFO]: [Skript] Skript's tutorials can be found here: https://docs.skriptlang.org/tutorials
[01:14:06 INFO]: [Skript] Server Version: git-Purpur-2124 (MC: 1.20.4)
[01:14:06 INFO]: [Skript] Skript Version: 2.7.3 (skriptlang-github)
[01:14:06 INFO]: [Skript] Installed Skript Addons:
[01:14:06 INFO]: [Skript]  - Bask v0.1.0-SNAPSHOT
[01:14:06 INFO]: [Skript] Installed dependencies: None