simov / simov/slugify

Ability to create custom instances

Open
#33 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
1.7k
Forks
142
PR merge metrics
No merged PRs in 30d

Description

It would be nice to be able to create individual instances of slugify like the following:

import slugify from 'slugify'

const urlify = slugify.create({ /* options */ })

This would be useful in larger projects where there may be slightly different use cases that are used often. This would be more preferable than remembering the regex each time, or writing a custom wrapper.

Cheers

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the package's exported slugify entry point and inspect how options and regex are currently handled. The issue does not name files or tests; done means supporting the shown slugify.create({ /* options */ }) API so the returned instance can be reused with its own configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.