nextcloud-libraries / nextcloud-libraries/eslint-config

[RFC] Add strict config(s) for optioned rules

Open
#1,005 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
9
Forks
4
Avg merge
5h 5m
Merged PRs (30d)
24

Description

Problem

Some rules are simple:

  • Don't require semantic changes (e.g. renaming a variable or changing declaration context)
  • Always work well (e.g. trailing comma never hurts)
  • Can be auto-fixed

However, some rules are problematic to apply:

  • Require semantic changes
  • Make readability worth in some cases
  • Require significant manual changes (e.g. rewriting component to TS or renaming components)
  • Can be auto-fixed, but with LARGE changes
  • Or just too discussable

Examples:

Proposal

Instead of hot discussions, local rule overrides and avoiding "painful" rules, we can provide them in a additional config

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 repository's existing ESLint configurations and the referenced rule discussions and pull requests. Define the additional configuration's scope and determine how the listed optioned rules should be separated from the existing configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
eslint, typescript
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.