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

Reorganize package into submodules #15

Merged
merged 3 commits into from Jul 12, 2022
Merged

Conversation

bauglir
Copy link
Owner

@bauglir bauglir commented Jul 12, 2022

The main package module is slowly becoming more of a nuisance to navigate/keep an overview of and the tests take increasingly longer having to run them all. By splitting functionality up into dedicated modules, it's both easier to keep an overview of the package and to run subsets of tests during development by commenting certain includes out.

The supported diagrams are already defined using `Symbol`s in the
`LIMITED_DIAGRAM_SUPPORT`. The previous 'string indirection' existed
solely due to the macro interpolation not having been completely
understood. Ensuring the diagram `type` `Symbol`s are quoted twice
removes the need for the string indirection.
This functionality is relatively self-contained meta-progamming, moving
it into its own module helps to clearly delineate the metaprogramming
from the core functionality of the package.
@bauglir bauglir self-assigned this Jul 12, 2022
@bauglir bauglir enabled auto-merge July 12, 2022 13:02
@codecov
Copy link

codecov bot commented Jul 12, 2022

Codecov Report

Merging #15 (c43c9e2) into development (3633a0e) will not change coverage.
The diff coverage is 100.00%.

@@              Coverage Diff              @@
##           development       #15   +/-   ##
=============================================
  Coverage       100.00%   100.00%           
=============================================
  Files                2         4    +2     
  Lines               92        92           
=============================================
  Hits                92        92           
Impacted Files Coverage Δ
src/Kroki.jl 100.00% <ø> (ø)
src/kroki/exceptions.jl 100.00% <100.00%> (ø)
src/string_literals.jl 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3633a0e...c43c9e2. Read the comment docs.

Exceptions require some boilerplate to render nicely and obstruct the
flow of the definition of the main functionality of the package.
Extracting them into a separate module decreases the amount of code
necessary to grasp the core concepts of the package in both the package
itself as well as its tests.
@bauglir bauglir merged commit 2cbcb73 into development Jul 12, 2022
@bauglir bauglir deleted the reorganize-package branch July 12, 2022 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant