speakingurl

What is speakingurl?

The 'speakingurl' npm package is used to generate slugs from strings. It is particularly useful for creating URL-friendly strings from titles or other text inputs. The package supports multiple languages and offers various customization options.

What are speakingurl's main functionalities?

Basic Slug Generation

This feature allows you to convert a string into a URL-friendly slug. Special characters are removed, and spaces are replaced with hyphens.

const getSlug = require('speakingurl');
const slug = getSlug('Hello World!');
console.log(slug); // Output: 'hello-world'

Custom Separator

You can customize the separator used in the slug. In this example, an underscore is used instead of the default hyphen.

const getSlug = require('speakingurl');
const slug = getSlug('Hello World!', { separator: '_' });
console.log(slug); // Output: 'hello_world'

Language Support

The package supports multiple languages, allowing you to generate slugs that are appropriate for different linguistic contexts.

const getSlug = require('speakingurl');
const slug = getSlug('你好，世界', { lang: 'zh' });
console.log(slug); // Output: 'ni-hao-shi-jie'

Custom Transliteration

You can define custom transliterations for specific characters, giving you more control over the slug generation process.

const getSlug = require('speakingurl');
const slug = getSlug('Hello World!', { custom: { 'H': 'h', 'W': 'w' } });
console.log(slug); // Output: 'hello-world'

Other packages similar to speakingurl

slugify

'slugify' is another popular package for generating URL-friendly slugs. It offers similar functionality to 'speakingurl' but is often considered simpler and more lightweight. It also supports custom replacements and different character sets.

limax

'limax' is a slug generator that focuses on Unicode support and transliteration. It is highly configurable and supports a wide range of languages, making it a strong alternative to 'speakingurl' for internationalization needs.

url-slug

'url-slug' is a package designed to create slugs from strings with a focus on simplicity and ease of use. It provides basic slug generation features and is a good choice for straightforward use cases.

README

Speaking URL

Generate of so called "static" or "nice-looking" or "SpeakingURL" or "slug" from a string.

Works in browser and on node-server

Notes

In v0.1.x converting symbols is disabled, should be added in v0.2.x (see Issues) This is an early version, please check for your needs and give feedback to improve it.

Installation

$ npm install speakingurl

Usage

makeSlug(input, [options]);

input: string to convert options: config object (see below)

• separator default: '-'
  • char that replace the whitespaces
• maintainCase default: false
  • true => maintain case chars
  • false => convert all chars to lower case
• rfc3986 default: false
  • true => allow chars allowed by ~RFC3986 for url path
  • false => only Base64 chars allowed(/A-Za-z0-9-_/)
• smartTrim default: 0
  • 0 == don't trim length

  • 0 == trim to max length while not breaking any words

notes: if you set onlyBase64 and rfc3986 to true, onlyBase64 is prioritized

Examples

var makeSlug = require('speakingurl'),
    slug;

slug = makeSlug("Das ist ein schöner Titel, der keine Wünsche offen läßt !  ");
console.log(slug);
// Output: "das-ist-ein-schoener-titel-der-keine-wuensche-offen-laesst"

slug = makeSlug("Première neige repéré!!");
console.log(slug);
// Output: "premiere-neige-repere"

// optionally use a different separator character
slug = makeSlug("Would you like another character?", {separator: '_'} );
console.log(slug);
// Output: "want_another_separator"

// optionally maintain case
slug = makeSlug("Do not convert UPPERCASE chars", {maintainCase: true});
console.log(slug);
// Output: "Do-not-convert-UPPERCASE-chars"

// optionally trim to max length while not breaking any words
slug = makeSlug("Trim sentence ... to fit in length", {smartTrim: 16});
console.log(slug);
// Output: "trim-sentence-to"

// optionally allow RFC3986 conform url path, default base64 /A-Za-z0-9_-/
slug = makeSlug("Allow *RFC396* characters like 'that'?", {rfc3986: true} );
console.log(slug);
// Output: "allow-*rfc396*-characters-like-'that'"

Running tests

$ npm test

Credits

• @simov https://github.com/simov/slugify
• @henrikjoreteg https://github.com/henrikjoreteg/slugger
• @Aaronontheweb https://github.com/Aaronontheweb/node-slugs

License

BSD

The BSD 3-Clause License (BSD3)

Copyright (c) 2013 Sascha Droste [e-mail] All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.