close
The Wayback Machine - https://web.archive.org/web/20201102040005/https://github.com/remkop/picocli/issues/500
Skip to content

/ picocli

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

Jump to bottom

Add picocli annotation processor #500

Closed
remkop opened this issue Sep 28, 2018 · 2 comments
Closed

Add picocli annotation processor #500

remkop opened this issue Sep 28, 2018 · 2 comments
Milestone
4.0-beta-1

Comments

@remkop
Copy link
Owner

@remkop remkop commented Sep 28, 2018 •
edited

Annotation processor to build a CommandSpec model from the picocli annotations in the source code at compile time.

This would make it possible to build tools for picocli-based applications that do more interesting work during the build:

  • generate auto-completion scripts as part of the build
  • generate man-page like documentation as part of the build (#459)
  • generate configuration as part of the build (#410, #499, #699, #703, #704)
  • generate java source code or instrumented byte code so picocli can work without runtime reflection (#539)
@remkop remkop mentioned this issue Nov 6, 2018
Open
@remkop remkop changed the title Add module picocli-ann-proc Add picocli annotation processor Nov 6, 2018
@remkop
Copy link
Owner Author

@remkop remkop commented Nov 6, 2018

Work in progress is to add an abstract annotation processor to the picocli-codegen module (no new module). This annotation processor will inspect the source code and build up a list of CommandSpec models from the annotations. Subclasses can override and implement a method to do useful work with these CommandSpec objects.
@remkop remkop added the in-progress label Nov 8, 2018
@remkop remkop added this to the 4.0 milestone Nov 10, 2018
remkop added a commit that referenced this issue Jan 30, 2019
@remkop
#500 Add picocli annotation processor
Loading status checks…
e8e1b44 
* add separate module picocli-annotation-processing-tests for testing (com.google.testing.compile:compile-testing requires Java 8)
* (API) add ITypeInfo that encapsulated type information available at both runtime and compile time
* add RuntimeTypeInfo implementation used at runtime (reflection)
* (API) add IAnnotatedElement as public API for method and fields annotated with any picocli annotation
* internal class TypedMember now implements IAnnotatedElement
* (API) CommandSpec.resourceBundleBaseName() getter and setter
* (API) Messages.resourceBundleBaseName() getter
* (API) ArgSpec.userObject() getter
* (API) made MethodParam public
* IGetter/ISetter implementations now have informative toString() methods
* removed internal class ArgsReflection
remkop added a commit that referenced this issue Jan 31, 2019
@remkop
#500 Exclude module picocli-annotation-processing-tests from the buil…
Verified
This commit was created on GitHub.com and signed with a verified signature using GitHub’s key.
GPG key ID: 4AEE18F83AFDEB23 Learn about signing commits
Loading status checks…
9a0cd52 
…d when _not_ on Java 8
@remkop remkop mentioned this issue Mar 28, 2019
Closed
@remkop remkop modified the milestones: 4.0, 4.0-beta-1 May 13, 2019
remkop added a commit that referenced this issue May 19, 2019
@remkop
[#500] move init methods to XxxMetaData classes
6a04d9b
remkop added a commit that referenced this issue May 19, 2019
@remkop
[#500] move extract methods to XxxMetaData classes
531258c
remkop added a commit that referenced this issue May 19, 2019
@remkop
[#500] Make `CommandSpec.DEFAULT_COMMAND_NAME` a public constant
9093886
remkop added a commit that referenced this issue May 19, 2019
@remkop
[#500] Extract validation, CompileTimeTypeInfo and TypedMember from t…
7cfca56 
…he annotation processor class
remkop added a commit that referenced this issue May 19, 2019
@remkop
[#500] Add initial support for @Arggroup annotation
Loading status checks…
06b572c
remkop added a commit that referenced this issue May 20, 2019
@remkop
[#500] Minor improvements
Loading status checks…
af78ab3
remkop added a commit that referenced this issue May 21, 2019
@remkop
[#500] do not load ResourceBundles during model creation in annotatio…
2933b94 
…n processor
@remkop remkop mentioned this issue May 21, 2019
Closed
remkop added a commit that referenced this issue May 21, 2019
@remkop
[#500] improve error reporting
f040ed2
remkop added a commit that referenced this issue May 21, 2019
@remkop
[#500] various fixes:
46feadd 
* fix test for improved validation
* load ResourceBundle if possible
* add fatalError and warn protected methods for processor subclasses
remkop added a commit that referenced this issue May 22, 2019
@remkop
[#500] Detect annotations in compile units that have already been com…
de51892 
…piled
remkop added a commit that referenced this issue May 22, 2019
@remkop
[#500] Improve handling of annotations in compile units that have alr…
Loading status checks…
9af5501 
…eady been compiled
remkop added a commit that referenced this issue May 23, 2019
@remkop
[#500] Capture @SPEC and @ParentCommand-annotated program elements in…
4316659 
… the CommandSpec model
This was referenced May 23, 2019
Closed
Closed
Open
@remkop
Copy link
Owner Author

@remkop remkop commented May 24, 2019 •
edited

TODO:

  • change relative path to META-INF/picocli-generated/$groupId/$artifactId/...
  • if no groupId and artifactId are specified, insert a UUID to ensure a unique location? -> No, that would result in many subdirecties under picocli-generated/...
  • cleanup: remove JUL logging (WONT DO)
  • polish: add logging via the Messager.printMessage(Diagnostic.Kind) API (at NOTE level?)
    • log user-specified option values, log path where file is generated
    • TBD change groupId and artifactId to group and name? (WONT DO)
    • TBD change groupId and artifactId to a single option: path or coordinates or id or project?
    • log class/method names of @Command-annotated elements in abstract processor (WONT DO)
  • warn if ResourceBundle not found? Include ResourceBundle even if not found? fixed bug
  • documentation
  • Add options disable.reflect.config, disable.proxy.config, disable.resource.config, project
  • Other processors may need options like location, relative.path, full.path (but each processor may need a different output location, e.g., autocompletion script, man pages, ...)
  • logInfo should prefix simple name instead of full class name
  • add isEnabled protected method to abstract proc. Skip processing if disabled. Log "$proc is available but not enabled" when processing done
  • test that no files are generated when disabled
remkop added a commit that referenced this issue May 24, 2019
@remkop
[#500][#699][#703][#704] support options, bugfixes, tests
Loading status checks…
8641b20 
* fixed resource bundle related bugs in CommandLine (bundle may be null while bundleBaseName is not null in annotation processors)
* all annotation processors now support a `relative.path` option (replaces the `groupId` and `artifactId` options)
* DynamicProxyConfigGeneratorProcessor now supports a `interfaceClasses` option for additional interface names
* ResourceConfigGeneratorProcessor now supports a `bundles` option for additional resource bundles and a `resourceRegex` option for additional other resources
* added tests
remkop added a commit that referenced this issue May 24, 2019
@remkop
[#500][#699][#703][#704] enable the graal config annotation processor…
Loading status checks…
cddb84d 
…s in META-INF/services
remkop added a commit that referenced this issue May 26, 2019
@remkop
[#500][#699][#703][#704] documentation (RELEASE-NOTES), changed optio…
Loading status checks…
b694144 
…n names, added tests
@remkop remkop closed this in fa0f41b May 26, 2019
remkop added a commit that referenced this issue Jun 1, 2019
@remkop
[#500][#699][#703][#704] update picocli-codegen/README, update RELEAS…
Loading status checks…
3784c30 
…E-NOTES
remkop added a commit that referenced this issue Jun 3, 2019
@remkop
[#500][#699][#703][#704] update picocli-codegen/README, update RELEAS…
e530d0b 
…E-NOTES
remkop added a commit that referenced this issue Jun 3, 2019
@remkop
[#500][#699][#703][#704] add image file
Loading status checks…
d9ea95a
remkop added a commit that referenced this issue Jun 3, 2019
@remkop
[#500][#699][#703][#704] add section to user manual on creating nativ…
Loading status checks…
b3d0625 
…e images with GraalVM
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
4.0-beta-1
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
@remkop
You can’t perform that action at this time.