4 ms·

I thought oxfmt would just be a faster drop-in replacement for "biome format"... It wasn't. Let this be a warning: running oxfmt without any arguments recursiv

by Grom_PE 7mo ago

I thought oxfmt would just be a faster drop-in replacement for "biome format"... It wasn't. Let this be a warning: running oxfmt without any arguments recursively scans directory tree from the current directory for all *.js and *.ts files and silently reformats them. Thanks to that, I got a few of my Allman-formatted JavaScript files I care about messed up with no option to format them back from K&R style.

phplovesong 7mo ago
Git undo?
- ctmnt 7mo ago
  If only. But `jj undo`?
jagged-chisel 7mo ago
These files are under version control, right? Or backed up. Right?
- watt 7mo ago
  until the day you accidentally run it in your home directory without any arguments.
ramon156 7mo ago
Do you not use a VCS?
tomashubelbauer 7mo ago
> running oxfmt without any arguments recursively scans directory tree from the current directory for all .js and .ts files and silently reformats them I've got to say this is what I would have expected and wanted to happen. I'd say it is wise to not run tools designed to edit files on files you don't have a backup for (like Git) without doing a dry-run or a small scope experiment first.
- vladvasiliu 7mo ago
  While I can get behind things such as "use version control," "use backups", etc. this is definitely not what I'd expect from a program run without arguments, especially when it will go and change stuff.
  - Tadpole9181 7mo ago
    What? The very first page of documentation tells you this. The help screen clearly shows a `--check` argument. This is a formatter and uses the same arguments as many others - in particular Prettier, the most popular formatter in the ecosystem. How were you not expecting this? Did you not bother to read anything before installing and running this command on a sensitive codebase?
    - vladvasiliu 7mo ago
      I do usually run new tools from somewhere harmless, like ~/tmp, just in case they do something unexpected. But most formatters I'm used to absolutely don't do this. For example, `rustfmt` will read input from stdin if no argument is given. It can traverse modules in a project, but it won't start modifying everything under your CWD. Most unix tools will either wait for some stdin or dump some kind of help when no argument is given. Hell, according to this tool's docs, even `prettier` seems to expect an argument: > Running oxfmt without arguments formats the current directory (*equivalent to prettier --write .*) I'm not familiar with prettier, so I may be wrong, but from the above, I understand that prettier doesn't start rewriting files if no argument is given? Looking up prettier's docs, they have this to say: > --write This rewrites all processed files in place. *This is comparable to the eslint --fix* workflow. So eslint also doesn't automatically overwrite everything? So yeah, I can't say this is expected behaviour, even if it's documented.
      - johnny22 7mo ago
        a more related tool would be prettier, which also has a --write option
