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 a slug with a lot of options; create of so called 'static' or 'Clean URL' or 'Pretty URL' or 'nice-looking URL' or 'Speaking URL' or 'user-friendly URL' or 'SEO-friendly URL' from a string. This module aims to transliterate the input string.

For use in browser and server - no dependencies!

Installation

npm

npm install speakingurl --save

Bower

bower install --save speakingurl

Component

component install pid/speakingurl

jamjs

jam install speakingurl

Download Package

copy the file speakingurl.min.js to your script directory

CDN/cloudflare

• available versions: http://cdnjs.com/libraries/speakingurl/
• use //cdnjs.cloudflare.com/ajax/libs/speakingurl/0.12.1/speakingurl.min.js

CDN/maxcdn

• available versions: http://www.jsdelivr.com/#!speakingurl
• use //cdn.jsdelivr.net/speakingurl/0.12.1/speakingurl.min.js

Usage

getSlug(input, [options]);

input: {string} to convert

options {object|string} config object or separator string (see below)

• options {object}

  • separator {string} default: '-'
    • char that replace the whitespaces
  • lang {string} default: 'en'
    • language for symbol translation ('ar', 'cz', 'de', 'en', 'es', 'fr', 'nl', pt', 'ru', 'sk' and 'vn'; more coming soon, please help!)
    • false -> don't convert symbols
  • maintainCase {boolean} default: false
    • true -> maintain case chars
    • false -> convert all chars to lower case
  • titleCase {boolean|array} default: false
    • true -> convert input string to title-case
    • array -> exclude words
  • truncate {number} default: 0
    • 0 -> don't trim length
    • >= 1 -> trim to max length while not breaking any words
  • uric {boolean} default: false
    • true -> additionally allow chars: ";", "?", ":", "@", "&", "=", "+", "$", ",", "/"
    • false
  • uricNoSlash {boolean} default: false
    • true -> additionally allow chars: ";", "?", ":", "@", "&", "=", "+", "$", ","
  • mark {boolean} default: false
    • true -> additionally allow chars: "-", "_", ".", "!", "~", "*", "'", "(", ")"
  • custom {object} default: {}
    • custom map for translation, overwrites all i.e. { '&': '#', '*': ' star ' }

• options {string} separator

notes: default only Base64 chars are allowed (/A-Za-z0-9_-/), setting uric, uricNoSlash or/and mark to true will add the specified chars to the list of allowed characters. The separator-character is always allowed.

Node.js

var getSlug = require('speakingurl');

Browser

<script src="bower_components/speakingurl/speakingurl.min.js"></script>

Examples

var slug;

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !");
console.log(slug); // Output: schoener-titel-laesst-gruessen-bel-ete

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", '*');
console.log(slug); // Output: schoener*titel*laesst*gruessen*bel*ete

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
        separator: '_'
});
console.log(slug); // Output: schoener_titel_laesst_gruessen_bel_ete

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
        uric: true
});
console.log(slug); // Output: schoener-titel-laesst-gruessen?-bel-ete

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    uricNoSlash: true
});
console.log(slug); // Output: schoener-titel-laesst-gruessen?-bel-ete

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    mark: true
});
console.log(slug); // Output: schoener-titel-laesst-gruessen!-bel-ete-!

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    truncate: 20
});
console.log(slug); // Output: schoener-titel

slug = getSlug("Schöner Titel läßt grüßen!? Bel été !", {
    maintainCase: true
});
console.log(slug); // Output: Schoener-Titel-laesst-gruessen-Bel-ete

slug = getSlug("Äpfel & Birnen!", {
    lang: 'de'
});
console.log(slug); // Output: aepfel-und-birnen

slug = getSlug("Apple & Pear!", {
    lang: 'en' // lang: "en" is default, just to clarify
});
console.log(slug); // Output: apple-and-pear

slug = getSlug('Foo & Bar * Baz', {
    custom: {
        '&': ' doo '
    },
    uric:true
});
console.log(slug); // Output: foo-doo-bar-baz

slug = getSlug('Foo ♥ Bar');
console.log(slug); // Output: foo-love-bar

slug = getSlug('Foo & Bar | (Baz) * Doo', {
    custom: {
        '*': 'Boo'
    },
    mark:true
});
console.log(slug); // Output: foo-and-bar-or-(baz)-boo-doo

slug = getSlug('Foo and Bar or Baz', {
    custom: {
        'and': 'und',
        'or': ''
    }
});
console.log(slug); // Output: foo-und-bar-baz

slug = getSlug('NEXUS4 only $299');
console.log(slug); // Output: nexus-4-only-usd299

slug = getSlug('NEXUS4 only €299', {
    maintainCase: true
});
console.log(slug); // Output: NEXUS-4-only-EUR299

slug = getSlug('Don\'t drink and drive', {
    titleCase: true
});
console.log(slug); // Output: Don-t-Drink-And-Drive

slug = getSlug('Don\'t drink and drive', {
    titleCase: ['and']
});
console.log(slug); // Output: Don-t-Drink-and-Drive

slug = getSlug('Foo & Bar ♥ Foo < Bar', {
    lang: false
});
console.log(slug); // Output: foo-bar-foo-bar

createSlug([options])

options: {object|string} config object or separator string (see above)

Create your own specially configured function.

var options = {
    maintainCase: true,
    separator: '_'
};
var mySlug = require('speakingurl').createSlug(options);
// in browser:
// var mySlug = createSlug(options);

var slug = mySlug("Schöner Titel läßt grüßen!? Bel été !");
console.log(slug); // Output: Schoener_Titel_laesst_gruessen_Bel_ete

Create your own specially configured function with title-case feature.

var options = {
    titleCase: [
        "a","an","and","as","at","but",
        "by","en","for","if","in","nor",
        "of","on","or","per","the","to","vs"
    ]
};
var mySlug = require('speakingurl').createSlug(options);
// in browser:
// var mySlug = createSlug(options);

var slug = mySlug('welcome to the jungle');
console.log(slug); // Output: Welcome-to-the-Jungle

Changelog

see CHANGELOG.md

Tests

npm test

Contribution

# fork pid/speakingurl on Github
$ git clone [e-mail]:<YOUR_USER>/speakingurl.git
$ cd speakingurl
$ npm install
$ npm install -g grunt-cli
# add your stuff
# add tests
# add example for new feature
# add description/example to README.md
$ grunt
# if everything works fine, commit, push to your repository
# create pull request

$

References

• http://tools.ietf.org/html/rfc3986
• http://en.wikipedia.org/wiki/Transliteration

Credits

• @dypsilon
• @simov
• @henrikjoreteg

License

The BSD 3-Clause License (BSD3)

Copyright (c) 2013-2014 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.