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

muSrcGenIdlType Tweak #839

Merged
merged 3 commits into from
Mar 11, 2020
Merged

muSrcGenIdlType Tweak #839

merged 3 commits into from
Mar 11, 2020

Conversation

juanpedromoreno
Copy link
Member

What this does?

Currently, the sbt-mu-srcgen requires the sbt setting muSrcGenIdlType with a value different from the default one: Unknown. This happens even for those sbt projects or submodules that have no protocols to generate sources from.

Unknown IDL type 'Unknown'. Valid values: Proto, Avro, OpenAPI

As a workaround, the user can set up any of the valid values but it's not quite user-friendly.

In this PR, I'm removing the existing validation and changing it by simple check if-else. If the module has a "valid" muSrcGenIdlType, the plugin will run the code generator, and, in any other case, the plugin will return an empty list and, an informative message for the user.

Additionally, I'm fixing a couple of broken links in the docs.

Checklist

  • Reviewed the diff to look for typos, println and format errors.
  • Updated the docs accordingly.

@@ -10,6 +10,6 @@ permalink: guides
These guides are aimed at developers who are already familiar with Mu-Scala.

If you are new to Mu-Scala, we recommend you read the [Getting Started
guide](../getting-started) and the [tutorials](../tutorials).
guide](getting-started) and the [tutorials](tutorials).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As the user is in the index.html, the path is omitted by the browser. It seems that it's not needed to go back with .. .


If you are already familiar with Mu-Scala, you may want to read about how to use
its more advanced features in the [How-To Guides](../guides).
its more advanced features in the [How-To Guides](guides).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same happens in this file (index.md).

@codecov
Copy link

codecov bot commented Mar 11, 2020

Codecov Report

Merging #839 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #839   +/-   ##
=======================================
  Coverage   71.63%   71.63%           
=======================================
  Files          69       69           
  Lines        1033     1033           
  Branches       19       21    +2     
=======================================
  Hits          740      740           
  Misses        293      293

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 ecc1f0e...8628950. Read the comment docs.

@juanpedromoreno juanpedromoreno merged commit 63ad993 into master Mar 11, 2020
@juanpedromoreno juanpedromoreno deleted the muSrcGenIdlType-patch branch March 11, 2020 21:53
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.

2 participants