Local variables and function parameters should be named consistently to communicate intent and improve maintainability. Rename your local variable or function parameter to follow your project’s naming convention to address this issue.

Why is this an issue?

A naming convention in software development is a set of guidelines for naming code elements like variables, functions, and classes.
Local variables and function parameters hold the meaning of the written code. Their names should be meaningful and follow a consistent and easily recognizable pattern.
Adhering to a consistent naming convention helps to make the code more readable and understandable, which makes it easier to maintain and debug. It also ensures consistency in the code, especially when multiple developers are working on the same project.

This rule checks that local variable and function parameter names match a provided regular expression.

Exceptions

The rule does not raise an issue on the usages of the blank identifier $_ or the root context $.

What is the potential impact?

Inconsistent naming of local variables and function parameters can lead to several issues in your code:

• Reduced Readability: Inconsistent local variable and function parameter names make the code harder to read and understand; consequently, it is more difficult to identify the purpose of each variable, spot errors, or comprehend the logic.
• Difficulty in Identifying Variables: The local variables and function parameters that don’t adhere to a standard naming convention are challenging to identify; thus, the coding process slows down, especially when dealing with a large codebase.
• Increased Risk of Errors: Inconsistent or unclear local variable and function parameter names lead to misunderstandings about what the variable represents. This ambiguity leads to incorrect assumptions and, consequently, bugs in the code.
• Collaboration Difficulties: In a team setting, inconsistent naming conventions lead to confusion and miscommunication among team members.
• Difficulty in Code Maintenance: Inconsistent naming leads to an inconsistent codebase. The code is difficult to understand, and making changes feels like refactoring constantly, as you face different naming methods. Ultimately, it makes the codebase harder to maintain.

In summary, not adhering to a naming convention for local variables and function parameters can lead to confusion, errors, and inefficiencies, making the code harder to read, understand, and maintain.

How to fix it

First, familiarize yourself with the particular naming convention of the project in question. Then, update the name to match the convention, as well as all usages of the name. For many IDEs, you can use built-in renaming and refactoring features to update all usages at once.

As a default, we suggest using the camelCase naming convention, as this is widely adopted for variables in Helm.

Code examples

Noncompliant code example

With the default regular expression ^\$[a-z][a-zA-Z0-9]*$:

{{- $my_Variable := .Values.myVariableValue -}} # Noncompliant

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- range $KeyNc, $VAL_NC := .Values.favorite }} # Noncompliant
  {{ $KeyNc }}: {{ $VAL_NC | quote }}
  {{- end }}

Compliant solution

{{- $myVariable := .Values.myVariableValue -}}

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  {{- range $keyC, $valC := .Values.favorite }}
  {{ $keyC }}: {{ $valC | quote }}
  {{- end }}

# Usage of blank identifier
{{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className -}}

# Usage of root context
{{- $ := . -}}

Resources

Documentation

• Helm documentation - Helm - Variables
• Go documentation - Effective Go - Names
• Wikipedia - Naming Convention (programming)