Refactor CLI argument parsing #467

grodin · 2024-05-17T14:41:18Z

Working towards #391.

I wanted to open this to get feedback on the approach.

I could have chosen to use exceptions, but I find sealed classes much more composable and I already anticipate adding another class to the ParseResult hierarchy to represent a situation where a message needs to be shown to the user but isn't an error (--help is the obvious example).

Closes #465 more or less as a side-effect.

Closes facebook#465

facebook-github-bot · 2024-05-17T14:41:24Z

Hi @grodin!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

grodin · 2024-05-17T14:42:40Z

Forgot to sign the CLA before opening this, done now

facebook-github-bot · 2024-05-17T15:06:13Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

hick209

I overall loved the direction things are going, keep it up! 👍

Just a few minor comments, but nothing serious. Let me know if you want to push this already and proceed with another PR or just build on top of this one.

core/src/main/java/com/facebook/ktfmt/cli/Main.kt

core/src/test/java/com/facebook/ktfmt/cli/ParsedArgsTest.kt

Intended to make testing of combination of CLI parameters easier

grodin · 2024-05-20T16:53:44Z

I overall loved the direction things are going, keep it up! 👍

Just a few minor comments, but nothing serious. Let me know if you want to push this already and proceed with another PR or just build on top of this one.

Probably worth separating them out into separate PRs. I've got some more nearly ready once this is merged.

Some of this is formatted with ktfmt, some isn't, but you said you'd handle that when you merge it internally, so I'll leave that to you.

hick209

So far so good to me. Let me know when this is ready and I'll import it for internal review (last step before we merge in)

hick209 · 2024-05-20T19:11:00Z

core/src/main/java/com/facebook/ktfmt/cli/Main.kt

@@ -173,4 +178,11 @@ class Main(
      throw e
    }
  }