Sammi 7mo ago
This is user error. oxfmt did what you asked it to do.
- rk06 7mo ago
  I don't think so. If someone runs a tool without args, the tool should do equivalent of "tool --help" It is bad ux.
  - Sammi 7mo ago
    I expect a file formatter to format the files when I call it. Anything else would be surprising to me.
    - rk06 7mo ago
      a new user should not expected to know whether to use "--info", "--help", or "-info" or "/info" A power user can just pass the right params. Besides, it is not that hard to support "--yolo" parameter for that use case
      - xigoi 7mo ago
        Would you enjoy writing `rm --yolo file` instead of `rm file` every time?
        user3939382 7mo ago
        Not taking a position but the design of rm strengthens the position that recursive by default without flags isn’t ok. rm makes you confirm when you want changes to recurse dirs.
        phcreery 7mo ago
        In this case, "file" is the arg, not --yolo. `rm` without any args returns `` rm: missing operand Try 'rm --help' for more information. ``` `oxfmt` should have done the same and `oxfmt .`, with the desired dir ".", should have been the required usage.
nindalf 7mo ago
> with no option to format them back Try git reset --hard, that should work.
monster_truck 7mo ago
You couldn't waterboard this outta me
ctmnt 7mo ago
I assume you mean what’s more properly called Java style [1], where the first curly brace is on the same line as the function declaration (or class declaration, but if you’re using Allman style you’re probably not using classes; no shade, I’m a JS class hater myself) [2] or control statement [3], the elses (etc) are cuddled, and single statement blocks are enclosed in curly braces. Except I also assume that oxfmt’s default indentation is 2 spaces, following Prettier [4], whereas Java style specified 4. So maybe we should call it JavaScript style? Modern JS style? Do we have a good name for it? Also, does anyone know when and why “K&R style” [5] started being used to refer to Java style? Meaning K&R statement block style (“Egyptian braces” [6]) being used for all braces and single statement blocks getting treated the same as multi-statement blocks. Setting aside the eternal indentation question. 1: https://en.wikipedia.org/wiki/Indentation_style#Java https://en.wikipedia.org/wiki/Indentation_style#Java 2: https://www.oracle.com/java/technologies/javase/codeconventions-declarations.html https://www.oracle.com/java/technologies/javase/codeconventi... 3: https://www.oracle.com/java/technologies/javase/codeconventions-statements.html https://www.oracle.com/java/technologies/javase/codeconventi... 4: https://prettier.io/docs/options#tab-width https://prettier.io/docs/options#tab-width 5: https://ia903407.us.archive.org/35/items/the-ansi-c-programming-language-by-brian-w.-kernighan-dennis-m.-ritchie.org/The%20ANSI%20C%20Programming%20Language%20by%20Brian%20W.%20Kernighan%2C%20Dennis%20M.%20Ritchie.pdf https://ia903407.us.archive.org/35/items/the-ansi-c-programm... 6: https://en.wikipedia.org/wiki/Indentation_style#Egyptian_braces https://en.wikipedia.org/wiki/Indentation_style#Egyptian_bra...
ljm 7mo ago
Well, one way to boost this command to fame is to open an issue on the repo and crash out.[0] [0] https://github.com/microsoft/vscode/issues/32405 https://github.com/microsoft/vscode/issues/32405

by Grom_PE 7mo ago

phplovesong 7mo ago

Git undo?

ctmnt 7mo ago
If only. But `jj undo`?

jagged-chisel 7mo ago

These files are under version control, right? Or backed up. Right?

watt 7mo ago
until the day you accidentally run it in your home directory without any arguments.

ramon156 7mo ago

Do you not use a VCS?

tomashubelbauer 7mo ago

> running oxfmt without any arguments recursively scans directory tree from the current directory for all .js and .ts files and silently reformats them I've got to say this is what I would have expected and wanted to happen. I'd say it is wise to not run tools designed to edit files on files you don't have a backup for (like Git) without doing a dry-run or a small scope experiment first.

vladvasiliu 7mo ago
While I can get behind things such as "use version control," "use backups", etc. this is definitely not what I'd expect from a program run without arguments, especially when it will go and change stuff.
- Tadpole9181 7mo ago
  What? The very first page of documentation tells you this. The help screen clearly shows a `--check` argument. This is a formatter and uses the same arguments as many others - in particular Prettier, the most popular formatter in the ecosystem. How were you not expecting this? Did you not bother to read anything before installing and running this command on a sensitive codebase?
  - vladvasiliu 7mo ago
    I do usually run new tools from somewhere harmless, like ~/tmp, just in case they do something unexpected. But most formatters I'm used to absolutely don't do this. For example, `rustfmt` will read input from stdin if no argument is given. It can traverse modules in a project, but it won't start modifying everything under your CWD. Most unix tools will either wait for some stdin or dump some kind of help when no argument is given. Hell, according to this tool's docs, even `prettier` seems to expect an argument: > Running oxfmt without arguments formats the current directory (*equivalent to prettier --write .*) I'm not familiar with prettier, so I may be wrong, but from the above, I understand that prettier doesn't start rewriting files if no argument is given? Looking up prettier's docs, they have this to say: > --write This rewrites all processed files in place. *This is comparable to the eslint --fix* workflow. So eslint also doesn't automatically overwrite everything? So yeah, I can't say this is expected behaviour, even if it's documented.
    - johnny22 7mo ago
      a more related tool would be prettier, which also has a --write option

Sammi 7mo ago

This is user error. oxfmt did what you asked it to do.

rk06 7mo ago
I don't think so. If someone runs a tool without args, the tool should do equivalent of "tool --help" It is bad ux.
- Sammi 7mo ago
  I expect a file formatter to format the files when I call it. Anything else would be surprising to me.
  - rk06 7mo ago
    a new user should not expected to know whether to use "--info", "--help", or "-info" or "/info" A power user can just pass the right params. Besides, it is not that hard to support "--yolo" parameter for that use case
    - xigoi 7mo ago
      Would you enjoy writing `rm --yolo file` instead of `rm file` every time?
      - user3939382 7mo ago
        Not taking a position but the design of rm strengthens the position that recursive by default without flags isn’t ok. rm makes you confirm when you want changes to recurse dirs.
      - phcreery 7mo ago
        In this case, "file" is the arg, not --yolo. `rm` without any args returns `` rm: missing operand Try 'rm --help' for more information. ``` `oxfmt` should have done the same and `oxfmt .`, with the desired dir ".", should have been the required usage.

nindalf 7mo ago

> with no option to format them back Try git reset --hard, that should work.

monster_truck 7mo ago

You couldn't waterboard this outta me

ctmnt 7mo ago

I assume you mean what’s more properly called Java style [1], where the first curly brace is on the same line as the function declaration (or class declaration, but if you’re using Allman style you’re probably not using classes; no shade, I’m a JS class hater myself) [2] or control statement [3], the elses (etc) are cuddled, and single statement blocks are enclosed in curly braces. Except I also assume that oxfmt’s default indentation is 2 spaces, following Prettier [4], whereas Java style specified 4. So maybe we should call it JavaScript style? Modern JS style? Do we have a good name for it? Also, does anyone know when and why “K&R style” [5] started being used to refer to Java style? Meaning K&R statement block style (“Egyptian braces” [6]) being used for all braces and single statement blocks getting treated the same as multi-statement blocks. Setting aside the eternal indentation question. 1: https://en.wikipedia.org/wiki/Indentation_style#Java https://en.wikipedia.org/wiki/Indentation_style#Java 2: https://www.oracle.com/java/technologies/javase/codeconventions-declarations.html https://www.oracle.com/java/technologies/javase/codeconventi... 3: https://www.oracle.com/java/technologies/javase/codeconventions-statements.html https://www.oracle.com/java/technologies/javase/codeconventi... 4: https://prettier.io/docs/options#tab-width https://prettier.io/docs/options#tab-width 5: https://ia903407.us.archive.org/35/items/the-ansi-c-programming-language-by-brian-w.-kernighan-dennis-m.-ritchie.org/The%20ANSI%20C%20Programming%20Language%20by%20Brian%20W.%20Kernighan%2C%20Dennis%20M.%20Ritchie.pdf https://ia903407.us.archive.org/35/items/the-ansi-c-programm... 6: https://en.wikipedia.org/wiki/Indentation_style#Egyptian_braces https://en.wikipedia.org/wiki/Indentation_style#Egyptian_bra...

ljm 7mo ago

Well, one way to boost this command to fame is to open an issue on the repo and crash out.[0] [0] https://github.com/microsoft/vscode/issues/32405 https://github.com/microsoft/vscode/issues/32405