sindresorhus/eslint-plugin-unicorn

Enforce error message style

Closed

#26 opened on May 16, 2016

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)JavaScript (468 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (5,022 stars)
PR merge metrics
 (Avg merge 1d 16h) (399 merged PRs in 30d)

Description

https://github.com/sindresorhus/ava/pull/835#discussion_r63331538

I want to say: This is a failure, you should use a blimp

Which of the following should it be:

  • This is a failure, you should use a blimp
  • This is a failure. You should use a blimp
  • This is a failure. You should use a blimp.

Keep in mind that if we go for the last one, which looks the best, it becomes inconsistent with one sentence error messages, which usually don't end in a dot.

Contributor guide

Research direction
The issue discusses deciding on a consistent style for error messages in ESLint plugin unicorn. Currently, there is no decided format; the community is debating between different punctuations. To resolve, review the discussion and linked PR #835 for context, then propose and implement an ESLint rule that enforces the chosen style across all error messages in the codebase.
Tech stack
javascript
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.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Unclear
Prerequisites
ESLint plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30