Glavin001/tslint-clean-code

Create a whitelist for id-length rule

Open

#40 opened on Feb 13, 2018

View on GitHub
 (4 comments) (0 reactions) (1 assignee)TypeScript (15 forks)github user discovery
buggood first issuehelp wanted

Repository metrics

Stars
 (175 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hello and thank you for your work.

The id-length rule is great for forbidding one-letter variable names. However, there are cases where one-letter symbols would actually be preferred: type parameters (GenericTypeAnnotation nodes) and holes.

Holes

Array
  .from({ length: 10 })
  .map((_, index) => index);

Type parameters

function unique<T>(collection: T[]): T[] {
  return [...new Set(collection)];
}

What do you think about passing a config that would allow them?

"id-length": [true, {
  "check-type-parameters": false,
  "allow": ["_"]
}]

Contributor guide

Research direction
Investigate how other TSLint rules handle similar configuration (e.g., 'variable name' rule). Look at the existing 'id length' rule implementation and add a config property like 'allow' and 'check type parameters'.
Tech stack
typescript
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65