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

preparing repackaging for 1.0 - move ADT members to companion + some more removals from public API #531

Merged
merged 8 commits into from
Sep 15, 2023

Conversation

jenshalm
Copy link
Contributor

This is a bit of a grab bag of small changes to prepare for the final repackaging step.

  • It moves ADT members to the companion for improved scaladoc navigation for the following types:

    • laika.config.ConfigValue
    • laika.config.ConfigError
    • laika.rewrite.link.TargetValidation
  • It moves error types for laika-core from the DocumentParser companion to a new package laika.api.errors so that the DocumentParser can be removed from the public API.

  • It removes the TreeOutput model from public APIs in favor of adding a .toMemory method to all transformer builders which removes the need for having the ADT in public.

  • Makes error types in laika-io private. It's unclear whether there is demand for having access to them. In case there is, it's better to re-introduce them in a 1.x minor as they are in need of some additional polishing.

  • Exposes NoOpPathTranslator in PathTranslator.noOp instead.

This is the last PR before a major repackaging PR that addresses the issue of having multiple semi-populated skeleton packages after all the removals from public API in M2.

@jenshalm jenshalm added this to the 1.0.0-M5 milestone Sep 14, 2023
@jenshalm jenshalm merged commit 2449cb7 into main Sep 15, 2023
21 checks passed
@jenshalm jenshalm deleted the api/adt-companions branch September 15, 2023 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant