Add human-readable format (serialization only) #42
Conversation
|
I realized that there are some limitations to the current implementaion. A Seperate sub-command to only convert the format (toml, json, yaml) to text would be better... I will modify the code as well as the README very soon. |
|
That's a great idea! Thanks for the PR, I'd very much like to get this in. |
|
Hi, i modifed the code slightly now it works as intented. I also formatted the files to the linter won't cry at me :) |
sstadick
left a comment
sstadick
left a comment
There was a problem hiding this comment.
Overall this looks great! I just want to nail down the naming of the new flag / make it clear how it's working via the name since it kind of short circuits the checking logic.
| #[structopt(long, short)] | ||
| human_readable_artifact: bool, |
There was a problem hiding this comment.
question: would you be opposed to adding HumanReadable as a format::Format?
And then we could avoid a special-case flag and handling for just outputing a text file.
Alternatively, I think adding a subcommand for this, or calling this flag convert_to_human_readable_only or something like that to make it clear what this is doing.
| mut output: Box<dyn Write + Send>, | ||
| ) -> Result<(), std::io::Error> { | ||
| let content = format!("{self}"); | ||
| output.write_all(content.as_bytes())?; |
There was a problem hiding this comment.
suggestion: would `write!(&mut output, "{}", self)?; work here? That may avoid creating the intermediate string.
| } | ||
| } | ||
|
|
||
| pub fn get_third_party_libraries(&self) -> Vec<FinalizedLicense> { |
There was a problem hiding this comment.
question: is this used somewhere else? If not can it be removed?
| Currently the supported formats are `json`, `yaml`, and `toml`. A more human readable format that is closer to a classical THIRDPARTY file and already has `serde` support is being actively sought. Please create an issue or PR if you have an idea for this. | ||
| Currently the supported formats are `json`, `yaml`, and `toml`. | ||
|
|
||
| You can also export those previously exported (and maybe edited) files to a human-readable format with `--human-readable-artifact` |
There was a problem hiding this comment.
| You can also export those previously exported (and maybe edited) files to a human-readable format with `--human-readable-artifact` | |
| You can also convert those previously exported (and maybe edited) files to a human-readable format with `--human-readable-artifact` |
|
Would it maybe instead make sense to make the fields of the That way one could implement a human readable format oneself, based on their own requirements. |
3 participants
Hey, i needed this for my project. Maybe it could be helpful to others as well.