fsprojects / fsprojects/FSharpLint

FSharpLint v1

Open
#434 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
F#
Stars
327
Forks
74
PR merge metrics
No merged PRs in 30d

Description

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

  • 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
  • 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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the unchecked items in this issue and the referenced issues #436, #438, #181, #328, and #296. The scope spans default rules, configuration, documentation, warning messages, the core API, TODOs, bugs, logging, IDE integration, and AST traversal; done means the relevant v1 checklist items are resolved and the release scope is agreed.

Written by the indexing model from the issue text.

Assessment

Domain
release, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.