Keep indentation about gomplate HOT 10 CLOSED

Resolved by #165 and #166

from gomplate.

Ok - I've logged #165 to track the indent enhancement that's come out of this.

For the indentfirst functionality, you can pipe the output to trimSpace to achieve the same effect:

$ gomplate -i '{{ "foo\nbar\nbaz" | indent "    " | trimSpace }}' 
foo
    bar
    baz

from gomplate.

@glensc @hairyhenderson You can replicate the behavior of the Helm nindent function in gomplate by printing "\n" before your template:

metadata:
  labels:
    {{- print "\n" (.data.my_labels | toYAML | trimSpace | indent 4) }}

This sort of pattern lets you remove leading newlines with{{-, so you can indent the template for visual clarity.

Note, the trimSpace is there to remove the strange dangling newline that toYAML seems to create.

from gomplate.

@estahn for this, you want the indent function - I actually wrote that specifically for dealing with YAML indentation 😉

from gomplate.

@hairyhenderson Well, that would result in pretty ugly templates, e.g.

spec:
  schedule: "{{ .schedule }}"
  concurrencyPolicy: Forbid
  jobTemplate:
    spec:
      activeDeadlineSeconds: 30
      template:
        spec:
          restartPolicy: Never
          containers:
            - name: app
              image: "123"
              args:
{{ .args | toYAML | indent("              ") }}

from gomplate.

Yup, I agree, that's not ideal. But there's no way for gomplate to know about text outside of the {{/}} delimiters.

In your specific case, since YAML is a JSON superset, it's probably best to take the approach you seem to have explored in #163 and render that particular value as JSON.

from gomplate.

Would it be possible to adjust indent to something what jinja provides?

http://jinja.pocoo.org/docs/2.9/templates/#indent

indent(s, width=4, indentfirst=False)
Return a copy of the passed string, each line indented by 4 spaces. The first line is not indented. If you want to change the number of spaces or indent the first line too you can pass additional parameters to the filter:

{{ mytext|indent(2, true) }}
indent by two spaces and indent the first line too.

from gomplate.

@estahn Just to be clear about what you're asking - are you looking for indent to be callable like this?

$ gomplate -i '{{ "foo" | indent 4 }}'
    foo

That seems reasonable. Because indent already exists, I can't change the existing functionality, but what I can do is overload it so that you can provide an optional width parameter.

Is the indentfirst option of jinja's indent useful to you? If I were to implement that it'd probably be as a separate function (maybe strings.IndentAfter or something like that).

from gomplate.

@hairyhenderson It is probably useful otherwise you will need to place the placeholder always at the beginning of the line.

Example:

spec:
  schedule: "{{ .schedule }}"
  concurrencyPolicy: Forbid
  jobTemplate:
    spec:
      activeDeadlineSeconds: 30
      template:
        spec:
          restartPolicy: Never
          containers:
            - name: app
              image: "123"
              args:
                {{ .args | toYAML | indent(16) }}

vs

spec:
  schedule: "{{ .schedule }}"
  concurrencyPolicy: Forbid
  jobTemplate:
    spec:
      activeDeadlineSeconds: 30
      template:
        spec:
          restartPolicy: Never
          containers:
            - name: app
              image: "123"
              args:
{{ .args | toYAML | indent(16) }}

from gomplate.

The need for trimSpace problem is still there:

• #162 (comment)

i.e for yaml formating typically the indent should be omitted so the function itself can be kept indented.

or I'm missing something?

I'm trying to load .env file for helm values file:

$ cat .env
APP_ENV=production
APP_DEBUG=false
APP_KEY=SomeRandomString
APP_URL=http://localhost

$ cat values.yml
config:
  {{ (ds "data") | data.ToYAML | strings.Indent 1 "  " | trimSpace }}

config-example:
  {{ (ds "data") | data.ToYAML | strings.Indent 1 "  " }}

$ gomplate -d data=file://`pwd`/.env?type=application/x-env -f values.yml
config:
  APP_DEBUG: "false"
  APP_ENV: production
  APP_KEY: SomeRandomString
  APP_URL: http://localhost

config-example:
    APP_DEBUG: "false"
  APP_ENV: production
  APP_KEY: SomeRandomString
  APP_URL: http://localhost

in helm, there's extra function nindent doing that:

• https://helm.sh/docs/chart_template_guide/yaml_techniques/#indenting-and-templates

from gomplate.