FSharpLint v1

[jgardella]

Creating this issue for tracking and discussing FSharpLint v1. This will give us a chance to get some breaking changes out of the way and overall put the lint tool and the API into a better state.

Required

• [x] Support multi-target files (#435)
• [ ] Re-evaluate default rules (#436)
• [ ] Finalize config format (In progress in #438)
• [ ] Finalize and double-check documentation
• [ ] Finalize warning messages (#181)
• [ ] Refactor and finalize core API. There's probably not much to do here, but we should make sure this is how we want it now, as we can get any breaking changes in as part of this v1 release. (In progress in #438)
• [ ] Address any open TODO comments.
• [ ] Address any outstanding bugs on GitHub issues
  • [ ] #364
  • [ ] #328
  • [ ] #296

Nice to Have

• [ ] Add diagnostic logging with configurable levels (In progress in #438)
  • Probably could be exposed at Info/Error level through ReportLinterProgress
• [ ] .editorconfig support
• [x] Clean up build & deploy pipeline (Done in #433)
• [ ] IDE integration. We get this at a basic level with the MSBuild task, but maybe we could get something more useful with a more direct integration.
  • [ ] Rider integration. I had taken a shot at this once and it seems doable, but I got bogged down in some dependency issues since the fsharp-support plugin uses a JetBrains internal version of FCS.
  • [ ] Visual Studio integration. I have looked into this as well but it seems like a much harder thing to do if we want to do it the right way.
• [ ] Remove AbstractSyntaxArray and run AST node rules through direct AST traversal

We would really appreciate some community input on what people would like to see as part of the v1 release and any other ways we can improve FSharpLint for our users! For some things (like re-evaluating the default rules) we will definitely need input to make sure we end up with something that everyone is happy with. Feel free to use this issue for any general discussion on the release, or create a new issue for anything specific you'd like to see added or improved.

[milbrandt]

IMHO the issue #364 with redundantNewKeyword should be analyzed and fixed for release v1. Neither Steve's required new marked redundant nor my newno longer marked redundant with upgrading to F# 4.7 is satisfying. It might be that's not even an issue here in FSharpLint. But if upgrading compiler from 4.6.2 to 4.7 change the lint results then this leaves doubts on other linting results.

[jgardella]

@milbrandt Agreed, I will add it to the list.

[deviousasti]

Additional code-base improvements:

• Standardise formatting with Fantomas
• Cleanup the use of Option.toArray in Configuration.fs now that we have implicit yields in F# 4.7
• Add CompiledName attributes for public API
• Use compiled regexes