Glavin001/tslint-clean-code

Enforce prefixes for name of functions with boolean return type

Open

#66 opened on Nov 2, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (15 forks)github user discovery
good first issuehelp wantedrule

Repository metrics

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

Description

See https://github.com/Glavin001/tslint-clean-code/pull/62#discussion_r227669295

I'd like to make a TSLint rule which sees a method's return type is boolean and checks the starting of the method name for is and other prefixes 🤣.

-    private textIsSingleWord(text: string): boolean {
+    private isTextSingleWord(text: string): boolean {

Contributor guide

Research direction
Study existing TSLint rules in the repository to understand the rule structure, then create a new rule that checks the return type of functions and enforces a naming prefix like 'is', 'has', etc.
Tech stack
typescript
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65