Enable tldr to format the output as a json #20
Merged
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
MarcoSignoretto
commented
Jul 4, 2023
Comment on lines
+1
to
+13
| root = true | ||
|
|
||
| [*] | ||
| end_of_line = lf | ||
| insert_final_newline = true | ||
| charset = utf-8 | ||
|
|
||
| [*.{kt,kts,gradle}] | ||
| indent_style = space | ||
| indent_size = 2 | ||
| ij_kotlin_name_count_to_use_star_import = 2147483647 | ||
| ij_kotlin_name_count_to_use_star_import_for_members = 2147483647 | ||
| ij_kotlin_packages_to_use_import_on_demand = |
There was a problem hiding this comment.
Adding it here to avoid people having to manually configure it
MarcoSignoretto
commented
Jul 4, 2023
| @@ -115,7 +85,7 @@ private fun partitionDifferences( | |||
| removedVersion != null -> { | |||
| mutableRemovedMap.remove(artifact) | |||
| upgrades.add( | |||
| VersionedDependency(artifact, "$version, (changed from $removedVersion)")) | |||
There was a problem hiding this comment.
changing it to store the otherVersion in field of VersionedDependency to decouple printing logic from business logic
MarcoSignoretto
commented
Jul 4, 2023
| @@ -133,20 +103,4 @@ private fun partitionDifferences( | |||
| ) | |||
| } | |||
|
|
|||
| private fun StringBuilder.writeList(title: String, list: List<VersionedDependency>, newLineBeforeTitle: Boolean = false) { | |||
There was a problem hiding this comment.
just moved to the printer.kt file
MarcoSignoretto
commented
Jul 4, 2023
| @@ -65,7 +65,7 @@ fun upgradeEffects(old: String, new: String, collapseKeys: List<String>): String | |||
| if (index > 0) { | |||
| appendLine() | |||
| } | |||
| append("Changing ${effects.first.artifact} to ${effects.first.version} will also change:") | |||
| append("Changing ${effects.first.artifact} to ${effects.first.version}${effects.first.alternativeVersion?.let { ", (changed from $it)"}} will also change:") | |||
There was a problem hiding this comment.
this is to stay backward compatible and print on the same way as before
MarcoSignoretto
commented
Jul 4, 2023
MarcoSignoretto
commented
Jul 4, 2023
|
|
||
| private val old by argument("old.txt").path(mustExist = true) | ||
| private val new by argument("new.txt").path(mustExist = true) | ||
|
|
||
| override fun run() { | ||
| val oldContents = old.readText() | ||
| val newContents = new.readText() | ||
| print(tldr(oldContents, newContents, collapse)) | ||
| print(tldr(oldContents, newContents), collapse, outputType = output.toOutputType()) |
There was a problem hiding this comment.
this print is the new print, it allows to decouple the output of tldr function and the printing logic
MarcoSignoretto
commented
Jul 4, 2023
Comment on lines
+27
to
+34
| private fun writeJson(versionDifferences: VersionDifferences, collapse: List<String>): String = buildString { | ||
| val (added, removed, upgraded) = versionDifferences | ||
| append("{") | ||
| writeJsonObject("new_dependencies", added, trailingComma = true) | ||
| writeJsonObject("removed_dependencies", removed, trailingComma = true) | ||
| writeJsonObject("upgraded_dependencies", collapseDependencies(upgraded, collapse)) | ||
| append("}") | ||
| } |
There was a problem hiding this comment.
this is the new function
There was a problem hiding this comment.
I didn't add any third party since this json is quite simple and adding a third party dependency doesn't add much value for this use case
This patch adds the capability to get the tldr output in json format.
MarcoSignoretto
force-pushed
the
feature/json-output
branch
from
b97a5ce
to
25929ea
Compare
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.
This patch adds the capability to get the tldr output in json format.