Skip to content

Add new line to cmdio JSON rendering#443

Merged
shreyas-goenka merged 3 commits intomainfrom
new-line-on-render
Jun 8, 2023
Merged

Add new line to cmdio JSON rendering#443
shreyas-goenka merged 3 commits intomainfrom
new-line-on-render

Conversation

@shreyas-goenka
Copy link
Copy Markdown
Contributor

@shreyas-goenka shreyas-goenka commented Jun 5, 2023

Changes

This PR adds a new line break to JSON rendering using cmdio. This is useful when we call cmdio.Render multiple times

Tests

Manually

@shreyas-goenka
Copy link
Copy Markdown
Contributor Author

shreyas-goenka commented Jun 5, 2023

Before:

shreyas.goenka@THW32HFW6T bricks % cli fs ls dbfs:/user/hive --output=json
[
  {
    "name":"warehouse",
    "is_directory":true,
    "size":0,
    "last_modified":"2023-06-05T11:49:22+02:00"
  }
]%

After:

shreyas.goenka@THW32HFW6T bricks % cli fs ls dbfs:/user/hive --output=json
[
  {
    "name":"warehouse",
    "is_directory":true,
    "size":0,
    "last_modified":"2023-06-05T11:49:22+02:00"
  }
]

Note the absence of % in the last line of the output, which indicates a new line character in iterm2

@shreyas-goenka shreyas-goenka requested review from nfx and pietern June 5, 2023 22:21
@shreyas-goenka shreyas-goenka mentioned this pull request Jun 5, 2023
Closed
pietern
pietern reviewed Jun 6, 2023
View reviewed changes
libs/cmdio/render.go
if err != nil {
return err
}
_, err = w.Write([]byte("\r\n"))
Copy link
Copy Markdown
Contributor

@pietern pietern Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please stick to \n only. On Windows folks seem to get by with \n alone as well.

Copy link
Copy Markdown
Contributor Author

@shreyas-goenka shreyas-goenka Jun 6, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems to be the case when using \n with println. I am not so sure about io writer though. We do the same for sync progress events:

cli/cmd/sync/output.go

Line 49 in be10ff9

bw.WriteString("\r\n")

Maybe it's worthwhile testing it out on windows?

Copy link
Copy Markdown
Collaborator

@nfx nfx Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, please check it on windows

Copy link
Copy Markdown
Contributor

@pietern pietern Jun 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fmt.Println goes through an io.Writer, the two operate at different levels.

Please file a follow up to check out if \n alone is good enough. Use of \r\n on Unix systems could be problematic so I prefer using \n everywhere. If it's good enough for the Go stdlib it is good enough for us.

Copy link
Copy Markdown
Contributor Author

@shreyas-goenka shreyas-goenka Jun 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Followup filed at #451

@shreyas-goenka shreyas-goenka requested a review from pietern June 6, 2023 13:18
@shreyas-goenka shreyas-goenka mentioned this pull request Jun 8, 2023
Closed
@shreyas-goenka shreyas-goenka merged commit 53164ae into main Jun 8, 2023
@shreyas-goenka shreyas-goenka deleted the new-line-on-render branch June 8, 2023 13:48
@pietern pietern mentioned this pull request Jun 12, 2023
Merged
pietern added a commit that referenced this pull request Jun 12, 2023
@pietern
Release v0.100.3 (#461)
35dd56c 
## Changes

CLI:
* Add directory tracking to sync
([#425](#425)).
* Add fs cat command for dbfs files
([#430](#430)).
* Add fs ls command for dbfs
([#429](#429)).
* Add fs mkdirs command for dbfs
([#432](#432)).
* Add fs rm command for dbfs
([#433](#433)).
* Add installation instructions
([#458](#458)).
* Add new line to cmdio JSON rendering
([#443](#443)).
* Add profile on `databricks auth login`
([#423](#423)).
* Add readable console logger
([#370](#370)).
* Add workspace export-dir command
([#449](#449)).
* Added secrets input prompt for secrets put-secret command
([#413](#413)).
* Added spinner when loading command prompts
([#420](#420)).
* Better error message if can not load prompts
([#437](#437)).
* Changed service template to correctly handle required positional
arguments ([#405](#405)).
* Do not generate prompts for certain commands
([#438](#438)).
* Do not prompt for List methods
([#411](#411)).
* Do not use FgWhite and FgBlack for terminal output
([#435](#435)).
* Skip path translation of job task for jobs with a Git source
([#404](#404)).
* Tweak profile prompt
([#454](#454)).
* Update with the latest Go SDK
([#457](#457)).
* Use cmdio in version command for `--output` flag
([#419](#419)).

Bundles:
* Check for nil environment before accessing it
([#453](#453)).

Dependencies:
* Bump github.com/hashicorp/terraform-json from 0.16.0 to 0.17.0
([#459](#459)).
* Bump github.com/mattn/go-isatty from 0.0.18 to 0.0.19
([#412](#412)).

Internal:
* Add Mkdir and ReadDir functions to filer.Filer interface
([#414](#414)).
* Add Stat function to filer.Filer interface
([#421](#421)).
* Add check for path is a directory in filer.ReadDir
([#426](#426)).
* Add fs.FS adapter for the filer interface
([#422](#422)).
* Add implementation of filer.Filer for local filesystem
([#460](#460)).
* Allow equivalence checking of filer errors to fs errors
([#416](#416)).
* Fix locker integration test
([#417](#417)).
* Implement DBFS filer
([#139](#139)).
* Include recursive deletion in filer interface
([#442](#442)).
* Make filer.Filer return fs.DirEntry from ReadDir
([#415](#415)).
* Speed up sync integration tests
([#428](#428)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pietern pietern pietern approved these changes

@nfx nfx Awaiting requested review from nfx

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shreyas-goenka @pietern @nfx