[Proposal] Add Namespace Source Literals

[addison-adler]

I'd like to add two source literals: SOURCE_NAMESPACE and SOURCE_NAMESPACE_ROOT

• These are complimentary to the existing SOURCE_FUNCTION_NAME literal
• These are very useful for trace logging
• for developers that use a logger with filtering, enables filtering logs based on the namespace they originate from
  • alternative right now is to use PKG_PATH, but that changes every file, whereas a namespace can span multiple files

Live Transpile Preview (pulled from VSCode)

Brighterscript:

Sub ComponentScope ()
    ' Component Scope
    sourceFunction = source_function_name
    sourceNamespace = source_namespace
    sourceNamespaceRoot = source_namespace_root
End Sub

Namespace NamespaceA

    ' Namespace Scope
    Sub ScopeA ()
        sourceFunction = source_function_name
        sourceNamespace = source_namespace
        sourceNamespaceRoot = source_namespace_root
    End Sub

    ' Nested Namespace Scope
    Namespace NamespaceB.NamespaceC

        Sub ScopeB ()
            sourceFunction = source_function_name
            sourceNamespace = source_namespace
            sourceNamespaceRoot = source_namespace_root
        End Sub

    End Namespace
End Namespace

Transpiled

Sub ComponentScope()
    ' Component Scope
    sourceFunction = "ComponentScope"
    sourceNamespace = ""
    sourceNamespaceRoot = ""
End Sub
' Namespace Scope
Sub NamespaceA_ScopeA()
    sourceFunction = "NamespaceA.ScopeA"
    sourceNamespace = "NamespaceA"
    sourceNamespaceRoot = "NamespaceA"
End Sub
' Nested Namespace Scope
Sub NamespaceA_NamespaceB_NamespaceC_ScopeB()
    sourceFunction = "NamespaceA.NamespaceB.NamespaceC.ScopeB"
    sourceNamespace = "NamespaceA.NamespaceB.NamespaceC"
    sourceNamespaceRoot = "NamespaceA"
End Sub

Example Use Case

for debugging & log filtering

Namespace SpaceA
    Sub MyFunction ()
        LoggerUtil.Trace(SOURCE_FUNCTION_NAME, [SOURCE_NAMESPACE_ROOT]) 
    End Sub

    Namespace PrivateA
        Sub PrivateFunc ()
            LoggerUtil.Trace(SOURCE_FUNCTION_NAME, [SOURCE_NAMESPACE_ROOT])
        End Sub
    End Namespace
End Namespace

' Trace(text, filters)
' for filtering logs based on namespace, which may span multiple files

Namespace SpaceA
    Sub MyFunction ()
        LoggerUtil.Trace("MyFunction", ["SpaceA"]) 
    End Sub

    Namespace PrivateA
        Sub PrivateFunc ()
            LoggerUtil.Trace("PrivateFunc", ["SpaceA"])
        End Sub
    End Namespace
End Namespace

[TwitchBronBron]

looks good to me! Nice work.

[TwitchBronBron]

Actually, on second thought, I wanted to have a quick discussion about the variable names. Would appreciate your thoughts.

[TwitchBronBron]

@addison-adler can you fix the failing unit test?

[addison-adler]

Test failure caused by a casing mismatch; re-testing now

[addison-adler]

@TwitchBronBron

@addison-adler can you fix the failing unit test?

Test failure caused by a casing mismatch; re-testing now

already on it and fixed! 😁
it was a small casing mismatch

[addison-adler]

Oh, it doesn't like variables that use snakecase.. okay lemme make those hash keys into strings again 😅

[addison-adler]

@TwitchBronBron all good now!