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.

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

Improve plugin documentation #393

Open
Major- opened this issue Apr 2, 2018 · 2 comments
Open

Improve plugin documentation #393

Major- opened this issue Apr 2, 2018 · 2 comments

Comments

@Major-
Copy link
Member

Major- commented Apr 2, 2018

This is an epic that involves:

  • Introductory information ("what are plugins and why do they exist")
  • Information for developing, testing, and releasing plugins
  • In-code documentation for plugin APIs.

See #330, #392.

@Arham4
Copy link
Contributor

Arham4 commented Jul 28, 2018

Writing plugins was of complete ease for shops. I will say, however, that the error messages it prints out should be more clear.

For instance, I was stuck on why I got a KotlinNullPointerException. It turned out it was due to adding an item name that didn't exist. After some debugging by modifying the DSL, the item at fault was "Kharidian headpiece" (despite copying from the wiki), only to find it is actually spelled "Karadian headpiece" in the source. If the error was more clear to that it being a spelling error (perhaps InvalidItemException or something?), it would have saved a lot of time. I had the same thing happen to waterskins and had to rinse and repeat the process.

Albeit this can be resolved by putting IDs for all items, that was not the intention behind the DSL.

@garyttierney
Copy link
Contributor

Expanding on above, I'd like to also eventually provide editor support in IntelliJ for this sort of thing. An Apollo plugin could load the users local cache and do error-checking on annotated methods to determine if a given string identifier is a valid unique entity, ambiguous, or not valid at all.

@Major- Major- mentioned this issue Aug 22, 2018
42 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants