Fix conflict (internal, external) for pre-commit and update SVG

[namgyu-youn]

Inspired by pre-commit#2240 and chromium-bidi#1834, double-run for pre-commit could be useful for resolving pre-commit conflicts.

Also, SVG in README.md is updated beacuse it wasn't updated in (#133)

[tsunghsienlee]

Is it possible to fix ruff-format to let it format but without complaining first? This was mentioned in #121 (comment) because I foresaw this conflicts between internal and external formatting. Ideally I want pre-commit does to format files but GitHub just acknowledge the internal setting is the dominant ones.

[namgyu-youn]

Is it possible to fix ruff-format to let it format but without complaining first? This was mentioned in #121 (comment) because I foresaw this conflicts between internal and external formatting. Ideally I want pre-commit does to format files but GitHub just acknowledge the internal setting is the dominant ones.

Now I see the solution after reading some docs (ruff#15746, ruff#16009, ruff - docs). The point is, GitHub Actions (pre-commit.yaml) returns non-zero (1) value when safe reformatting is detected. Therefore, we can try "return zero(0) when safe reformatting is detected." (when there is no change because full codebase pass pre-commit run --all-files, zero is returned)

Lcukily, there are some parameters related to this issue:

--exit-zero
    Exit with status code "0", even upon detecting lint violations
--exit-non-zero-on-format
    Exit with a non-zero status code if any files were modified via
    format, even if all files were formatted successfully

And --exit-zero seems to be useful because it returns zero although safe reformat is detected.

[tsunghsienlee]

Is it possible to fix ruff-format to let it format but without complaining first? This was mentioned in #121 (comment) because I foresaw this conflicts between internal and external formatting. Ideally I want pre-commit does to format files but GitHub just acknowledge the internal setting is the dominant ones.

Now I see the solution after reading some docs (ruff#15746, ruff#16009, ruff - docs). The point is, GitHub Actions (pre-commit.yaml) returns non-zero (1) value when safe reformatting is detected. Therefore, we can try "return zero(0) when safe reformatting is detected." (when there is no change because full codebase pass pre-commit run --all-files, zero is returned)

Lcukily, there are some parameters related to this issue:

--exit-zero
    Exit with status code "0", even upon detecting lint violations
--exit-non-zero-on-format
    Exit with a non-zero status code if any files were modified via
    format, even if all files were formatted successfully

And --exit-zero seems to be useful because it returns zero although safe reformat is detected.

Great, this is exactly I want. Really appreciate that you dig into this and find this solution to achieve a good balance for both internal and external developers!

[namgyu-youn]

Is it possible to fix ruff-format to let it format but without complaining first? This was mentioned in #121 (comment) because I foresaw this conflicts between internal and external formatting. Ideally I want pre-commit does to format files but GitHub just acknowledge the internal setting is the dominant ones.

Now I see the solution after reading some docs (ruff#15746, ruff#16009, ruff - docs). The point is, GitHub Actions (pre-commit.yaml) returns non-zero (1) value when safe reformatting is detected. Therefore, we can try "return zero(0) when safe reformatting is detected." (when there is no change because full codebase pass pre-commit run --all-files, zero is returned)
Lcukily, there are some parameters related to this issue:

--exit-zero
    Exit with status code "0", even upon detecting lint violations
--exit-non-zero-on-format
    Exit with a non-zero status code if any files were modified via
    format, even if all files were formatted successfully

And --exit-zero seems to be useful because it returns zero although safe reformat is detected.

Great, this is exactly I want. Really appreciate that you dig into this and find this solution to achieve a good balance for both internal and external developers!

Sorry I just found --exit-zero only works in check, and --exit-non-zero-on-format only works in format. It can't be resolved using --exit-zero; I have to read more docs...

[namgyu-youn]

Is it possible to fix ruff-format to let it format but without complaining first? This was mentioned in #121 (comment) because I foresaw this conflicts between internal and external formatting. Ideally I want pre-commit does to format files but GitHub just acknowledge the internal setting is the dominant ones.

Maybe we thought this issue too complex. Because both (internal & external) use ruff, just double-running pre-commit in GitHub Actions could be useful in this case.

There is the same issue in pre-commit#2240, and it is resolved in chromium-bidi#1834. It was addressed for the following desired change:

  if everything is green, exit 0
  if things were autofixed, but otherwise everything is ok, still exit 0
  if something is broken and/or not autofix-able, exit nonzero

--exit-zero could be useful for some cases, but I am fine to go with double-run.

[tsunghsienlee]

Is it possible to fix ruff-format to let it format but without complaining first? This was mentioned in #121 (comment) because I foresaw this conflicts between internal and external formatting. Ideally I want pre-commit does to format files but GitHub just acknowledge the internal setting is the dominant ones.

Maybe we thought this issue too complex. Because both (internal & external) use ruff, just double-running pre-commit in GitHub Actions could be useful in this case.

There is the same issue in pre-commit#2240, and it is resolved in chromium-bidi#1834. It was addressed for the following desired change:

  if everything is green, exit 0
  if things were autofixed, but otherwise everything is ok, still exit 0
  if something is broken and/or not autofix-able, exit nonzero

--exit-zero could be useful for some cases, but I am fine to go with double-run.

Got it, double-run definitely is a smart idea because each run of ruff-format is extremely fast and the formatting operation is idempotent.

[facebook-github-bot]

@tsunghsienlee has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

[facebook-github-bot]

@tsunghsienlee merged this pull request in 5034dc4.