audit-general

[drernie]

[nf-quilt] general surface-level audit - 01.05.2023 from PullRequest.com

The audit made 41 suggestions, across a few categories

= A.Generic Fixes
== PRComment_001, PRComment_026

• rename all fields and methods to camelCase [PRComment_014, PRComment_020]
• run a code formatter [PRComment_013]
• try running a code coverage tool to see what remaining paths may be uncovered

= B. Trivial one-line fixes

• PRComment_002
• PRComment_005
• PRComment_009
• PRComment_010
• PRComment_012
• PRComment_015
• PRComment_016
• PRComment_017
• PRComment_018 [upper snake case]
• PRComment_021
• PRComment_027
• PRComment_030
• PRComment_031
• PRComment_032
• PRComment_033
• PRComment_036
• PRComment_038
• PRComment_040

= C. Improved Error Handling

• PRComment_003
• PRComment_006
• PRComment_008
• PRComment_019
• PRComment_022
• PRComment_023
• PRComment_025
• PRComment_029
• PRComment_037

= D. Improved Documentation/Formatting

• PRComment_024
• PRComment_004
• PRComment_007
• PRComment_028
• PRComment_035

= E. Informative (no action required)

• PRComment_011
• PRComment_034
• PRComment_039
• PRComment_041

[drernie]

My plan is to do the many small items in Section "B" first, before other changes mess up the line numbering. I also plan to include the ID as a comment so it is trivial to cross-reference when evaluating the PR. I can easily remove those comments after the PR is reviewed, but before it is merged.

After that, I will probably do the global changes from A, followed by D and then C. Then we can submit to Seqera Labs!

[drernie]

Here's the report as a HTML archive with the appropriate PRComment_ identifiers.
reportgen.zip

Click on index.html to launch in any browser.

[drernie]

Closing now, as the remaining follow-on tasks are self-contained.