Function similar to nindent but ignoring content's initial new line. #357

ksa-real · 2022-12-17T11:24:03Z

The ask is to have a function that acts like nindent, but skips the content's leading new line. The same effect is if the function act s as indent but doesn't indent the first line. This would allow templates to generate a leading new line that is useful in a lot of scenarios. The proposed name is snindent or sindent.

Explanation

A common way of using templates:

env:
  {{- include "my.multiline" . | nindent 2 }}
extra:
  field: abc

This assumes that "my.multiline" template produces a string without leading and trailing new lines. Let the template generate a list of "items" (line per item), each guarded by some condition.

{{- define "my.multiline" }}
{{- if condition1 }}
- line1
{{- end }}
{{- if condition2 }}
- line2
{{- end }}
{{- end }}

It is not possible to keep the two if blocks independent and keep no new lines around generated string for all possible values of boolean condition1 and condition2

So, the best for template is to generate a new line character per line: leading or trailing. If using trailing, then {{ include "sometemplate" . }} would generate likely unnecessary extra new line. {{ include "sometemplate" . -}} would in turn affect the next line indentation. So, a leading new line is the only option.

Workarounds

env:
  {{- include "my.multiline" . | trimPrefix "\n" | nindent 2 }}

The text was updated successfully, but these errors were encountered:

- Enabling existing secrets for external MySQL and Redis - Tolerate existing secrets for bundled charts. - README.md: secrets handling explained. - Fixed multiple bugs where missing required field was replaced with default instead of failing. - PHONE_NOTIFICATIONS_LIMIT was on the wrong level: it was not set if existingSecret was true. Next are the cosmetic changes. They improve chart consistency, e.g. prevent generation of multiple new lines in certain cases: - Common approach to spaces trimming. This typically allows curly blocks and actual strings indentation and nice `nindent` usage: - Two curly blocks should not trim the same space. I.e. "{{ ... -}} {{- ... }}" shouldn't happen. - Template generates either single line or multiline string. In both cases, no new line appears on both sides of the output string. So we delete unnecessary new lines inside and at the end of string with "trim-to-left" (`{{-` ) and the leading new line using "trim-to-right" (`-}}`). Note that trimming both leading and trailing new line is not always easily possible: Masterminds/sprig#357 Example. ``` {{- define "mytemplate" -}} {{ if someBoolean -}} {{ .Value.some }} {{- else -}} some string {{- end }} {{- end }} ``` - `template` replaced with `include`. It is often recommended to use `include` by default, as it allows pipelining.

- Enabling existing secrets for external MySQL and Redis - Tolerate existing secrets for bundled charts. - README.md: secrets handling explained. - Fixed multiple bugs where missing required field was replaced with default instead of failing. - PHONE_NOTIFICATIONS_LIMIT was on the wrong level: it was not set if existingSecret was true. Next are the cosmetic changes. They improve chart consistency, e.g. prevent generation of multiple new lines in certain cases: - Common approach to spaces trimming. This typically allows curly blocks and actual strings indentation and nice `nindent` usage: - Two curly blocks should not trim the same space. I.e. "{{ ... -}} {{- ... }}" shouldn't happen. - Template generates either single line or multiline string. In both cases, no new line appears on both sides of the output string. So we delete unnecessary new lines inside and at the end of string with "trim-to-left" (`{{-` ) and the leading new line using "trim-to-right" (`-}}`). Note that trimming both leading and trailing new line is not always easily possible: Masterminds/sprig#357 Example. ``` {{- define "mytemplate" -}} {{ if someBoolean -}} {{ .Value.some }} {{- else -}} some string {{- end }} {{- end }} ``` - `template` replaced with `include`. It is often recommended to use `include` by default, as it allows pipelining. ## Checklist - [ ] Tests updated - No tests for Helm chart - [X] Documentation added - [x] `CHANGELOG.md` updated Co-authored-by: Ildar Iskhakov <[email protected]>

ksa-real mentioned this issue Dec 20, 2022

Secrets consistency for the chart grafana/oncall#1016

Merged

3 tasks

ksa-real mentioned this issue Jun 22, 2023

Secrets consistency for the chart. Bugfixing. ksa-real/grafana-oncall#1

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Function similar to nindent but ignoring content's initial new line. #357

Function similar to nindent but ignoring content's initial new line. #357

ksa-real commented Dec 17, 2022 •

edited

Loading

Function similar to nindent but ignoring content's initial new line. #357

Function similar to nindent but ignoring content's initial new line. #357

Comments

ksa-real commented Dec 17, 2022 • edited Loading

Explanation

Workarounds

ksa-real commented Dec 17, 2022 •

edited

Loading