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

Add support for multiline description; remove 70 chars limitation #622

Merged
merged 6 commits into from
Nov 30, 2021

Conversation

eugeniyk
Copy link
Contributor

@eugeniyk eugeniyk commented Nov 15, 2021

fixes #596

This PR aim for supporting multiline description, with custom line breaks and removing custom 70 symbols pseudo new line
As for me it can be obsoleted since it's now up to you how to format the description

Example:

description = \
Welcome to AG scala service seed!\n\
Let's create service with our best practices!\n\
\n\
Help about parameters:\n\
- organization => logical separation, part of package name (eg. platform, connectivity, ..)\n\
- project => human-readable name of the project. Do not include 'api' postfix in it\n\
- ssot => system name that we use internally to identify the service. This name may include 'api' postfix\n\
- git_* => gitlab settings\n\
- harbor_organization => allows to override harbor organization
- gen_* => whether to include generation of dedicated components; yes / no\n\

As a result we'll have nice description in the console:

Welcome to AG scala service seed!
Let's create service with our best practices!

Help about parameters:
- organization => logical separation, part of package name (eg. platform, connectivity, ..)
- project => human-readable name of the project. Do not include 'api' postfix in it
- ssot => system name that we use internally to identify the service. This name may include 'api' postfix
- git_* => gitlab settings
- harbor_organization => allows to override harbor organization
- gen_* => whether to include generation of dedicated components; yes / no

@eugeniyk
Copy link
Contributor Author

@eed3si9n Any update on this one? Do you still want to preserve initial behavior?

@eed3si9n
Copy link
Member

@eugeniyk Sorry about the delay. To be honest, I don't have strong opinion on either direction, but I can imagine someone else might file it as a bug if we break the backward compatibility without strong reason. So in my opinion, introducing the new behavior only when the string contains \n is more defensive coding.

@eugeniyk
Copy link
Contributor Author

This is an expected output of the test:
image

@eugeniyk
Copy link
Contributor Author

@eed3si9n ok please check again, I've restored the old behavior

Copy link
Member

@eed3si9n eed3si9n left a comment

Choose a reason for hiding this comment

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

Thanks!

@eed3si9n eed3si9n merged commit ea77982 into foundweekends:develop Nov 30, 2021
@eugeniyk eugeniyk deleted the fix-description-field branch December 1, 2021 09:03
@eugeniyk
Copy link
Contributor Author

eugeniyk commented Jan 5, 2022

@eed3si9n is there a plan to release new version any soon?

@eed3si9n
Copy link
Member

eed3si9n commented Jan 5, 2022

Yea. Maybe in a week or two?

@eugeniyk
Copy link
Contributor Author

image
not sure what is scala_xml 2.01

@eed3si9n
Copy link
Member

How did you get the error?

@eugeniyk
Copy link
Contributor Author

eugeniyk commented Jan 12, 2022

if you have sbt native packager (1.9.7) along with latest giter8 and sbt 1.6.1 on scala 2.12/13
anyway, evictionErrorLevel := Level.Info seems hided the issue

@eed3si9n
Copy link
Member

Did you add giter8 into the metabuild?
In general though maybe we should consider downgrading those libraries back to 1.x since I don't think we need 2.x.

@eugeniyk
Copy link
Contributor Author

eugeniyk commented Jan 14, 2022 via email

@eed3si9n
Copy link
Member

Giter8 acts as a backend of sbt new, so using it as a plugin doesn't do much.
You can switch the Giter8 version for your template by putting

giter8.version = 0.14.0

in the project/build.properties of the template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect line-breaks in description property with manual line-breaks
2 participants