refactor and polish the source code of the library #29
Commits on Jun 16, 2023
-
rename the library into
nu_formatterthe goal of this commit is to make a clear distinction between the library which does all the heavy lifting and the binary application which mainly just parses the arguments and calls the library. because i think the application is clearly called `nufmt` i propose here to change the name of the library to `nu_formatter`. i also thought about `nufmt_lib`! this has the huge benefit of making two separate items in the `cargo doc` instead of two with the same `nufmt` name :/ ``` cargo doc --document-private-items --bin nufmt --open ``` directly opens the doc on the application page with the help and the usage, which i find bette :)
-
link the
main.rsdoc to the READMEthis commit is here to make the maintainance of the doc easier: change the README and bam, the doc of the `nufmt` binary is up-to-date!
-
otherwise, warnings from the documentation and the benchmarks for instance are not seen when running the CI or `toolkit clippy` :o we also make sure we use the same clippy command in the toolkit.
-
use log instead of print except with formatting a string
when formatting a string from stdin we need to return the result directly to stdout.
-
in order to have a slice from `cli.files`, i think `cli.files[..]`, i.e. the whole slice from `cli.files`, is easier to work with than `&*cli.files` and does not require any additional comment.
-
implement the "windows newline" trick
because on windows we add `\r\n` and only `\n` on linux, we can just conditionally add `\r` when on windows and then always add `\n`.
-
use a more expressive exit_code enum
this commit also removes the `Result` and `Ok` because there is no such error at all in `nu_formatter` for now.
-
-
-
-
-
-
-
fix the visibility of
nu_formatteritems- `trim_ascii_whitespaces` is never used outside `formatting` - the `formatting` commands are only used internally
-
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.