sindresorhus/humanize-url

Also do truncation

Open

#1 opened on Sep 10, 2015

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (252 stars) (7 forks)user submission
enhancementhelp wanted

Description

t'would be nice if this also did truncation -- pass another argument with something like {truncate: 40}, and the url would be nicely truncated, with '…' === '\u2026' replacing the truncated text.

Ex.

humanize('http://example.com/a/cool/page/that-is-really-deeply/nested/', {truncate: 20}') -> 'example.com/…/nested'

humanize('http://example.com/a/cool/page/that-is-really-deeply/nested/', {truncate: 24}') -> 'example.com/a/…/nested'

humanize('http://example.com/a/cool/page/that-is-really-deeply/nested/', {truncate: 30}') -> 'example.com/a/cool/…/nested'

Or this could also be a separate module. module-requests ahoy?

Contributor guide

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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptUnderstanding of URL structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests an optional `truncate` parameter to truncate humanized URLs with an ellipsis. Review the existing `humanize url` function in `index.js` (likely) to understand current URL parsing and formatting. Then implement logic to truncate the path/pathname while preserving the domain, as shown in the examples. The main API change is adding an options object with a `truncate` number. Consider edge cases like URLs with query strings or hashes. Check the existing comments for any maintainer feedback on desired API.