Add --fix-dry-run option
#665
Conversation
| @@ -13,6 +13,7 @@ const cli = meow(` | |||
|
|
|||
| Options | |||
| --fix Automagically fix issues | |||
| --fix-dry-run Automatically fix problems without saving the changes to the file system | |||
There was a problem hiding this comment.
I feel like it's unclear to the user how this would even work. The user will ask themselves: "If it does not save to the file system, what's the point of it?"
There was a problem hiding this comment.
--fix-dry-run Automatically fix problems without saving the changes to the file system.
Because the default formatter does not output the fixed code, you'll have to use another one (e.g. json)
This flag can be useful for integrations which need to autofix text from command line without saving it to the filesystem.
Note that `fix-dry-run` is mutually exclusive with the `fix` option.
How about the above one?
I'm worried about only this option's description looks too verbose because the other options' descriptions are all single lines.
These descriptions are copy-pasted from https://eslint.org/docs/user-guide/command-line-interface#--fix-dry-run without the last sentense.
There was a problem hiding this comment.
Perhaps "Preview fixed file contents" or "Print fixed file contents"?
| --fix-dry-run Automatically fix problems without saving the changes to the file system | |
| --fix-dry-run Preview fixed file contents |
lib/options-manager.js
Outdated
| @@ -309,6 +309,13 @@ const buildESLintConfig = options => config => { | |||
| }; | |||
| } | |||
|
|
|||
| // ESLint does not expose a `fixDryRun` option in the programmatic API. | |||
| // Instead of using `fixDryRun` itself, the option is internally translated to `fix` option in ESLint's CLI module. | |||
| // https://github.com/eslint/eslint/blob/901ce0f1e32ea1e9e10ce4d8b37c0d750007a3c5/lib/cli.js#L96 | |||
There was a problem hiding this comment.
This does not make it clear how it then manages to be a "dry-run". The important part is missing.
Fixes #663.
Eslint doesn't expose
fixDryRunoption in programmatic API.fixDryRunis internally translated tofixoption and don't callESLint.outputFixes.(Ref: eslint/eslint#15877)
So I think
xocould handle this option similarly.fixDryRunis translated tofixoption before passing to ESLint constructor, andxo.outputFixeswould not be called sincethe
fixoption is false.