ryanmcdermott/clean-code-javascript

What about Magic strings?

Open

#122 opened on Jan 12, 2017

View on GitHub
 (13 comments) (0 reactions) (0 assignees)JavaScript (12,469 forks)batch import
help wanted

Repository metrics

Stars
 (94,343 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Do you think that can be good to include something about magic strings?

Bad:

let posts = getPostsFromCategory('sports');

Good:

const categories = {
  sports: 'sports',
  economy: 'economy'
};

let posts = getPostsFromCategory(categories.sports);

Contributor guide

Research direction
Review existing documentation in the repository (likely the README) to find a suitable location for a section on magic strings. Check the issue comments for any maintainer guidance or previous suggestions. Add the proposed content with appropriate formatting and examples.
Tech stack
javascript
Domain
documentation
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.
Under 1 hour
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.
Clear
Prerequisites
JavaScript fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80