Add support for adding library dependencies via imports. #333
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
olafurpg
force-pushed
the
deps
branch
3 times, most recently
from
1d8ac01 to
c1e3352
Compare
added 4 commits
May 13, 2020 19:08
Previously, mdoc users could not dynamically add new library dependencies to a document. The library classpath was static and could only be updated through the `--classpath` command-line argument. Now, it's possible for users to dynamically add new dependencies via imports similar to how it works in Ammonite. ```scala import $dep.`org.scalameta::scalameta:4.3.10`, scala.meta._ q"val x = 42" ``` The `$ivy` prefix is treated as an alias for `$dep` to preserve compatibility with Ammonite. However, I went with `$dep` as the primary syntax instead of `$ivy` because these imports support both Ivy and Maven patterns. Maybe we can get Ammonite to also support `$dep`.
Previously, it was not possible to configure Scala compiler options via imports. Now, users can customize the compiler options like this ````md ```scala mdoc import $scalac.`-Wunused:imports -Xfatal-warnings` import scala.util.Try println(42) ``` ```` and get a compile error.
Previously, it was only possible to import from pre-compiled dependencies from the build via --classpath or via magic `$dep` imports. Now, it's also possible to write re-usable `*.sc` script files and import them from markdown files.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, mdoc users could not dynamically add new library
dependencies to a document. The library classpath was static and could
only be updated through the
--classpathcommand-line argument.Now, it's possible for users to dynamically add new dependencies via
imports similar to how it works in Ammonite.
The
$ivyprefix is treated as an alias for$depto preservecompatibility with Ammonite. However, I went with
$depas the primarysyntax instead of
$ivybecause these imports support both Ivy andMaven patterns. Maybe we can get Ammonite to also support
$dep.TODOs:
EvaluatedWorksheet(required for Metals)$fileimports$fileimports$fileimports when the same file is imported from two different packages