Mishandling of multiline strings in user libraries

[blaz]

When user library is imported in user application Hubitat appends comment with library name and line number to each imported library line. Unfortunately this also applies to each line of multiline string, which results in modified multiline string.

Following example user library and app should demonstrate this problem.

library

library(
    author: 'bug reporter',
    category: 'hubitat bugs',
    description: 'demonstrates a bug',
    name: 'LibMultilineStringBug',
    namespace: 'hubitat.bugs.library.multilineString',
    documentationLink: ''
)

import groovy.transform.Field

@Field String problemString = '''first
one
two
three
last''';

app

definition(
    name: 'LibMultilineStringBug app',
    namespace: 'hubitat.bugs.library.multilineString',
    author: 'bug reporter',
    category: 'hubitat bugs',
    description: 'demonstrates a bug',
    iconUrl: '',
    iconX2Url: '',
)

preferences {
    page(name: 'mainPage', title: 'bug demo', install: true, uninstall: true) {
        section {
            paragraph(problemString);
        }
    }
}

void installed() {
}

void updated() {
}

void uninstalled() {
}

#include hubitat.bugs.library.multilineString.LibMultilineStringBug

Download of complete app code contains following part

String problemString = '''first // library marker hubitat.bugs.library.multilineString.LibMultilineStringBug, line 12
one // library marker hubitat.bugs.library.multilineString.LibMultilineStringBug, line 13
two // library marker hubitat.bugs.library.multilineString.LibMultilineStringBug, line 14
three // library marker hubitat.bugs.library.multilineString.LibMultilineStringBug, line 15
last'''; // library marker hubitat.bugs.library.multilineString.LibMultilineStringBug, line 16

[thebearmay]

Known limitation of libraries, i.e. they don’t support multi line strings.

[blaz]

Such limitation should really be mentioned in library documentation.

[jtp10181]

I am not a huge fan of how it add a comment to every line. IMO wouldnt you get the same effect with a start and end comment? Can probably figure out the line numbers in another way.

// *** Libray Marker hubitat.bugs.library.multilineString.LibMultilineStringBug START ***
Library code.....
More Library code.....
// *** Libray Marker hubitat.bugs.library.multilineString.LibMultilineStringBug END ***

[jlv]

The last time this was mentioned, this was the suggestion by @bravenel :

Multi-line strings in Libraries

Just break up multi-line strings like this: "alkjsldkfdlhlkfdf " + "oiwenkonfgoikneg"

[Jost]

Have the same problem, therefore I asked:

How to include library code without comment on each line?

#include is a great tool to structure and re-use your code. But: How can I stop the counting comments in the included code? (Every code line is suffixed by something like "// library marker namespace.name, line #".) if it is not yet possible, could we get an option to turn this on/off? Or, maybe another directive, e.g. #includeflat?

Till now no answer...

[bravenel]

@Jost

Till now no answer...

Those comments are there to assist in creating meaningful error messages. They only appear in downloaded files. When you save a library to Libraries Code and it is compiled into the app or driver, there is no overhead from this.