Various remarks after testing

[siekermantechnology]

We've been experimenting with the bslint tool on our utility functions .brs file. Below a list of remarks we encountered while working on it.

• Documentation on the various parameters in the configuration file would be welcome. Part of it can be figured out based on the naming of the parameters in the sample file, but part of it is not clear and not documented yet.
• Change the default colour of the lex output from bright yellow to something which is easier to read on a white background.
• Running bslint without the -l / --lex flag resulted in: ERROR: Parsing program failed. Line number: 796
• WARNING: Operators must be surrounded by 1 space(s). => Gives falls positive on if statements with a <> operator, such as "if (parsedJSONObject <> invalid)".
• WARNING: Print statements not allowed. => We haven't found a way to disable this check in the configuration file. Would be a good setting to add.
• WARNING: You have spelling mistakes in your code. => We disabled this check (spell_check) immediately, because it gave too many false positives to be useful.
• WARNING: Invalid indentation, you must indent with tabs. => We indent with 4 spaces, so we modified the setting "only_tab_indents" in "check_indentation" to "false". It's not clear if "false" allows only spaces or tabs + spaces.
• Also, after setting to false, we get a lot of the following warnings: WARNING: Tab indentation should be set to 4 spaces. => The weird thing is that this happens all over the place, also in lines which only contain a comment, so looks like something is going wrong there.

[siekermantechnology]

The relevant source code file (added the .txt extension so I could attach): utils_brightscript.brs.txt

[siekermantechnology]

The .bslintrc file we ended up using: bslintrc.txt

[DanieleSassoli]

Many thanks for your very useful feedback!

• I updated the documentation based on the other issue you opened, I hope it's clearer now.

• In the future we'll look at making the colour of the messages configurable.

• If you want to disable the checks in the comments just set to false the check_comment section Like this:

  "check_comment": {
  "active": false,
  "params": {
    "TODOs": {
      "allow_TODOs": true,
      "format": "('|rem)\\s*TODO\\s+([A-Z]{2,3})"
    },
    "allow_generic_comments": true
  }
  }

• With regards at disabling the print statements check you should disable the check_trace_free command like so:

"check_trace_free": {
    "active": false,
    "params": {}
  }

• Setting only_tab_indents in check_indentation to false only allows spaces.
• Regarding the spell check, you can add a file called personal-words-list.txt inside the config directory (in the bslint installation directory, in the future we will allow it in a more sensible location)

@siekermantechnology Regarding the other issues I haven't addressed in this answer, would you mind opening a separate issue for each one of them so that we can look at them in more detail? Again thanks for feedback.

[JackIngleton]

I have created issues #152, #153 and #154 based on this collection of remarks reported. If these issues do not cover everything highlighted please raise new, individual issues for each specific bug etc.