Feature (v3): Add a function to set the desired line length of an Encoder #455

laverya · 2019-04-23T23:22:13Z

This PR exposes a function func (e *Encoder) SetLineLength(characters int) that allows setting the line wrap length of an encoder. The interface was intended to have a very similar style to the SetIndent function func (e *Encoder) SetIndent(spaces int), implemented here.

Internally, it uses the existing function func yaml_emitter_set_width(emitter *yaml_emitter_t, width int), which was previously unused.

This relates to several issues (#387, #348, #166) and a previous PR (#329).

bai · 2019-05-13T03:35:45Z

👋Friendly bump: any news on when this might get shipped? 🙏

laverya · 2019-05-16T18:25:00Z

I'm afraid there's been no news @bai - I've emailed @niemeyer again but no replies since the 2nd (of May). Things seem to be moving slowly, but I remain hopeful that they will eventually move

bai · 2019-06-05T20:02:52Z

@laverya If I get it right, you're implementing this PR in context of Kustomize. And while this would be really helpful for other projects, Kustomize is the reason you submitted it in the first place?

Anyhow, the reason I'm asking is: do you think we could get this PR backported to Kubernetes' fork of yaml at https://github.com/kubernetes-sigs/yaml and make Kustomize use it instead?

Curious what you think, given there's not much movement going on here. ☁️ 🙄

laverya · 2019-06-06T21:48:32Z

@bai you're right that kustomize is the primary target of this (or at least MY primary target), and creating a fork of go-yaml/yaml that kubernetes-sigs/yaml can import is a plausible route to get it there. It feels like we're forking the entire chain at that point, of course 😆 (and for that matter I hadn't realized that kustomize had moved to a fork of ghodss/yaml - any idea why?)

bai · 2019-06-07T05:29:31Z

I'm not aware about exact intentions, but assume that for safety/audit reasons, given how many users use those tools with mission-critical infrastructure (to avoid things like left-pad and cryptomining npmjs fiasco).

So my thinking was that if kubernetes/kubernetes uses a wrapper/"fork" at https://github.com/kubernetes-sigs/yaml then it would naturally make sense for kustomize use it as well? 🤔

laverya · 2019-06-07T18:58:42Z

Ah, I think we talked past each other a little here - kustomize also uses kubernetes-sigs/yaml as of last month: kubernetes-sigs/kustomize#1014.

I just meant that forking go-yaml/yaml would mean that the yaml dependency chain for kustomize would look like this:

laverya/yaml (forked from go-yaml/yaml)
|
kubernetes-sigs/yaml (forked from ghodss/yaml)
|
kubernetes-sigs/kustomize

This doesn't mean that it's a bad idea, though! Just (IMO) funny.

bai · 2019-06-24T05:24:41Z

Happy Monday! 👋Friendly bumping this PR since kustomize v3.0.0-pre was tagged and it'd be great to have this included into 3.0.0.

Thoughts on doing laverya/yaml (forked from go-yaml/yaml) thing you mentioned in your last comment, since it's been 2 months since you've submitted this PR? 💭

laverya · 2019-07-09T20:00:51Z

@niemeyer seems to be back and active (which is why I merged the v3 branch again) - any chance this could get merged?

laverya · 2019-07-10T21:28:30Z

In any case, I'll be changing my repos to use https://github.com/laverya/yaml/tree/v3 for now. (gopkg.in/laverya/yaml.v3)

I'll happily switch back (and drop the maintenance burden) once this gets merged, of course.

otherwise tests of functions that do not exist in v2 fail

pupapaik · 2019-07-29T14:01:36Z

Can we merge this please? I had to use his fork branch to fix my problem. Thanks

laverya · 2019-07-31T18:21:45Z

@pupapaik I've seen very little interest from the maintainers in actually merging PRs, I'm afraid 😦 I've still got 6 PRs open, which is really depressing. If he was willing to comment and tell me that the patches were unwanted, or that they were deficient in some way, that would be one thing - but I've yet to get a real comment on any of them.

Or at least I would assume @niemeyer is the maintainer?

EDIT: reading this later, this was inappropriate.

niemeyer · 2019-07-31T19:31:11Z

You're being pushy, Andrew. You did get comments, and you did get a whole email thread about this PR saying I was stabilizing v3 before accepting more patches. I worked quite some time fixing bugs in v3 recently, and that's not even part of my daily job. I do it because I want to make it good. Please be more patient.

laverya · 2019-08-01T00:52:49Z

I will try to be more patient. Thank you for responding!

…wrap-length

jmhodges · 2019-10-17T02:55:25Z

Any word on this? I just ran into this problem.

This adds the SetLineLength method to Encoder and changes the imports to the jmhodges/yaml.v2 config. The SetLineLength patch is adapated from go-yaml#455 The README got an update for folks needing this.

jmhodges · 2019-10-17T03:52:45Z

For folks who need this on yaml.v2 (I needed the MapSlice API), I've published this patch on top of yaml.v2 at gopkg.in/jmhodges/yaml.v2

laverya · 2019-10-17T05:54:21Z

There's also a v3 version available here: gopkg.in/laverya/yaml.v3

...I should really merge in the latest commits from this repo. Something for tomorrow.

bai · 2019-10-17T06:09:32Z

Hopefully this PR is going to get merged soon 🤞

nettrino · 2019-10-25T00:43:43Z

Knowing that this is a very ugly hack - just mentioning for anyone interested that the width can also be set using reflect. I am not sure though if that breaks something else in the package.

        ....
	var buf bytes.Buffer
	enc := yaml.NewEncoder(&buf)
	v := reflect.ValueOf(enc).Elem().FieldByName("encoder").Elem()
	width := v.FieldByName("emitter").FieldByName("best_width").UnsafeAddr()
	widthPtr := (*int)(unsafe.Pointer(width))
	// don't limit the width
	*widthPtr = -1
	// encode contents
	if err := enc.Encode(node.Content[0]); err != nil {
		return err
	}
	if err := enc.Close(); err != nil {
		return err
	}

	ioutil.WriteFile(output, buf.Bytes(), permissions)

laverya · 2019-10-25T17:10:10Z

That is a horrible, unsafe and unmaintainable hack.

...I love it

klautcomputing · 2019-12-16T17:15:41Z

👋 @niemeyer Do you have an idea when this might get merged?

niemeyer · 2019-12-16T20:43:47Z

I need to dedicate a moment to a few open issues here in the next few days. Will look into this as well.

bai · 2020-02-06T12:57:00Z

Apologies for being a pain in the ass with this one, any news on when this might get shipped? 🙏

bai · 2020-03-01T06:56:55Z

ashokponkumar · 2020-04-23T18:49:43Z

@niemeyer Friendly request to get this PR merged, when you get a chance.

laverya · 2020-04-24T23:27:58Z

If anyone's still waiting for this, the company I work for has a branch with releases over at https://github.com/replicatedhq/yaml/tree/v3

It's basically the current v3 (though with a different 'marshal yes/no/etc with quotes' implementation) plus 'marshal with json tags if those are present and yaml tags are not')

(I figured the 1 year anniversary was a good opportunity to plug that)

ashokponkumar · 2020-04-25T01:44:12Z

If anyone's still waiting for this, the company I work for has a branch with releases over at https://github.com/replicatedhq/yaml/tree/v3

It's basically the current v3 (though with a different 'marshal yes/no/etc with quotes' implementation) plus 'marshal with json tags if those are present and yaml tags are not')

(I figured the 1 year anniversary was a good opportunity to plug that)

Is there any issue in using your fork? It seems to fix the issue till this merge is completed.

bai · 2020-04-25T06:08:55Z

(I figured the 1 year anniversary was a good opportunity to plug that)

Happy 1 year anniversary indeed! Time flies.

laverya · 2020-04-27T15:17:40Z

Is there any issue in using your fork? It seems to fix the issue till this merge is completed.

No issues that I know of! Just go get github.com/replicatedhq/yaml/v3. (If there are issues, please let me know)

ashokponkumar · 2020-04-28T06:38:47Z

Is there any issue in using your fork? It seems to fix the issue till this merge is completed.

No issues that I know of! Just go get github.com/replicatedhq/yaml/v3. (If there are issues, please let me know)

Sorry that I wasn't clear. I was referring to https://github.com/laverya/yaml fork. Was trying to be as close to go-yaml/yaml fork, so that I can switch back as soon as this fix is rolled out.

sagarkrkv · 2020-05-06T21:29:14Z

@niemeyer bump, please consider merging this, as it is a very simple fix, our option would be to maintain a custom fork with this tiny change. We would rather avoid that if possible.

niemeyer · 2020-05-06T23:16:39Z

I've merged the change, also from @laverya, that disables the wraping altogether instead.

I'm tentatively closing this, in the hope that what people really want is no wrapping at all.

Let's see what happens next.

laverya · 2020-05-07T02:27:22Z

Let's hope, and that's all I think I need! I'll make PRs for some consumers of this (https://github.com/kubernetes-sigs/yaml, https://github.com/ghodss/yaml, a few downstream things) tomorrow. (Or whenever this becomes a release)

laverya · 2020-11-12T21:26:18Z

All of a sudden I'm happy I didn't actually make the PRs I was suggesting here (since the consuming projects I was using were able to go get gopkg.in/yaml.v2) - given that the 'change default wrap length to infinity' PR broke tests elsewhere when it was eventually included.

laverya added 2 commits April 23, 2019 16:20

Add a function to set the desired line length of an Encoder

3c16e92

import to gopkg.in/yaml.v3 in CI

9e32171

laverya mentioned this pull request Apr 24, 2019

Line breaks on long strings with spaces kubernetes-sigs/kustomize#947

Open

alexandrevicenzi mentioned this pull request May 2, 2019

Marshalling long, single-line strings results in (correct) line breaks #166

Open

Merge remote-tracking branch 'origin/v3' into allow-setting-wrap-length

842a237

Merge remote-tracking branch 'origin/v3' into allow-setting-wrap-length

55132f8

laverya mentioned this pull request Jul 10, 2019

use laverya/yaml to allow marshalling yaml with unlimited line lengths replicatedhq/ship#1020

Merged

laverya mentioned this pull request Jul 11, 2019

use gopkg.in/laverya/yaml.v3 instead of gopkg.in/yaml.v2 kubernetes-sigs/yaml#26

Closed

laverya added 2 commits July 15, 2019 12:05

travis should use the v3 import path not v2

e0fb294

otherwise tests of functions that do not exist in v2 fail

Merge branch 'ci-imports' into allow-setting-wrap-length

6169ce5

laverya added 2 commits September 5, 2019 13:31

Merge remote-tracking branch 'origin/v3' into ci-imports

5317934

Merge remote-tracking branch 'laverya/ci-imports' into allow-setting-…

8557722

…wrap-length

jmhodges mentioned this pull request Oct 17, 2019

add Encoder.SetLineLength API and change imports #524

Closed

jmhodges mentioned this pull request Oct 17, 2019

add Encoder.SetLineLength API and change imports jmhodges/yaml#1

Merged

laverya changed the title ~~Add a function to set the desired line length of an Encoder~~ Feature (v3): Add a function to set the desired line length of an Encoder Nov 5, 2019

laverya requested a review from niemeyer February 6, 2020 19:13

niemeyer closed this May 6, 2020

genevieveluyt mentioned this pull request May 7, 2020

Disable line wrapping Shopify/kubeaudit#272

Closed

2 tasks

eddiezane mentioned this pull request Oct 15, 2020

Update cobra dependency to v1.1.1 kubernetes/kubernetes#95571

Merged

bobbypage mentioned this pull request Nov 12, 2020

Vendor cadvisor v0.38.4 kubernetes/kubernetes#96425

Merged

laverya mentioned this pull request Nov 12, 2020

Revert "Set the default line length to infinity (-1) (#571)" #670

Closed

babbageclunk mentioned this pull request Apr 23, 2021

Update helm chart for 1.0.22275 operator release Azure/azure-service-operator#1418

Merged

sahil-lakhwani mentioned this pull request Nov 27, 2021

long lines get a line breaker while marshalling to yaml kbrew-dev/kbrew#127

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature (v3): Add a function to set the desired line length of an Encoder #455

Feature (v3): Add a function to set the desired line length of an Encoder #455

laverya commented Apr 23, 2019 •

edited

Loading

bai commented May 13, 2019

laverya commented May 16, 2019

bai commented Jun 5, 2019

laverya commented Jun 6, 2019

bai commented Jun 7, 2019 •

edited

Loading

laverya commented Jun 7, 2019

bai commented Jun 24, 2019

laverya commented Jul 9, 2019 •

edited

Loading

laverya commented Jul 10, 2019

pupapaik commented Jul 29, 2019

laverya commented Jul 31, 2019 •

edited

Loading

niemeyer commented Jul 31, 2019 •

edited

Loading

laverya commented Aug 1, 2019

jmhodges commented Oct 17, 2019

jmhodges commented Oct 17, 2019

laverya commented Oct 17, 2019

bai commented Oct 17, 2019 •

edited

Loading

nettrino commented Oct 25, 2019

laverya commented Oct 25, 2019

klautcomputing commented Dec 16, 2019

niemeyer commented Dec 16, 2019

bai commented Feb 6, 2020

bai commented Mar 1, 2020

ashokponkumar commented Apr 23, 2020

laverya commented Apr 24, 2020 •

edited

Loading

ashokponkumar commented Apr 25, 2020

bai commented Apr 25, 2020

laverya commented Apr 27, 2020 •

edited

Loading

ashokponkumar commented Apr 28, 2020

sagarkrkv commented May 6, 2020

niemeyer commented May 6, 2020

laverya commented May 7, 2020

laverya commented Nov 12, 2020

Feature (v3): Add a function to set the desired line length of an Encoder #455

Feature (v3): Add a function to set the desired line length of an Encoder #455

Conversation

laverya commented Apr 23, 2019 • edited Loading

bai commented May 13, 2019

laverya commented May 16, 2019

bai commented Jun 5, 2019

laverya commented Jun 6, 2019

bai commented Jun 7, 2019 • edited Loading

laverya commented Jun 7, 2019

bai commented Jun 24, 2019

laverya commented Jul 9, 2019 • edited Loading

laverya commented Jul 10, 2019

pupapaik commented Jul 29, 2019

laverya commented Jul 31, 2019 • edited Loading

niemeyer commented Jul 31, 2019 • edited Loading

laverya commented Aug 1, 2019

jmhodges commented Oct 17, 2019

jmhodges commented Oct 17, 2019

laverya commented Oct 17, 2019

bai commented Oct 17, 2019 • edited Loading

nettrino commented Oct 25, 2019

laverya commented Oct 25, 2019

klautcomputing commented Dec 16, 2019

niemeyer commented Dec 16, 2019

bai commented Feb 6, 2020

bai commented Mar 1, 2020

ashokponkumar commented Apr 23, 2020

laverya commented Apr 24, 2020 • edited Loading

ashokponkumar commented Apr 25, 2020

bai commented Apr 25, 2020

laverya commented Apr 27, 2020 • edited Loading

ashokponkumar commented Apr 28, 2020

sagarkrkv commented May 6, 2020

niemeyer commented May 6, 2020

laverya commented May 7, 2020

laverya commented Nov 12, 2020

laverya commented Apr 23, 2019 •

edited

Loading

bai commented Jun 7, 2019 •

edited

Loading

laverya commented Jul 9, 2019 •

edited

Loading

laverya commented Jul 31, 2019 •

edited

Loading

niemeyer commented Jul 31, 2019 •

edited

Loading

bai commented Oct 17, 2019 •

edited

Loading

laverya commented Apr 24, 2020 •

edited

Loading

laverya commented Apr 27, 2020 •

edited

Loading