amtoine
commented
1 year ago cc/ @AucaCoyan
some questions remaining
Clippy missing doc errors (see here)
i think these errors are too strong and Rust is expressive enough in these cases :thinking: i propose applying the following patch to the toolkit
diff --git a/toolkit.nu b/toolkit.nu
index 5b421e8..6e986f0 100644
--- a/toolkit.nu
+++ b/toolkit.nu
@@ -51,8 +51,6 @@ export def clippy [
--
-D warnings
-D rustdoc::broken_intra_doc_links
- -W missing_docs
- -W clippy::missing_docs_in_private_items
-W clippy::explicit_iter_loop
-W clippy::explicit_into_iter_loop
-W clippy::semicolon_if_nothing_returnedto let developer add documentation when it makes the most sense :relieved:
Note the patch would have to be adapted for the CI
failing test on windows (see here)
in d4bb23a, i've implemented the windows case for adding a newline, which adds a \r\n but this breaks all the tests :thinking:
public functions
there are a bunch of public functions that are exported outside of nu_formatter
> rg '^\s*pub' | lines | parse "{file}:{match}"
╭────┬───────────────────┬──────────────────────────────────────────────────────────────────────────────╮
│ # │ file │ match │
├────┼───────────────────┼──────────────────────────────────────────────────────────────────────────────┤
│ 0 │ src/formatting.rs │ pub fn format_inner(contents: &[u8], _config: &Config) -> Vec<u8> { │
│ 1 │ src/formatting.rs │ pub fn trim_ascii_whitespace(x: &[u8]) -> &[u8] { │
│ 2 │ src/lib.rs │ pub mod config; │
│ 3 │ src/lib.rs │ pub mod formatting; │
│ 4 │ src/lib.rs │ pub fn format_single_file(file: &PathBuf, config: &Config) { │
│ 5 │ src/lib.rs │ pub fn format_string(input_string: &String, config: &Config) -> String { │
│ 6 │ src/config.rs │ pub struct Config { │
│ 7 │ src/config.rs │ pub tab_spaces: usize, │
│ 8 │ src/config.rs │ pub max_width: usize, │
│ 9 │ src/config.rs │ pub margin: usize, │
│ 10 │ src/config.rs │ pub fn new(tab_spaces: usize, max_width: usize, margin: usize) -> Self { │
╰────┴───────────────────┴──────────────────────────────────────────────────────────────────────────────╯i'm just wondering if we need that many exported things, e.g. we could use pub(crate) for those required inside the library and pub for those needed in nufmt?
AucaCoyan
this PR is all about refactoring the formatting library and executable :yum:
details
nu_formatternufmtprintin favor oflogcli.files,#[cfg(windows)]and exit codes)nu_formatterpublic