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

Should publish standalone API jar #101

Closed
SamCarlberg opened this issue Aug 6, 2017 · 2 comments
Closed

Should publish standalone API jar #101

SamCarlberg opened this issue Aug 6, 2017 · 2 comments
Assignees
Labels
api Related to the API module build Related to the build system

Comments

@SamCarlberg
Copy link
Member

A tentative list of the classes that should be moved into an api project:

Package Class
components LinearIndicator
NumberField
Scrubber
data Everything in this package
data.types Everything in this package
properties AsyncProperty
sources DataSource
AbstractDataSource
SourceType (should also be split into an interface and util class)
IncompatibleSourceException
widget Widget
AbstractWidget
AnnotatedWidget
SingleTypeWidget
ComplexAnnotatedWidget
@Description
@ParamtrizedController

Other thoughts:

  • Should this be a fatjar or standalone? A fat jar would give users access to guava etc. but would increase the jar size
  • Need to look into how plugins would interact with an API jar and determine any extra classes that should get moved over. Particularly custom JavaFX components.

@JLLeitschuh can you work on splitting the project into an api project and an app project?

@SamCarlberg SamCarlberg added api Related to the API module build Related to the build system labels Aug 6, 2017
@JLLeitschuh
Copy link
Member

I'd be happy to take this on.

Do you have an idea what the fully qualified destination package is you'd like these each to end up in?
edu.wpi.shuffleboard.api?

Also, are there any big PR's coming in that will be messing with any of these files? I don't really want to/have the time to resolve massive merge conflicts.

@JLLeitschuh JLLeitschuh self-assigned this Aug 6, 2017
@SamCarlberg
Copy link
Member Author

SamCarlberg commented Aug 6, 2017

This should be pretty smooth. Adding plugins for #102 is going to be a mess.

I was thinking edu.wpi.first.shuffleboard.api for the base package name.

JLLeitschuh added a commit to JLLeitschuh/shuffleboard that referenced this issue Aug 7, 2017
JLLeitschuh added a commit to JLLeitschuh/shuffleboard that referenced this issue Aug 7, 2017
SamCarlberg pushed a commit that referenced this issue Aug 7, 2017
* Splits app into API and APP project

Closes #101

* Split SourceType into class and util class (like DataType)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Related to the API module build Related to the build system
Projects
None yet
Development

No branches or pull requests

2 participants