sindresorhus/eslint-plugin-unicorn

Rule proposal: Prefer `URL#href` to `URL#toString()`

Closed

#1,655 opened on Dec 22, 2021

View on GitHubContributor guide
 (17 comments) (5 reactions) (0 assignees)JavaScript (468 forks)user submission
help wantednew rule

Repository metrics

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

Description

Description

Nitpick rule.

When building URLs via the URL constructor, casting them to string seems to be obviously done via .toString and String(), but there's actually a native property for this.

This is generally more commonly done in TypeScript since the string type is enforced, but many just pass the URL instance to fetch in JavaScript instead 😬

Fail

const url = new URL(location.origin);

console.log(url.toString())
console.log(String(url))

Pass

const url = new URL(location.origin);

console.log(url.href)

Contributor guide

Research direction
Examine existing rules in eslint plugin unicorn for similar patterns, then implement a new rule that suggests using URL.href over toString() or String().
Tech stack
javascript
Domain
tooling
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.
1-3 hours
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
ESLintJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75