Generate JSON docs with Gson #5738
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pikachu920
added
bug
AyhamAl-Ali
requested changes
Jun 11, 2023
Pikachu920
commented
Jun 11, 2023
Moderocky
force-pushed
the
master
branch
3 times, most recently
from
bd134d0
to
3f08853
Compare
|
By default, GSON escapes strings containing HTML content. This is the intended behaviour, but for some reason the escaping occurs several times, as can be seen in the JSON for some examples. |
sovdeeth
requested changes
Sep 5, 2024
APickledWalrus
previously requested changes
Sep 5, 2024
# Conflicts: # src/main/java/ch/njol/skript/doc/HTMLGenerator.java # src/main/java/ch/njol/skript/lang/function/Signature.java
# Conflicts: # src/main/java/ch/njol/skript/doc/HTMLGenerator.java # src/main/java/ch/njol/skript/lang/function/Signature.java
Efnilite
requested changes
Sep 9, 2024
There was a problem hiding this comment.
in HTMLGenerator you could use File(parent, child) to avoid manually having to add the / or using File.separator, or you could use what you have rn but you should make it more consistent because it varies.
you can also maybe add tests for the JSONGenerator
besides that very cool
| @SuppressWarnings("unchecked") | ||
| public void generate() { | ||
| for (File f : template.listFiles()) { | ||
| for (File f : templateDir.listFiles()) { |
There was a problem hiding this comment.
Suggested change
| for (File f : templateDir.listFiles()) { | |
| for (File file : templateDir.listFiles()) { |
| if (f.getName().matches("css|js|assets")) { // Copy CSS/JS/Assets folders | ||
| String slashName = "/" + f.getName(); | ||
| File fileTo = new File(output + slashName); | ||
| File fileTo = new File(outputDir + slashName); |
There was a problem hiding this comment.
Suggested change
| File fileTo = new File(outputDir + slashName); | |
| File fileTo = new File(outputDir, file.getName()); |
doesn't this work? this way you don't need slashName
Efnilite
reviewed
Sep 9, 2024
UnderscoreTud
approved these changes
Sep 9, 2024
Co-authored-by: _tud <[email protected]>
Efnilite
approved these changes
Sep 18, 2024
Moderocky
reviewed
Sep 18, 2024
Comment on lines
+43
to
+44
| private static <T> int calculateCollisionCount(Iterator<? extends T> potentialCollisions, Predicate<T> collisionCriteria, | ||
| Predicate<T> equalsCriteria) { |
There was a problem hiding this comment.
What's this indentation doing?
sovdeeth
approved these changes
Sep 18, 2024
Pikachu920
dismissed stale reviews from APickledWalrus and AyhamAl-Ali
addressed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR switches the JSON doc generation to Gson (which is included w/ spigot). The current generation method (I think it's just some string replacing) often generates invalid JSON. Switching to Gson should help prevent this as Gson will deal with the JSON generation, while we just provide the data.
You can see the generated JSON here: https://docs.skriptlang.org/nightly/fix/json-docs/docs.json
Target Minecraft Versions: N/A
Requirements: N/A
Related Issues: SkriptLang/skript-docs#31