fsprojects / fsprojects/FSharpLint

feat: Categorization of rules with configuration?

Open
#708 0 comments 1 reaction 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

The current config is like 70+ rules.
It would be nice to have them in categories, for example:
Execution speed, Memory usage, Naming, Coding convention

For example, a nested JSON configuration file instead of current list.
Or maybe like FxCop used to have, provide multiple pre-defined configuration files:
fsharplint-recommended.json, fsharplint-performance.json, fsharplint-maintainability.json, fsharplint-all.json, ...

Because, for new project you'd want a different config than for existing project, and sometimes you look to improve a specific aspect of the source code. That could make easier adaptation of this tool for existing libraries.

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 current configuration format and the linked fsharlint.json examples for FSharpLint and SQLProvider. Define how rule categories and any recommended, performance, maintainability, and all presets should be represented, then verify that the proposed configuration supports both new and existing projects.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.