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

Provide cache directory as a named flag (and not as a loose argument) to compiler plugins #210

Open
LukaszKontowski opened this issue Jul 29, 2022 · 1 comment
Labels
code quality Code quality codecs Relates to useful/missing Circe codec (regardless of Akka serialization) good first issue Good for newcomers

Comments

@LukaszKontowski
Copy link
Contributor

LukaszKontowski commented Jul 29, 2022

Switch
. - directory where cache file will be saved, required (description from one of plugins)
to a named flag.

Both for CodecRegistrationCheckerCompilerPlugin and for DumpPersistenceSchemaCompilerPlugin.

  • Update code (remember to add descriptions in override val optionsHelp)
  • Update default configs in the sbtAkkaSerializationHelper sbt plugin (module)
  • Update README.md and docs/GUIDE.md
  • Check in known projects that use ASH - if this configuration has been used somewhere. If yes, inform the right people about this change in upcoming release.
@LukaszKontowski LukaszKontowski added good first issue Good for newcomers code quality Code quality codecs Relates to useful/missing Circe codec (regardless of Akka serialization) labels Jul 29, 2022
@LukaszKontowski LukaszKontowski changed the title Codec Registration Checker Compiler Plugin - switch custom directory to named flag switch custom directory to named flags Jul 29, 2022
@PawelLipski
Copy link
Collaborator

If yes, inform the right people about this change in upcoming release.

Or even better, leave the support for the loose argument but mark as deprecated (emit a non-fatal warning from compiler plugin when used... TBD what if folks have -Xfatal-warnings enabled though)

@PawelLipski PawelLipski changed the title switch custom directory to named flags Provide cache directory as a named flags (and not loose argument) to compiler plugins Jul 30, 2022
@PawelLipski PawelLipski changed the title Provide cache directory as a named flags (and not loose argument) to compiler plugins Provide cache directory as a named flag (and not as a loose argument) to compiler plugins Jul 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality Code quality codecs Relates to useful/missing Circe codec (regardless of Akka serialization) good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants