Integrate shfmt

[b1ek]

The mechanism can support multiple formatters, and selects the first one available in current environment

Closes #103

[arapower]

I've updated to the latest code with git pull.
After installing shfmt locally and running cargo test, I encountered the following errors:

failures:

---- tests::validity::array_init stdout ----
thread 'tests::validity::array_init' panicked at src/modules/formatter.rs:57:30:
Couldn't spawn shfmt: Os { code: 2, kind: NotFound, message: "No such file or directory" }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

---- tests::validity::bool stdout ----
thread 'tests::validity::bool' panicked at src/tests/validity.rs:53:5:
assertion `left == right` failed
  left: ""
 right: "1"

---- tests::validity::add stdout ----
thread 'tests::validity::add' panicked at src/tests/validity.rs:23:5:
assertion `left == right` failed
  left: ""
 right: "60"


failures:
    tests::validity::add
    tests::validity::array_init
    tests::validity::bool

test result: FAILED. 87 passed; 3 failed; 0 ignored; 0 measured; 0 filtered out; finished in 12.05s

error: test failed, to rerun pass `--bin amber`

At other times, the following error may occur during execution.

failures:

---- tests::validity::array_assign stdout ----
thread 'tests::validity::array_assign' panicked at src/modules/formatter.rs:57:30:
Couldn't spawn shfmt: Os { code: 2, kind: NotFound, message: "No such file or directory" }

---- tests::validity::array_init stdout ----
thread 'tests::validity::array_init' panicked at src/modules/formatter.rs:57:30:
Couldn't spawn shfmt: Os { code: 2, kind: NotFound, message: "No such file or directory" }
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

---- tests::validity::add_arrays_literal stdout ----
thread 'tests::validity::add_arrays_literal' panicked at src/modules/formatter.rs:57:30:
Couldn't spawn shfmt: Os { code: 2, kind: NotFound, message: "No such file or directory" }

---- tests::validity::array_assign_out_of_bounds stdout ----
thread 'tests::validity::array_assign_out_of_bounds' panicked at src/modules/formatter.rs:57:30:
Couldn't spawn shfmt: Os { code: 2, kind: NotFound, message: "No such file or directory" }

---- tests::validity::bool stdout ----
thread 'tests::validity::bool' panicked at src/modules/formatter.rs:57:30:
Couldn't spawn shfmt: Os { code: 2, kind: NotFound, message: "No such file or directory" }

---- tests::validity::add stdout ----
thread 'tests::validity::add' panicked at src/tests/validity.rs:23:5:
assertion `left == right` failed
  left: ""
 right: "60"


failures:
    tests::validity::add
    tests::validity::add_arrays_literal
    tests::validity::array_assign
    tests::validity::array_assign_out_of_bounds
    tests::validity::array_init
    tests::validity::bool

test result: FAILED. 84 passed; 6 failed; 0 ignored; 0 measured; 0 filtered out; finished in 11.92s

error: test failed, to rerun pass `--bin amber`

[Ph0enixKM]

@arapower what is your default shell? It seems that this code doesn't run on bash? Correct me if I'm wrong

[arapower]

@Ph0enixKM
I am using Ubuntu on WSL2.

$ echo $SHELL
/bin/bash

[Ph0enixKM]

@b1ek btw I was thinking since src/modules is a directory for syntax modules - can we also move the files that are not-related to parsing syntax somewhere else? Like for ex. src/utils.

Beacuse src/modules/formatter.rs is more about formatting the output. I have to add a section about what dir means what in contribution section of README.md

[b1ek]

src/modulesis a directory for syntax modules, so should moveformatter.rs` into a different directory

sure, that makes sense

I have to add a section about what dir means what in contribution section of README.md

wouldn't it be better to create a separate guide for contributing in CONTRIBUTING.md?

[Ph0enixKM]

Oh yeah. It would. I'll create an issue for that

[Ph0enixKM]

I've added a draft issue in our project

[Mte90]

Any updates for this?
I have to do mmanually shfmt everytime.

[Ph0enixKM]

This issue should also cover the installation process of shfmt in the installer script. It should as user if they want to install it. If user has no bash formatted installed - then there shouldn’t be any warning.

I have to do mmanually shfmt everytime.

Could you make an amber script to compile and run and format in the meantime? I think that @b1ek has a lot of things on her plate right now. I don’t want to hurry anyone here as we all have other duties

[Mte90]

The command is shfmt -w script.sh a script seems to much I think

done

[Mte90]

The code now compiles and I tested locally and works :-D

[Ph0enixKM]

@Mte90 @b1ek We need to resolve conflicts here. Once done we'll merge this

[Mte90]

@Ph0enixKM fixed and tested locally.

[Mte90]

So I think that we can approve this PR, later we can create a ticket on how to evolve this integration.

[Ph0enixKM]

Looks good enough

to discuss in a future version