SonarSource Rules
  • Products

    In-IDE

    Code Quality and Security in your IDE with SonarQube Ide

    IDE extension that lets you fix coding issues before they exist!

    Discover SonarQube for IDE

    SaaS

    Code Quality and Security in the cloud with SonarQube Cloud

    Setup is effortless and analysis is automatic for most languages

    Discover SonarQube Cloud

    Self-Hosted

    Code Quality and Security Self-Hosted with SonarQube Server

    Fast, accurate analysis; enterprise scalability

    Discover SonarQube Server
  • SecretsSecrets
  • ABAPABAP
  • AnsibleAnsible
  • ApexApex
  • AzureResourceManagerAzureResourceManager
  • CC
  • C#C#
  • C++C++
  • CloudFormationCloudFormation
  • COBOLCOBOL
  • CSSCSS
  • DartDart
  • DockerDocker
  • FlexFlex
  • GitHub ActionsGitHub Actions
  • GoGo
  • HTMLHTML
  • JavaJava
  • JavaScriptJavaScript
  • JSONJSON
  • JCLJCL
  • KotlinKotlin
  • KubernetesKubernetes
  • Objective CObjective C
  • PHPPHP
  • PL/IPL/I
  • PL/SQLPL/SQL
  • PythonPython
  • RPGRPG
  • RubyRuby
  • RustRust
  • ScalaScala
  • ShellShell
  • SwiftSwift
  • TerraformTerraform
  • TextText
  • TypeScriptTypeScript
  • T-SQLT-SQL
  • VB.NETVB.NET
  • VB6VB6
  • XMLXML
  • YAMLYAML
Go

Go static code analysis

Unique rules to find Bugs, Vulnerabilities, Security Hotspots, and Code Smells in your GO code

  • All rules 94
  • Vulnerability21
  • Bug13
  • Security Hotspot14
  • Code Smell46
Filtered: 12 rules found
convention
    Impact
      Clean code attribute
        1. Context should not be stored in struct fields

           Code Smell
        2. Package imports should be consistent and avoid redundancy

           Code Smell
        3. Single-method interface names should follow Go naming conventions

           Code Smell
        4. Function and method names should not use "Get" prefix

           Code Smell
        5. Semicolons should not be used unnecessarily

           Code Smell
        6. Import statements should be factored into a single block

           Code Smell
        7. Functions should follow Go's explicit error handling patterns

           Code Smell
        8. Track lack of copyright and license headers

           Code Smell
        9. Statements should be on separate lines

           Code Smell
        10. Local variable and function parameter names should comply with a naming convention

           Code Smell
        11. Lines should not be too long

           Code Smell
        12. Function names should comply with a naming convention

           Code Smell

        Context should not be stored in struct fields

        consistency - conventional
        maintainability
        Code Smell
        • convention

        This rule raises an issue when context.Context is declared as a field in a struct type.

        Why is this an issue?

        How can I fix it?

        More Info

        Storing context.Context in struct fields goes against Go best practices and creates several problems.

        When you store context in a struct, you obscure its lifetime to callers. This makes it unclear when the context will be used and how long it will remain valid. Callers cannot understand the scope of the context just by looking at the API.

        Storing context in structs also prevents per-call customization. Each method call should be able to specify its own deadline, cancellation behavior, and metadata. When context is stored in a struct, all method calls share the same context, removing this flexibility.

        This design intermingles different scopes in unpredictable ways. The context’s lifetime becomes tied to the struct’s lifetime rather than individual operations. This can lead to contexts outliving their intended use or being cancelled unexpectedly.

        The Go documentation explicitly states: "Contexts should not be stored inside a struct type, but instead passed to each function that needs it." This guidance ensures contexts remain scoped to specific operations and maintain their intended purpose of carrying request-scoped values, deadlines, and cancellation signals.

        What is the potential impact?

        Storing context in structs reduces the flexibility and clarity of your API. Callers lose the ability to set per-call deadlines, request cancellation for specific operations, or attach operation-specific metadata.

        This can lead to poor resource management, as contexts may outlive their intended scope or be shared inappropriately between operations. In production systems, this can result in requests that cannot be properly cancelled, potentially leading to resource leaks or degraded performance.

        The API becomes confusing for users who cannot easily understand when and how the stored context will be used, requiring additional documentation and potentially leading to misuse.

          Available In:
        • SonarQube CloudDetect issues in your GitHub, Azure DevOps Services, Bitbucket Cloud, GitLab repositories

        © 2025 SonarSource Sàrl. All rights reserved.

        Privacy Policy | Cookie Policy | Terms of Use