+
+  fun exitFatal(message: String, returnCode: Int): Nothing {


Any reason this is not private?

Nope! Glad you caught that actually, it's part of some refactoring I haven't finished

hick209 · 2024-06-03T11:28:22Z

In case you are not going to work on it this week, let's start merging this already, you could make other changes in other PRs.

facebook-github-bot · 2024-06-04T13:19:43Z

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

grodin · 2024-06-04T18:41:58Z

In case you are not going to work on it this week, let's start merging this already, you could make other changes in other PRs.

Sorry, had a very busy period at home and on top of that, drive failure in my laptop, so I've not been able to work on this much. I am still very much intending to get more done on ktfmt, hopefully end of this week, definitely more next.

hick209 · 2024-06-05T11:44:15Z

No problem @grodin, I completely understand.
I went ahead and did some modifications to it and will merge this PR now. Feel free to submit some more 😃

Thanks a ton for your contributions, we're really grateful for that.

facebook-github-bot · 2024-06-05T13:06:29Z

@hick209 merged this pull request in 26a24ae.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [com.facebook:ktfmt](https://togithub.com/facebook/ktfmt) | dependencies | minor | `0.49` -> `0.50` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>facebook/ktfmt (com.facebook:ktfmt)</summary> ### [`v0.50`](https://togithub.com/facebook/ktfmt/releases/tag/v0.50): 0.50 #### Changelog - Add pre commit hooks to readme ([https://github.com/facebook/ktfmt/pull/462](https://togithub.com/facebook/ktfmt/pull/462)) – [@0x26res](https://togithub.com/0x26res) - Add homebrew installation note to readme ([https://github.com/facebook/ktfmt/pull/468](https://togithub.com/facebook/ktfmt/pull/468)) – [@chenrui333](https://togithub.com/chenrui333) - Refactor CLI argument parsing ([https://github.com/facebook/ktfmt/pull/467](https://togithub.com/facebook/ktfmt/pull/467)) – [@grodin](https://togithub.com/grodin) - Fix issue with context receive in lambdas ([https://github.com/facebook/ktfmt/issues/471](https://togithub.com/facebook/ktfmt/issues/471)) – [@hick209](https://togithub.com/hick209) - Don't reorder [@sample](https://togithub.com/sample) tag ([https://github.com/facebook/ktfmt/issues/406](https://togithub.com/facebook/ktfmt/issues/406)) – [@davidtorosyan](https://togithub.com/davidtorosyan) **Full Changelog**: facebook/ktfmt@v0.49...v0.50 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate).

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [com.facebook:ktfmt](https://togithub.com/facebookincubator/ktfmt) | dependencies | minor | `0.49` -> `0.50` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>facebookincubator/ktfmt (com.facebook:ktfmt)</summary> ### [`v0.50`](https://togithub.com/facebook/ktfmt/releases/tag/v0.50): 0.50 #### Changelog - Add pre commit hooks to readme ([https://github.com/facebook/ktfmt/pull/462](https://togithub.com/facebook/ktfmt/pull/462)) – [@0x26res](https://togithub.com/0x26res) - Add homebrew installation note to readme ([https://github.com/facebook/ktfmt/pull/468](https://togithub.com/facebook/ktfmt/pull/468)) – [@chenrui333](https://togithub.com/chenrui333) - Refactor CLI argument parsing ([https://github.com/facebook/ktfmt/pull/467](https://togithub.com/facebook/ktfmt/pull/467)) – [@grodin](https://togithub.com/grodin) - Fix issue with context receive in lambdas ([https://github.com/facebook/ktfmt/issues/471](https://togithub.com/facebook/ktfmt/issues/471)) – [@hick209](https://togithub.com/hick209) - Don't reorder [@sample](https://togithub.com/sample) tag ([https://github.com/facebook/ktfmt/issues/406](https://togithub.com/facebook/ktfmt/issues/406)) – [@davidtorosyan](https://togithub.com/davidtorosyan) **Full Changelog**: facebook/ktfmt@v0.49...v0.50 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate).

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.facebook:ktfmt](https://togithub.com/facebook/ktfmt) | `0.49` -> `0.51` | [![age](https://developer.mend.io/api/mc/badges/age/maven/com.facebook:ktfmt/0.51?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/maven/com.facebook:ktfmt/0.51?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/maven/com.facebook:ktfmt/0.49/0.51?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/maven/com.facebook:ktfmt/0.49/0.51?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>facebook/ktfmt (com.facebook:ktfmt)</summary> ### [`v0.51`](https://togithub.com/facebook/ktfmt/blob/HEAD/CHANGELOG.md#051) ##### Added - Created CHANGELOG.md - Added --help option to CLI ([https://github.com/facebook/ktfmt/pull/477](https://togithub.com/facebook/ktfmt/pull/477)) ##### Changed - Preserves blank spaces between when clauses ([https://github.com/facebook/ktfmt/issues/342](https://togithub.com/facebook/ktfmt/issues/342)) - Named the default style as `Formatter.META_FORMAT` / `--meta-style` - `FormattingOptions` constructor parameters order was changed ##### Fixed - Compilation issues with online formatter (facebook/ktfmt@8605080) - Removing valid semicolons ([https://github.com/facebook/ktfmt/issues/459](https://togithub.com/facebook/ktfmt/issues/459)) - Incorrect detection of unused `assign` import ([https://github.com/facebook/ktfmt/issues/411](https://togithub.com/facebook/ktfmt/issues/411)) ##### Removed - **Deleted `Formatter.DROPBOX_FORMAT` / `--dropbox-style` (BREAKING CHANGE)** - Deleted `FormattingOptions.Style` enum ### [`v0.50`](https://togithub.com/facebook/ktfmt/releases/tag/v0.50): 0.50 #### Changelog - Add pre commit hooks to readme ([https://github.com/facebook/ktfmt/pull/462](https://togithub.com/facebook/ktfmt/pull/462)) – [@0x26res](https://togithub.com/0x26res) - Add homebrew installation note to readme ([https://github.com/facebook/ktfmt/pull/468](https://togithub.com/facebook/ktfmt/pull/468)) – [@chenrui333](https://togithub.com/chenrui333) - Refactor CLI argument parsing ([https://github.com/facebook/ktfmt/pull/467](https://togithub.com/facebook/ktfmt/pull/467)) – [@grodin](https://togithub.com/grodin) - Fix issue with context receive in lambdas ([https://github.com/facebook/ktfmt/issues/471](https://togithub.com/facebook/ktfmt/issues/471)) – [@hick209](https://togithub.com/hick209) - Don't reorder [@sample](https://togithub.com/sample) tag ([https://github.com/facebook/ktfmt/issues/406](https://togithub.com/facebook/ktfmt/issues/406)) – [@davidtorosyan](https://togithub.com/davidtorosyan) **Full Changelog**: facebook/ktfmt@v0.49...v0.50 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/ZacSweers/CatchUp).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Refactor CLI argument parsing

8defaca

Closes facebook#465

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 17, 2024

hick209 approved these changes May 17, 2024

View reviewed changes

core/src/main/java/com/facebook/ktfmt/cli/Main.kt Outdated Show resolved Hide resolved

core/src/main/java/com/facebook/ktfmt/cli/Main.kt Outdated Show resolved Hide resolved

core/src/test/java/com/facebook/ktfmt/cli/ParsedArgsTest.kt Show resolved Hide resolved

Joseph Cooper added 2 commits May 20, 2024 16:50

Rename Main param args to inputArgs

e046dd0

Add parameterized argument parsing test

01ac34f

Intended to make testing of combination of CLI parameters easier

hick209 approved these changes May 20, 2024

View reviewed changes

hick209 reviewed May 20, 2024

View reviewed changes

facebook-github-bot closed this in 26a24ae Jun 5, 2024

facebook-github-bot added the Merged label Jun 5, 2024

hick209 mentioned this pull request Jun 5, 2024

feat(cli): support max width arg #470

Closed

BrewTestBot mentioned this pull request Jun 7, 2024

ktfmt 0.50 Homebrew/homebrew-core#173937

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor CLI argument parsing #467

Refactor CLI argument parsing #467

grodin commented May 17, 2024

facebook-github-bot commented May 17, 2024

grodin commented May 17, 2024

facebook-github-bot commented May 17, 2024

hick209 left a comment

grodin commented May 20, 2024

hick209 left a comment

hick209 May 20, 2024

grodin May 21, 2024

hick209 commented Jun 3, 2024

facebook-github-bot commented Jun 4, 2024

grodin commented Jun 4, 2024

hick209 commented Jun 5, 2024

facebook-github-bot commented Jun 5, 2024

Refactor CLI argument parsing #467

Refactor CLI argument parsing #467

Conversation

grodin commented May 17, 2024

facebook-github-bot commented May 17, 2024

Action Required

Process

grodin commented May 17, 2024

facebook-github-bot commented May 17, 2024

hick209 left a comment

Choose a reason for hiding this comment

grodin commented May 20, 2024

hick209 left a comment

Choose a reason for hiding this comment

hick209 May 20, 2024

Choose a reason for hiding this comment

grodin May 21, 2024

Choose a reason for hiding this comment

hick209 commented Jun 3, 2024

facebook-github-bot commented Jun 4, 2024

grodin commented Jun 4, 2024

hick209 commented Jun 5, 2024

facebook-github-bot commented Jun 5, 2024